Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
TypeScript agentic-aiagentsaiai-agentsaiagentsdeveloper-toolsfunction-callinggpt-4javascriptjsllmllmopsmcppythonremote-mcp-serverssetypescript
fix custom auth stuff
Sushmithamalleshf1c80ecb95b3
diff --git a/fern/docs.yml b/fern/docs.ymlindex 9faada7dc..8e6623d2b 100644--- a/fern/docs.yml+++ b/fern/docs.yml@@ -305,12 +305,9 @@ navigation:icon: fa-light fa-bookskip-slug: truecontents:- - page: Creating Sessions+ - page: Session Configurationpath: pages/dist/tool-router/creating-sessions.mdxslug: creating-sessions- - page: Configuring Toolkits- path: pages/dist/tool-router/configuring-toolkits.mdx- slug: configuring-toolkits- page: Using In-chat Authenticationpath: pages/dist/tool-router/using-in-chat-authentication.mdxslug: using-in-chat-authentication@@ -320,6 +317,9 @@ navigation:- page: White-labeling Authenticationpath: pages/dist/tool-router/white-labeling-authentication.mdxslug: white-labeling-authentication+ - page: Configuring Custom Auth Configs+ path: pages/dist/tool-router/configuring-custom-auth-configs.mdx+ slug: configuring-custom-auth-configs- page: Configuring Workbenchpath: pages/dist/tool-router/configuring-workbench.mdxslug: configuring-workbenchdiff --git a/fern/pages/src/tool-router/authentication.mdx b/fern/pages/src/tool-router/authentication.mdxindex edfef6aa2..744183acf 100644--- a/fern/pages/src/tool-router/authentication.mdx+++ b/fern/pages/src/tool-router/authentication.mdx@@ -45,7 +45,7 @@ Tool Router can automatically create auth configs for:- **API key auth** - Users provide their own API keys via Connect Link.<Note>-Toolkits without Composio managed auth require you to [create an auth config](/docs/authenticating-tools#creating-an-auth-config) first and pass it via `authConfigs`.+Toolkits without Composio managed auth require you to create an auth config first. See [Configuring custom auth configs](/docs/tool-router/configuring-custom-auth-configs).</Note>## White-labelingdiff --git a/fern/pages/src/tool-router/configuring-custom-auth-configs.mdx b/fern/pages/src/tool-router/configuring-custom-auth-configs.mdxnew file mode 100644index 000000000..1635d9ffc--- /dev/null+++ b/fern/pages/src/tool-router/configuring-custom-auth-configs.mdx@@ -0,0 +1,53 @@+---+title: Configuring custom auth configs+image: "https://og.composio.dev/api/og?title=Configuring%20Custom%20Auth%20Configs"+description: "Set up auth configs for toolkits without Composio managed authentication"+keywords: "tool router, auth config, custom credentials, oauth"+---++Some toolkits don't have Composio managed authentication and require you to provide your own credentials. When Tool Router tries to use these toolkits, it will throw an error asking you to create an auth config.++<Steps>+<Step title="Check if a toolkit needs custom credentials">+In the [Composio platform](https://platform.composio.dev), go to "All Toolkits" and select the toolkit. If it shows no Composio managed auth schemes, you'll need to create an auth config.+</Step>++<Step title="Create an auth config">+1. Go to **Authentication management** in the [dashboard](https://app.composio.dev)+2. Click **Create Auth Config**+3. Select the toolkit+4. Choose the auth scheme (OAuth2, API Key, etc.)+5. Enter your credentials (client ID, client secret, API key, etc.)+6. Click **Create**++Copy the auth config ID (e.g., `ac_1234abcd`).++<Tip>+For detailed instructions on getting credentials for specific toolkits, see [Custom auth configs](/docs/authentication/custom-auth-configs).+</Tip>+</Step>++<Step title="Use in Tool Router">+Pass your auth config ID when creating a session:++<CodeGroup>+```python+session = composio.create(+ user_id="pg-user-550e8400-e29b-41d4",+ auth_configs={+ "posthog": "ac_your_posthog_config"+ }+)+```+```typescript+const session = await composio.create("pg-user-550e8400-e29b-41d4", {+ authConfigs: {+ posthog: "ac_your_posthog_config",+ },+});+```+</CodeGroup>++Tool Router will now use your auth config when users connect to this toolkit.+</Step>+</Steps>diff --git a/fern/pages/src/tool-router/configuring-toolkits.mdx b/fern/pages/src/tool-router/configuring-toolkits.mdxdeleted file mode 100644index 07f58bb08..000000000--- a/fern/pages/src/tool-router/configuring-toolkits.mdx+++ /dev/null@@ -1,7 +0,0 @@-----title: Configuring Toolkits-image: "https://og.composio.dev/api/og?title=Configuring%20Toolkits"-description: "Configure which toolkits are available in a session"-keywords: "tool router"-----diff --git a/fern/pages/src/tool-router/creating-sessions.mdx b/fern/pages/src/tool-router/creating-sessions.mdxindex 81cb6a0a7..fc69cc854 100644--- a/fern/pages/src/tool-router/creating-sessions.mdx+++ b/fern/pages/src/tool-router/creating-sessions.mdx@@ -1,26 +1,24 @@----title: Creating sessions-image: "https://og.composio.dev/api/og?title=Creating%20Sessions"+title: Session configuration+image: "https://og.composio.dev/api/og?title=Session%20Configuration"description: "Configure toolkits, authentication, and connections for a session"-keywords: "sessions, create session, tool router, configuration"+keywords: "sessions, create session, tool router, configuration, configuring toolkits"hide-nav-links: false----Create a session to configure what tools are available and how authentication works for a user.+Sessions are ephemeral, user-scoped containers that manage which tools are available and how authentication works.-## Basic session--Create a session with all available toolkits:+## Creating a session<CodeGroup>-```python Python+```pythonfrom composio import Composiocomposio = Composio(api_key="your-api-key")session = composio.create(user_id="pg-user-550e8400-e29b-41d4")```-```typescript TypeScript+```typescriptimport { Composio } from "@composio/core";const composio = new Composio({ apiKey: "your-api-key" });@@ -28,54 +26,52 @@ const session = await composio.create("pg-user-550e8400-e29b-41d4");```</CodeGroup>-## Configuration options+By default, all toolkits are available and in-chat authentication is enabled.-### toolkits+## Toolkit access-Restrict which toolkits are available in the session.--**Enable specific toolkits:**+### Allow specific toolkits<CodeGroup>-```python Python+```pythonsession = composio.create(user_id="pg-user-550e8400-e29b-41d4",toolkits=["github", "gmail", "slack"])```-```typescript TypeScript+```typescriptconst session = await composio.create("pg-user-550e8400-e29b-41d4", {toolkits: ["github", "gmail", "slack"],});```</CodeGroup>-**Disable specific toolkits:**+### Disable specific toolkits<CodeGroup>-```python Python+```pythonsession = composio.create(user_id="pg-user-550e8400-e29b-41d4",toolkits={"disable": ["exa", "firecrawl"]})```-```typescript TypeScript+```typescriptconst session = await composio.create("pg-user-550e8400-e29b-41d4", {toolkits: { disable: ["exa", "firecrawl"] },});```</CodeGroup>-### authConfigs+## Authentication++### Custom OAuth apps-Override which auth configs to use for specific toolkits. Use this to:-- Use your own OAuth credentials ([white-labeling](/tool-router/white-labeling-authentication))-- Control which auth config Tool Router uses instead of auto-creating one+Use your own OAuth credentials instead of Composio's defaults. See [White-labeling authentication](/tool-router/white-labeling-authentication) for branding, or [Configuring custom auth configs](/tool-router/configuring-custom-auth-configs) for toolkits that require your own credentials.<CodeGroup>-```python Python+```pythonsession = composio.create(user_id="pg-user-550e8400-e29b-41d4",auth_configs={@@ -85,7 +81,7 @@ session = composio.create()```-```typescript TypeScript+```typescriptconst session = await composio.create("pg-user-550e8400-e29b-41d4", {authConfigs: {github: "ac_your_github_config",@@ -95,16 +91,12 @@ const session = await composio.create("pg-user-550e8400-e29b-41d4", {```</CodeGroup>-When an auth config override is provided, Tool Router uses it to find or create a connected account for the user on that config.--### connectedAccounts+### Account selection-Specify which connected account to use for a toolkit. Use this when:-- A user has multiple accounts for the same toolkit (e.g., personal and work Gmail)-- You need deterministic account selection instead of "most recent"+Specify which connected account to use when a user has multiple accounts for the same toolkit.<CodeGroup>-```python Python+```pythonsession = composio.create(user_id="pg-user-550e8400-e29b-41d4",connected_accounts={@@ -114,7 +106,7 @@ session = composio.create()```-```typescript TypeScript+```typescriptconst session = await composio.create("pg-user-550e8400-e29b-41d4", {connectedAccounts: {gmail: "ca_work_gmail",@@ -124,27 +116,21 @@ const session = await composio.create("pg-user-550e8400-e29b-41d4", {```</CodeGroup>-This takes highest precedence when selecting which account to use for tool execution. See [connected account precedence](/tool-router/users-and-sessions#connected-account-precedence).--### manageConnections+### In-chat prompts-Controls whether the `COMPOSIO_MANAGE_CONNECTIONS` meta-tool is included in the session. This tool allows the agent to prompt users to connect accounts during chat.--- `true` (default) - Agent can prompt users to connect accounts via auth links-- `false` - Tool not included. Use `session.authorize()` for manual auth-- `{ callbackUrl: "..." }` - Agent can prompt users, redirects to your URL after OAuth+Control whether the agent can prompt users to connect accounts during chat.**Disable in-chat authentication:**<CodeGroup>-```python Python+```pythonsession = composio.create(user_id="pg-user-550e8400-e29b-41d4",manage_connections=False)```-```typescript TypeScript+```typescriptconst session = await composio.create("pg-user-550e8400-e29b-41d4", {manageConnections: false,});@@ -154,14 +140,14 @@ const session = await composio.create("pg-user-550e8400-e29b-41d4", {**Custom callback URL:**<CodeGroup>-```python Python+```pythonsession = composio.create(user_id="pg-user-550e8400-e29b-41d4",manage_connections={"callback_url": "https://myapp.com/callback"})```-```typescript TypeScript+```typescriptconst session = await composio.create("pg-user-550e8400-e29b-41d4", {manageConnections: { callbackUrl: "https://myapp.com/callback" },});@@ -170,61 +156,14 @@ const session = await composio.create("pg-user-550e8400-e29b-41d4", {For more details, see [Using in-chat authentication](/tool-router/using-in-chat-authentication) and [Manually authenticating users](/tool-router/manually-authenticating-users).-## Full example--<CodeGroup>-```python Python-from composio import Composio-from composio_openai_agents import OpenAIAgentsProvider--composio = Composio(- api_key="your-api-key",- provider=OpenAIAgentsProvider()-)--session = composio.create(- user_id="pg-user-550e8400-e29b-41d4",- toolkits=["github", "gmail", "slack"],- auth_configs={- "github": "ac_your_github_config"- },- connected_accounts={- "gmail": "ca_work_gmail"- },- manage_connections={"callback_url": "https://myapp.com/callback"}-)-```--```typescript TypeScript-import { Composio } from "@composio/core";-import { OpenAIAgentsProvider } from "@composio/openai-agents";--const composio = new Composio({- apiKey: "your-api-key",- provider: new OpenAIAgentsProvider(),-});--const session = await composio.create("pg-user-550e8400-e29b-41d4", {- toolkits: ["github", "gmail", "slack"],- authConfigs: {- github: "ac_your_github_config",- },- connectedAccounts: {- gmail: "ca_work_gmail",- },- manageConnections: { callbackUrl: "https://myapp.com/callback" },-});-```-</CodeGroup>--## Session properties+## Session methods### tools()Get meta-tools to pass to your agent framework.<CodeGroup>-```python Python+```pythontools = session.tools()agent = Agent(@@ -234,7 +173,7 @@ agent = Agent()```-```typescript TypeScript+```typescriptconst tools = await session.tools();const agent = new Agent({@@ -252,41 +191,24 @@ For framework-specific examples, see [Using as native tools](/tool-router/using-Get the MCP server URL to use with any MCP-compatible client.<CodeGroup>-```python Python+```pythonmcp_url = session.mcp.url```-```typescript TypeScript+```typescriptconst { mcp } = session;console.log(mcp.url);```</CodeGroup>-Example with OpenAI Agents SDK:--```typescript-import { Agent } from "@openai/agents";--const agent = new Agent({- name: "Assistant",- instructions: "You are a helpful assistant.",- tools: [- hostedMcpTool({- serverLabel: "composio",- serverUrl: mcp.url,- }),- ],-});-```--For more frameworks, see [Using with MCP clients](/tool-router/using-with-mcp-clients).+For framework examples, see [Using with MCP clients](/tool-router/using-with-mcp-clients).### authorize()-[Manually authenticate](/tool-router/manually-authenticating-users) a user to a toolkit outside of the chat flow.+Manually authenticate a user to a toolkit outside of the chat flow.<CodeGroup>-```python Python+```pythonconnection_request = session.authorize("github",callback_url="https://myapp.com/callback"@@ -297,7 +219,7 @@ print(connection_request.redirect_url)connected_account = connection_request.wait_for_connection()```-```typescript TypeScript+```typescriptconst connectionRequest = await session.authorize("github", {callbackUrl: "https://myapp.com/callback",});@@ -308,22 +230,25 @@ const connectedAccount = await connectionRequest.waitForConnection();```</CodeGroup>+For more details, see [Manually authenticating users](/tool-router/manually-authenticating-users).+### toolkits()-List available toolkits and their connection status for the session. Use this to build a UI showing which apps are connected.+List available toolkits and their connection status. Use this to build a UI showing which apps are connected.<CodeGroup>-```python Python+```pythontoolkits = session.toolkits(order_by="popularity",is_connected=True)for toolkit in toolkits:- print(f"{toolkit.name}: {toolkit.connected_account.id if toolkit.connected_account else 'Not connected'}")+ status = toolkit.connected_account.id if toolkit.connected_account else "Not connected"+ print(f"{toolkit.name}: {status}")```-```typescript TypeScript+```typescriptconst toolkits = await session.toolkits({orderBy: "popularity",isConnected: true,@@ -339,4 +264,3 @@ toolkits.forEach((toolkit) => {- `orderBy`: `"popularity"`, `"name"`, or `"connected_at"`- `isConnected`: `true` to show only connected toolkits- `category`: Filter by category (e.g., `"productivity"`, `"communication"`)-diff --git a/fern/pages/src/tool-router/quickstart.mdx b/fern/pages/src/tool-router/quickstart.mdxindex f8b5db3ea..aef9fb899 100644--- a/fern/pages/src/tool-router/quickstart.mdx+++ b/fern/pages/src/tool-router/quickstart.mdx@@ -122,7 +122,7 @@ To use OpenAI Agents SDK with Tool Router MCP instead, see [Using with MCP Clien<Steps><Step title="Install Composio SDK">```bash-pip install composio anthropic-agents composio-anthropic+pip install composio anthropic-agents```</Step>@@ -135,12 +135,8 @@ Sessions are ephemeral, user-scoped and manage connections and tools for that us</Info>```pythonfrom composio import Composio-from composio_anthropic import AnthropicProvider-composio = Composio(- api_key="your-api-key",- provider=AnthropicProvider()-)+composio = Composio(api_key="your-api-key")# Create a session for a usersession = composio.create(user_id="pg-user-550e8400-e29b-41d4")@@ -176,7 +172,7 @@ To use Anthropic Agents SDK with Tool Router as native tools instead, see [Using<Steps><Step title="Install Composio SDK">```bash-npm install @composio/core @composio/anthropic @anthropic-ai/agent+npm install @composio/core @anthropic-ai/agent```</Step>@@ -189,12 +185,8 @@ Sessions are ephemeral, user-scoped and manage connections and tools for that us</Info>```typescriptimport { Composio } from "@composio/core";-import { AnthropicProvider } from "@composio/anthropic";-const composio = new Composio({- apiKey: "your-api-key",- provider: new AnthropicProvider(),-});+const composio = new Composio({ apiKey: "your-api-key" });// Create a session for a userconst { mcp } = await composio.create("pg-user-550e8400-e29b-41d4");diff --git a/fern/pages/src/tool-router/tools-and-toolkits.mdx b/fern/pages/src/tool-router/tools-and-toolkits.mdxindex 6b2eaf915..a38d4e48a 100644--- a/fern/pages/src/tool-router/tools-and-toolkits.mdx+++ b/fern/pages/src/tool-router/tools-and-toolkits.mdx@@ -1,7 +1,46 @@----title: Tools and Toolkits+title: Tools and toolkitsimage: "https://og.composio.dev/api/og?title=Tools%20and%20Toolkits"-description: "Managing tools and toolkits in Tool Router"-keywords: "tool router"+description: "Access 800+ integrations through Tool Router"+keywords: "tool router, tools, toolkits, integrations, composio"---+Tool Router gives your agent access to most Composio toolkits by default. For details on configuring which toolkits and tools are available in a session, see [Session configuration](/tool-router/creating-sessions).++## Toolkits and tools++A **toolkit** is a collection of related tools for a service and a **tool** is an individual action your agent can execute.+For example, the `github` toolkit contains tools like `GITHUB_CREATE_A_COMMIT`, `GITHUB_ACTIVITY_LIST_STARGAZERS_FOR_REPO`, and `GITHUB_SEARCH_REPO_S`.++## Available toolkits++Browse all available toolkits in the [Composio platform](https://platform.composio.dev) under "All Toolkits". Each toolkit page shows its tools (with input and output parameters) and authentication methods supported for that toolkit.++<Note>+Some toolkits require you to provide your own credentials. See [Configuring custom auth configs](/tool-router/configuring-custom-auth-configs).+</Note>++<Tip>+Need a toolkit that doesn't exist? [Request it here](https://request.composio.dev/boards/tool-requests).+</Tip>++For details on browsing tools within toolkits and inspecting schemas, see [Fetching tools and schemas](/docs/fetching-tools).++## Default behavior++When you create a session, all toolkits are available:++<CodeGroup>+```python+session = composio.create(user_id="pg-user-550e8400-e29b-41d4")+```+```typescript+const session = await composio.create("pg-user-550e8400-e29b-41d4");+```+</CodeGroup>++Your agent can search and use tools from any toolkit. To restrict or configure which toolkits are available, see [Session configuration](/docs/tool-router/creating-sessions).++<Tip>+Triggers can be used alongside Tool Router to respond to events in connected apps. See [Using triggers](/docs/tools-and-triggers/using-triggers) for setup instructions.+</Tip>