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
docs: categorize FAQs into logical sections for easier navigation
Devin AI5b4e5f5e6bdc
diff --git a/docs/content/docs/common-faq.mdx b/docs/content/docs/common-faq.mdxindex d9bb43964..ece471e5a 100644--- a/docs/content/docs/common-faq.mdx+++ b/docs/content/docs/common-faq.mdx@@ -4,38 +4,50 @@ description: Frequently asked questions about Composiokeywords: [faq, questions, help, common questions]---+## General+<Accordions>-<Accordion title="Can I white label Composio's auth screens?">-Yes. By default, OAuth consent screens show "Composio" as the app name. If you create an auth config with your own OAuth client ID and secret, users will see your app's name and logo instead.+<Accordion title="Do I need an AI agent to use Composio?">+No. If you're building an AI agent, Composio can give it [meta tools](/docs/quickstart) that handle tool discovery and execution automatically, or you can [fetch specific tools](/docs/tools-direct/fetching-tools) and pass them to your agent directly.-You can also proxy the OAuth redirect through your own domain so users never see `backend.composio.dev` in the URL bar. See [White-labeling authentication](/docs/white-labeling-authentication).+If you don't have an agent, you can [execute tools directly](/docs/tools-direct/executing-tools#direct-tool-execution) from any backend.</Accordion>-<Accordion title="Is white labeling available on the free plan?">-Yes. White labeling works on all plans, including free. You can create custom auth configs with your own OAuth credentials on any account. See [White-labeling authentication](/docs/white-labeling-authentication).-</Accordion>+<Accordion title="What is the difference between a tool and a toolkit?">+A **toolkit** is a collection of related tools grouped by app, for example the GitHub toolkit or the Gmail toolkit. A **tool** is a single action within a toolkit, like `GITHUB_CREATE_ISSUE` or `GMAIL_SEND_EMAIL`.-<Accordion title="How do I hide the Composio logo during authentication?">-Go to your [project settings](https://platform.composio.dev/settings) and upload your own logo and app title. This replaces Composio branding on the Connect Link page. To also remove "Composio" from OAuth consent screens (Google, GitHub, Slack, etc.), create a custom auth config with your own OAuth credentials. See [White-labeling authentication](/docs/white-labeling-authentication) for the full guide.+You connect to toolkits (via OAuth or API keys), and then execute individual tools within them. See [Tools and toolkits](/docs/tools-and-toolkits).</Accordion>-<Accordion title="I changed my branding but still see 'Secured by Composio'">-The Connect Link logo and app title customization does not remove the "Secured by Composio" badge. To remove it, you need to set up your own OAuth app by creating a [custom auth config](/docs/white-labeling-authentication#using-your-own-oauth-apps) with your own client ID and secret.+<Accordion title="What is User ID and how should I use it?">+The User ID is how Composio identifies your end users. It maps each user to their connected accounts and sessions. Use any unique identifier from your system, like an email, database ID, or UUID.++When you create a session with `composio.create(user_id="user_123")`, all connected accounts and tool executions are scoped to that user. See [Users and sessions](/docs/users-and-sessions).</Accordion>-<Accordion title="What is the difference between a tool and a toolkit?">-A **toolkit** is a collection of related tools grouped by app, for example the GitHub toolkit or the Gmail toolkit. A **tool** is a single action within a toolkit, like `GITHUB_CREATE_ISSUE` or `GMAIL_SEND_EMAIL`.+<Accordion title="What is the difference between an auth config and an MCP config in the dashboard?">+An **auth config** defines how users authenticate with a toolkit (OAuth credentials, scopes, API keys). You need one whenever you want users to connect to an app.-You connect to toolkits (via OAuth or API keys), and then execute individual tools within them. See [Tools and toolkits](/docs/tools-and-toolkits).-</Accordion>+An **MCP config** creates a hosted MCP server that exposes specific tools over the Model Context Protocol. It's only needed if you're connecting to Composio from an MCP client like Claude Desktop, Cursor, or OpenAI's Responses API via MCP.-<Accordion title="Do I need an AI agent to use Composio?">-No. If you're building an AI agent, Composio can give it [meta tools](/docs/quickstart) that handle tool discovery and execution automatically, or you can [fetch specific tools](/docs/tools-direct/fetching-tools) and pass them to your agent directly.+**If you're using the Composio SDK** (sessions or direct execution), you only need auth configs. The SDK handles tool delivery natively. You don't need to create an MCP config.-If you don't have an agent, you can [execute tools directly](/docs/tools-direct/executing-tools#direct-tool-execution) from any backend.+**If you're using an MCP client**, you need both: an auth config (so users can authenticate) and an MCP config (so the client can discover and call tools over the MCP protocol).++See [Native Tools vs MCP](/docs/native-tools-vs-mcp) for a full comparison.</Accordion>+<Accordion title="When should I create a new session?">+Create a new session when the config changes: different toolkits, different auth config, or a different connected account. You don't need to store or manage session IDs. Just call `create()` each time. See [Users and sessions](/docs/users-and-sessions).+</Accordion>++</Accordions>++## Tools & Toolkits++<Accordions>+<Accordion title="Where can I see all available toolkits?">You can browse all toolkits on the [Toolkits page](/toolkits) in the docs or in the [Composio dashboard](https://platform.composio.dev?next_page=/marketplace). Both list every supported app along with available auth schemes and tools.</Accordion>@@ -76,24 +88,37 @@ You can also list the toolkits available in a session with `session.toolkits()`.You can request new tools or toolkits on the [tool request board](https://request.composio.dev/boards/tool-requests). The team reviews requests regularly.</Accordion>-<Accordion title="What is User ID and how should I use it?">-The User ID is how Composio identifies your end users. It maps each user to their connected accounts and sessions. Use any unique identifier from your system, like an email, database ID, or UUID.+<Accordion title="How do I work with toolkit versions?">+Composio toolkits are versioned using date-based identifiers (e.g., `20251027_00`). You can pin versions at SDK initialization or per tool execution to keep behavior consistent across deployments.-When you create a session with `composio.create(user_id="user_123")`, all connected accounts and tool executions are scoped to that user. See [Users and sessions](/docs/users-and-sessions).+This applies to direct tool execution only. Sessions with meta tools always use the latest version. See [Toolkit versioning](/docs/tools-direct/toolkit-versioning).</Accordion>-<Accordion title="What is the difference between an auth config and an MCP config in the dashboard?">-An **auth config** defines how users authenticate with a toolkit (OAuth credentials, scopes, API keys). You need one whenever you want users to connect to an app.+<Accordion title="Why does the API return fewer tools than the platform UI?">+When calling the Get Tools API (`GET /api/v3/tools`) without specifying a `toolkit_versions` parameter, the API defaults to the base version (`00000000_00`), which only includes tools from the initial release. The platform UI shows tools from the latest version.-An **MCP config** creates a hosted MCP server that exposes specific tools over the Model Context Protocol. It's only needed if you're connecting to Composio from an MCP client like Claude Desktop, Cursor, or OpenAI's Responses API via MCP.+To get all available tools, pass `toolkit_versions=latest`:-**If you're using the Composio SDK** (sessions or direct execution), you only need auth configs. The SDK handles tool delivery natively. You don't need to create an MCP config.+```bash+curl 'https://backend.composio.dev/api/v3/tools?toolkit_slug=googledrive&toolkit_versions=latest' \+ -H 'x-api-key: YOUR_API_KEY'+```-**If you're using an MCP client**, you need both: an auth config (so users can authenticate) and an MCP config (so the client can discover and call tools over the MCP protocol).+See [Toolkit versioning](/docs/tools-direct/toolkit-versioning) for more details.+</Accordion>-See [Native Tools vs MCP](/docs/native-tools-vs-mcp) for a full comparison.+<Accordion title="Does Composio support triggers?">+Yes. Triggers let you listen for events from connected apps, like a new email in Gmail, a new issue in GitHub, or a new message in Slack. When the event fires, Composio sends a webhook to your endpoint with the event payload.++See [Triggers](/docs/triggers) for setup and [Subscribing to triggers](/docs/setting-up-triggers/subscribing-to-events) for receiving events.</Accordion>+</Accordions>++## Authentication & Connections++<Accordions>+<Accordion title="What is an auth config?">An auth config is a blueprint that defines how authentication works for a toolkit. It specifies the auth method (OAuth2, API Key, etc.), the scopes to request, and the credentials to use.@@ -108,25 +133,6 @@ Composio supports **OAuth2**, **OAuth1**, **API Key**, **Bearer Token**, and **BFor toolkits with Composio-managed auth, you don't need to configure anything. For toolkits without it, you'll need to create a [custom auth config](/docs/using-custom-auth-configuration). See [Authentication](/docs/authentication) for the full overview.</Accordion>-<Accordion title="How do I work with toolkit versions?">-Composio toolkits are versioned using date-based identifiers (e.g., `20251027_00`). You can pin versions at SDK initialization or per tool execution to keep behavior consistent across deployments.--This applies to direct tool execution only. Sessions with meta tools always use the latest version. See [Toolkit versioning](/docs/tools-direct/toolkit-versioning).-</Accordion>--<Accordion title="Why does the API return fewer tools than the platform UI?">-When calling the Get Tools API (`GET /api/v3/tools`) without specifying a `toolkit_versions` parameter, the API defaults to the base version (`00000000_00`), which only includes tools from the initial release. The platform UI shows tools from the latest version.--To get all available tools, pass `toolkit_versions=latest`:--```bash-curl 'https://backend.composio.dev/api/v3/tools?toolkit_slug=googledrive&toolkit_versions=latest' \- -H 'x-api-key: YOUR_API_KEY'-```--See [Toolkit versioning](/docs/tools-direct/toolkit-versioning) for more details.-</Accordion>-<Accordion title="Can a user connect multiple accounts for the same app?">Yes. For example, a user can connect both a personal and work Gmail account. Call `session.authorize()` multiple times for the same toolkit. Each session uses the most recently connected account by default, but you can pin a specific account when creating the session.@@ -139,26 +145,6 @@ Composio automatically refreshes OAuth tokens before they expire. You don't needIf a refresh fails permanently (e.g., the user revoked access or the OAuth app was deleted), the connection status changes to `EXPIRED`. You can [subscribe to expiry events](/docs/subscribing-to-connection-expiry-events) to detect this and prompt users to re-authenticate. See [Connection statuses](/docs/tools-direct/authenticating-tools#connection-statuses) for more details.</Accordion>-<Accordion title="Does Composio support triggers?">-Yes. Triggers let you listen for events from connected apps, like a new email in Gmail, a new issue in GitHub, or a new message in Slack. When the event fires, Composio sends a webhook to your endpoint with the event payload.--See [Triggers](/docs/triggers) for setup and [Subscribing to triggers](/docs/setting-up-triggers/subscribing-to-events) for receiving events.-</Accordion>--<Accordion title="Why are my connected account secrets showing `abcd...` or `REDACTED`?">-Connected account secrets are masked by default for security. The API returns the first 4 characters followed by `...` (e.g., `gho_...`). Values shorter than 4 characters show as `REDACTED`.--To disable masking, go to **Settings → Project Settings → Project Configuration** and turn off "Mask Connected Account Secrets", or use the Patch Project Config API.--See [Connected accounts](/docs/auth-configuration/connected-accounts#get-account-credentials) for full details.-</Accordion>--<Accordion title="Where can I find execution logs?">-Every tool execution is logged in the [Composio dashboard](https://platform.composio.dev?next_page=/logs/tools) under **Logs > Tools**. Each execution response includes a `log_id` you can use to look up detailed request and response data. Trigger delivery attempts are logged separately under **Logs > Triggers**.--See [Troubleshooting tools](/docs/troubleshooting/tools) for how to use logs to debug failed executions.-</Accordion>-<Accordion title="How do I redirect users back to my app after they connect?">Pass a `callbackUrl` when calling `link()`, `initiate()`, or `session.authorize()`. After authentication, Composio redirects the user to that URL with `status=success` or `status=failed` and the `connected_account_id` appended as query parameters.@@ -200,21 +186,6 @@ const connection = await composio.connectedAccounts.initiate('user_123', 'your_aEach user gets their own connected account scoped to their `user_id`, but they all share your API key under the hood. See [API key connections](/docs/tools-direct/authenticating-tools#api-key-connections) for the full setup.</Accordion>-<Accordion title="Is Composio secure? Where can I find compliance details?">-Yes. Composio is SOC 2 Type II compliant and follows industry-standard security practices for data handling, encryption, and access control. Visit the [Composio Trust Center](https://trust.composio.dev/) for detailed compliance reports, security policies, and certifications.-</Accordion>--<Accordion title="What is the IP range for Composio's MCP servers?">-Composio does not have fixed IP ranges. Traffic is routed through Cloudflare and Vercel, which use dynamic IPs.-</Accordion>--<Accordion title="How do I increase my quota?">-Upgrade your plan. See [pricing](https://composio.dev/pricing) for available plans and limits.-</Accordion>-<Accordion title="When should I create a new session?">-Create a new session when the config changes: different toolkits, different auth config, or a different connected account. You don't need to store or manage session IDs. Just call `create()` each time. See [Users and sessions](/docs/users-and-sessions).-</Accordion>-<Accordion title="How do I configure sessions with custom auth configs?">Some toolkits require your own OAuth credentials or API keys. Create an auth config in the dashboard by selecting the toolkit, choosing the auth scheme, and entering your credentials. Then pass the auth config ID when creating a session using the `auth_configs` (or `auth_config_id`) parameter so the session uses your developer credentials instead of Composio-managed auth. See [Using custom auth configuration](/docs/using-custom-auth-configuration).</Accordion>@@ -255,6 +226,50 @@ This applies whether you're using sessions or direct tool execution:- **Direct tool execution:** Pass the new `authConfigId` when calling `initiate()`. See [Switching auth configs (direct)](/docs/auth-configuration/white-labeling#switching-from-composio-managed-to-your-own-oauth-app).</Accordion>+</Accordions>++## White Labeling & Branding++<Accordions>++<Accordion title="Can I white label Composio's auth screens?">+Yes. By default, OAuth consent screens show "Composio" as the app name. If you create an auth config with your own OAuth client ID and secret, users will see your app's name and logo instead.++You can also proxy the OAuth redirect through your own domain so users never see `backend.composio.dev` in the URL bar. See [White-labeling authentication](/docs/white-labeling-authentication).+</Accordion>++<Accordion title="Is white labeling available on the free plan?">+Yes. White labeling works on all plans, including free. You can create custom auth configs with your own OAuth credentials on any account. See [White-labeling authentication](/docs/white-labeling-authentication).+</Accordion>++<Accordion title="How do I hide the Composio logo during authentication?">+Go to your [project settings](https://platform.composio.dev/settings) and upload your own logo and app title. This replaces Composio branding on the Connect Link page. To also remove "Composio" from OAuth consent screens (Google, GitHub, Slack, etc.), create a custom auth config with your own OAuth credentials. See [White-labeling authentication](/docs/white-labeling-authentication) for the full guide.+</Accordion>++<Accordion title="I changed my branding but still see 'Secured by Composio'">+The Connect Link logo and app title customization does not remove the "Secured by Composio" badge. To remove it, you need to set up your own OAuth app by creating a [custom auth config](/docs/white-labeling-authentication#using-your-own-oauth-apps) with your own client ID and secret.+</Accordion>++</Accordions>++## Debugging & Troubleshooting++<Accordions>++<Accordion title="Why are my connected account secrets showing `abcd...` or `REDACTED`?">+Connected account secrets are masked by default for security. The API returns the first 4 characters followed by `...` (e.g., `gho_...`). Values shorter than 4 characters show as `REDACTED`.++To disable masking, go to **Settings → Project Settings → Project Configuration** and turn off "Mask Connected Account Secrets", or use the Patch Project Config API.++See [Connected accounts](/docs/auth-configuration/connected-accounts#get-account-credentials) for full details.+</Accordion>++<Accordion title="Where can I find execution logs?">+Every tool execution is logged in the [Composio dashboard](https://platform.composio.dev?next_page=/logs/tools) under **Logs > Tools**. Each execution response includes a `log_id` you can use to look up detailed request and response data. Trigger delivery attempts are logged separately under **Logs > Triggers**.++See [Troubleshooting tools](/docs/troubleshooting/tools) for how to use logs to debug failed executions.+</Accordion>+<Accordion title="How do I check complete logs / API calls from the SDK?">Enable debug logging to view all API calls and network requests made by the SDK.@@ -271,6 +286,24 @@ COMPOSIO_LOG_LEVEL=debugSee [Troubleshooting SDKs](/docs/troubleshooting/sdks).</Accordion>+</Accordions>++## Platform & Pricing++<Accordions>++<Accordion title="Is Composio secure? Where can I find compliance details?">+Yes. Composio is SOC 2 Type II compliant and follows industry-standard security practices for data handling, encryption, and access control. Visit the [Composio Trust Center](https://trust.composio.dev/) for detailed compliance reports, security policies, and certifications.+</Accordion>++<Accordion title="What is the IP range for Composio's MCP servers?">+Composio does not have fixed IP ranges. Traffic is routed through Cloudflare and Vercel, which use dynamic IPs.+</Accordion>++<Accordion title="How do I increase my quota?">+Upgrade your plan. See [pricing](https://composio.dev/pricing) for available plans and limits.+</Accordion>+<Accordion title="Can Composio be self-hosted?">Yes, Composio supports self-hosting on the Enterprise plan. See [pricing](https://composio.dev/pricing) for details or [talk to us](https://calendly.com/composiohq/enterprise).</Accordion>