Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Add tool router preload examples

Dhawal Upadhyay3d2093fffb85
diff --git a/ts/examples/tool-router/.env.example b/ts/examples/tool-router/.env.example
index 0e728257c..8f647ad57 100644
--- a/ts/examples/tool-router/.env.example
+++ b/ts/examples/tool-router/.env.example
@@ -1,6 +1,11 @@
# Composio API Key - Get it from https://app.composio.dev
COMPOSIO_API_KEY=your_composio_api_key_here
+# OpenAI API Key - Required for OpenAI Agents examples
+OPENAI_API_KEY=your_openai_api_key_here
+
+# Optional: override the model used by OpenAI Agents examples
+# OPENAI_MODEL=gpt-5.1
+
# Add other environment variables as needed for your example
-# OPENAI_API_KEY=your_openai_api_key_here
# ANTHROPIC_API_KEY=your_anthropic_api_key_here
diff --git a/ts/examples/tool-router/README.md b/ts/examples/tool-router/README.md
index 2aba7d66c..3003c3740 100644
--- a/ts/examples/tool-router/README.md
+++ b/ts/examples/tool-router/README.md
@@ -5,17 +5,21 @@ This example demonstrates how to use Composio SDK for tool-router.
## Setup
1. **Install dependencies:**
+
```bash
pnpm install
```
2. **Configure environment:**
+
```bash
cp .env.example .env
```
-
+
Then edit `.env` and add your API keys:
- `COMPOSIO_API_KEY`: Get it from [Composio Dashboard](https://app.composio.dev)
+ - `OPENAI_API_KEY`: Required for OpenAI Agents examples
+ - `OPENAI_MODEL`: Optional model override for OpenAI Agents examples
## Running the Example
@@ -25,6 +29,12 @@ pnpm start
# Run in development mode (with file watching)
pnpm dev
+
+# Explicit preload for app tools and SDK custom tools
+pnpm preload
+
+# Direct-tools preset for sessions where all tools are known upfront
+pnpm direct-tools
```
## What This Example Does
@@ -32,10 +42,13 @@ pnpm dev
- Initializes Composio SDK
- Fetches available tools
- Demonstrates basic usage patterns
+- Shows how to preload selected app tools and SDK-local custom tools into `session.tools()`
+- Shows `sessionPreset: "direct_tools"` for loading all tools allowed by session filters without meta/helper tools
## Customization
Edit `src/index.ts` to:
+
- Add specific apps you want to integrate with
- Implement your business logic
- Add error handling and logging
diff --git a/ts/examples/tool-router/package.json b/ts/examples/tool-router/package.json
index 4edf62ac1..63d063c9e 100644
--- a/ts/examples/tool-router/package.json
+++ b/ts/examples/tool-router/package.json
@@ -7,6 +7,8 @@
"scripts": {
"start": "bun src/index.ts",
"dev": "bun --watch src/index.ts",
+ "preload": "bun src/preload.ts",
+ "direct-tools": "bun src/direct-tools-preset.ts",
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [
diff --git a/ts/examples/tool-router/src/direct-tools-preset.ts b/ts/examples/tool-router/src/direct-tools-preset.ts
new file mode 100644
index 000000000..81af694f6
--- /dev/null
+++ b/ts/examples/tool-router/src/direct-tools-preset.ts
@@ -0,0 +1,64 @@
+/**
+ * Tool Router direct_tools session preset with OpenAI Agents
+ *
+ * `sessionPreset: "direct_tools"` is a shortcut for sessions where the full
+ * allowed tool set is known upfront. It disables Tool Router meta/helper tools
+ * by default and loads all tools allowed by the filters directly into
+ * `session.tools()` and the MCP tool list.
+ *
+ * Usage:
+ * COMPOSIO_API_KEY=... OPENAI_API_KEY=... bun src/direct-tools-preset.ts
+ */
+import 'dotenv/config';
+import { Composio } from '@composio/core';
+import { OpenAIAgentsProvider } from '@composio/openai-agents';
+import { Agent, run } from '@openai/agents';
+
+function requireEnv(name: 'COMPOSIO_API_KEY' | 'OPENAI_API_KEY'): string {
+ const value = process.env[name];
+ if (!value) {
+ throw new Error(`Set ${name} before running this example.`);
+ }
+ return value;
+}
+
+const composioApiKey = requireEnv('COMPOSIO_API_KEY');
+requireEnv('OPENAI_API_KEY');
+
+const composio = new Composio({
+ apiKey: composioApiKey,
+ baseURL: process.env.COMPOSIO_BASE_URL || undefined,
+ provider: new OpenAIAgentsProvider(),
+});
+
+const session = await composio.create(`direct-tools-example-${Date.now()}`, {
+ sessionPreset: 'direct_tools',
+ toolkits: ['hackernews'],
+ tools: {
+ hackernews: {
+ enable: ['HACKERNEWS_GET_USER'],
+ },
+ },
+});
+
+const tools = await session.tools();
+console.log('Direct tools exposed to the agent:');
+for (const tool of tools) {
+ console.log(`- ${tool.name}`);
+}
+
+const agent = new Agent({
+ name: 'Direct Tools Demo Agent',
+ instructions:
+ 'Use the provided direct tools. The session is configured without Tool Router meta/helper tools.',
+ model: process.env.OPENAI_MODEL ?? 'gpt-5.1',
+ tools,
+});
+
+const prompt =
+ process.argv.slice(2).join(' ') ||
+ 'Use the Hacker News tool to look up user "pg" and report their karma.';
+
+console.log(`\nUser: ${prompt}\n`);
+const result = await run(agent, prompt);
+console.log(`Assistant: ${result.finalOutput}`);
diff --git a/ts/examples/tool-router/src/preload.ts b/ts/examples/tool-router/src/preload.ts
new file mode 100644
index 000000000..51ead2d55
--- /dev/null
+++ b/ts/examples/tool-router/src/preload.ts
@@ -0,0 +1,137 @@
+/**
+ * Tool Router preload with OpenAI Agents
+ *
+ * Shows direct tool exposure for:
+ * 1. Composio tools via `preload.tools`
+ * 2. SDK custom tools via `preload: true` on the custom tool or toolkit
+ *
+ * Usage:
+ * COMPOSIO_API_KEY=... OPENAI_API_KEY=... bun src/preload.ts
+ */
+import 'dotenv/config';
+import { Composio, experimental_createTool, experimental_createToolkit } from '@composio/core';
+import { OpenAIAgentsProvider } from '@composio/openai-agents';
+import { Agent, run } from '@openai/agents';
+import { z } from 'zod/v3';
+
+function requireEnv(name: 'COMPOSIO_API_KEY' | 'OPENAI_API_KEY'): string {
+ const value = process.env[name];
+ if (!value) {
+ throw new Error(`Set ${name} before running this example.`);
+ }
+ return value;
+}
+
+const composioApiKey = requireEnv('COMPOSIO_API_KEY');
+requireEnv('OPENAI_API_KEY');
+
+const internalUsers: Record<string, Record<string, unknown>> = {
+ 'user-1': {
+ id: 'user-1',
+ name: 'Ada Lovelace',
+ email: '[email protected]',
+ team: 'platform',
+ plan: 'enterprise',
+ },
+ 'user-2': {
+ id: 'user-2',
+ name: 'Grace Hopper',
+ email: '[email protected]',
+ team: 'developer-tools',
+ plan: 'startup',
+ },
+};
+
+const lookupInternalUser = experimental_createTool('LOOKUP_INTERNAL_USER', {
+ name: 'Lookup internal user',
+ description: 'Look up an internal demo user profile by user ID.',
+ preload: true,
+ inputParams: z.object({
+ user_id: z.string().describe('Internal user ID, for example user-1'),
+ }),
+ execute: async ({ user_id }) => {
+ const user = internalUsers[user_id];
+ if (!user) {
+ throw new Error(`User "${user_id}" not found`);
+ }
+ return user;
+ },
+});
+
+const searchInternalUsers = experimental_createTool('SEARCH_INTERNAL_USERS', {
+ name: 'Search internal users',
+ description:
+ 'Search demo internal users by team. This custom tool is search-only because preload is not enabled.',
+ inputParams: z.object({
+ team: z.string().describe('Team name to search for'),
+ }),
+ execute: async ({ team }) => ({
+ results: Object.values(internalUsers).filter(user => user.team === team),
+ }),
+});
+
+const getAccountHealth = experimental_createTool('GET_ACCOUNT_HEALTH', {
+ name: 'Get account health',
+ description: 'Return internal account health details for a user.',
+ inputParams: z.object({
+ user_id: z.string().describe('Internal user ID'),
+ }),
+ execute: async ({ user_id }) => ({
+ user_id,
+ health: 'green',
+ open_incidents: 0,
+ renewal_risk: 'low',
+ }),
+});
+
+const internalAdmin = experimental_createToolkit('INTERNAL_ADMIN', {
+ name: 'Internal admin',
+ description: 'Demo internal administration tools.',
+ preload: true,
+ tools: [getAccountHealth],
+});
+
+const composio = new Composio({
+ apiKey: composioApiKey,
+ baseURL: process.env.COMPOSIO_BASE_URL || undefined,
+ provider: new OpenAIAgentsProvider(),
+});
+
+const session = await composio.create(`preload-example-${Date.now()}`, {
+ toolkits: ['hackernews'],
+ tools: {
+ hackernews: {
+ enable: ['HACKERNEWS_GET_USER'],
+ },
+ },
+ preload: {
+ tools: ['HACKERNEWS_GET_USER'],
+ },
+ manageConnections: false,
+ experimental: {
+ customTools: [lookupInternalUser, searchInternalUsers],
+ customToolkits: [internalAdmin],
+ },
+});
+
+const tools = await session.tools();
+console.log('Direct tools exposed to the agent:');
+for (const tool of tools) {
+ console.log(`- ${tool.name}`);
+}
+
+const agent = new Agent({
+ name: 'Preload Demo Agent',
+ instructions:
+ 'Use the provided direct tools. Do not search for tools first; the needed tools are already loaded.',
+ model: process.env.OPENAI_MODEL ?? 'gpt-5.1',
+ tools,
+});
+
+const prompt =
+ process.argv.slice(2).join(' ') ||
+ 'Look up Hacker News user "pg", then look up internal user user-1 and their account health. Summarize the useful facts.';
+
+console.log(`\nUser: ${prompt}\n`);
+const result = await run(agent, prompt);
+console.log(`Assistant: ${result.finalOutput}`);