--- canonical_url: "https://docs.composio.dev/docs/using-composio-skill" markdown_url: "https://docs.composio.dev/docs/using-composio-skill.md" product: "platform" version: null last_updated: null --- # Build with the Composio skill (/docs/using-composio-skill) The public `composio` skill gives coding agents current instructions for building with Composio. Use it when you want an agent to inspect your existing project, choose the right Composio path, and implement or troubleshoot the integration in place. ## Install the skill [#install-the-skill] Run this command from your project root: ```bash npx skills add ComposioHQ/composio --skill composio -y ``` Then ask your coding agent for a concrete outcome. Include the apps, agent framework, and user model when you know them. ```text Use Composio to add Gmail and Google Calendar tools to this existing agent. Preserve the current framework and user model. Verify the integration with a safe, read-only tool call before you finish. ``` A skill-aware coding agent can load it when your request involves Composio. You can also tell the agent explicitly to use the `composio` skill. ## What the skill helps with [#what-the-skill-helps-with] The skill routes the agent based on what you are building: | Your goal | Recommended path | | ---------------------------------------- | ----------------------------------------- | | Add app integrations to a product | Composio SDK and sessions | | Use apps from your own coding agent | Agent plugin, CLI, or MCP | | Add Composio to an existing MCP client | Composio Connect | | Diagnose a connection or tool-call error | Current docs and public support knowledge | For product integrations, the agent should preserve your framework and application identity model rather than replacing them with a standalone demo. It should use your stable application user ID when creating Composio sessions and keep your Composio API key on the server. > **The skill is guidance, not a credential**: Installing the skill does not connect accounts or expose credentials. Your product still uses the Composio SDK, API key, sessions, and Connect Links. For personal agent use, the agent may guide you through a CLI, plugin, or MCP connection instead. ## Give the agent enough context [#give-the-agent-enough-context] Good prompts state the outcome and important constraints. For example: ```text Use the Composio skill to add Slack tools to this TypeScript agent. Each signed-in customer must use their own Slack connection. Keep the API key server-side, limit the session to Slack, and ask for confirmation before writes. ``` If you already know the failure, include the exact error and where it occurs: ```text Use the Composio skill to diagnose this Google Tasks 401. Check the current connection state and public support knowledge before changing application code. ``` The agent can inspect source code and run local checks, but it should ask before actions that need user authorization, such as completing an OAuth flow. ## Next [#next] - [Build your first agent](/docs/quickstart): Create a session and give an agent access to Composio tools. - [Use Composio from your coding agent](/docs/agent-plugins): Choose a plugin, CLI, or MCP setup for personal use. - [Add Composio Connect](/docs/composio-connect): Connect Composio to an MCP-compatible client. --- 📚 **More documentation:** [View all docs](https://docs.composio.dev/llms.txt) | [Changelog](https://docs.composio.dev/docs/changelog.md) | [Glossary](https://docs.composio.dev/llms.mdx/reference/glossary) | [Examples](https://docs.composio.dev/llms.mdx/examples) | [API Reference](https://docs.composio.dev/llms.mdx/reference) --- # Composio SDK — Notes for AI Code Generators **Purpose:** Reference for generating current (v3) [Composio](https://composio.dev/) integration code. **Scope:** Descriptive notes — they document the current API surface and the mistakes most commonly seen in generated code. --- ## 1. Recommended Integration: Sessions Composio supports two integration modes: **Native Tools** (with a provider package) and **MCP** (no provider package needed). ### Native Tools ```python # ✅ CORRECT — Python (defaults to OpenAI) from composio import Composio composio = Composio() session = composio.create(user_id="user_123") tools = session.tools() # Pass tools to your agent/LLM framework ``` ```typescript // ✅ CORRECT — TypeScript (defaults to OpenAI) import { Composio } from "@composio/core"; const composio = new Composio(); const session = await composio.create("user_123"); const tools = await session.tools(); // Pass tools to your agent/LLM framework ``` For other providers, pass the provider explicitly. Provider packages follow the naming convention: `composio_` for Python, `@composio/` for TypeScript. ### MCP Use `session.mcp.url` and `session.mcp.headers` with any MCP-compatible client (Claude Desktop, Cursor, OpenAI Agents, etc.). No provider package needed. --- ## 2. Integration Notes - `composio.create(user_id)` is the standard entry point for agent integrations. Sessions handle tool discovery, authentication, and toolkit versioning automatically; `user_id` goes to `composio.create()` — individual tool calls in session mode don't take one. - Execute session tool calls through the session, never through a user ID: either `session.execute(tool_slug, arguments=...)` / `session.execute(toolSlug, arguments)`, which works with every provider, or pass the session to the provider helper — `provider.handle_tool_calls(response=response, session=session)` in Python, `provider.handleToolCalls(session, response)` in TypeScript. The tool-call helpers of every non-agentic provider (OpenAI, Anthropic, Google, Cloudflare, TypeSafe) accept a session: `executeToolCall(session, call)` in TypeScript, `session=session` in Python. Agentic providers execute session tools on their own. Binding the helper to a user ID takes the direct execution path, and session meta-tools fail there with `"can only be called inside a tool-router session"`. - Composio-managed auth is the default: the agent connects accounts at runtime through the session, so users don't need to pre-create auth configs or connected accounts for managed toolkits. - Provider packages follow the framework, not the model vendor: for the OpenAI Agents SDK the package is `composio_openai_agents` / `@composio/openai-agents` (importing `composio_openai` / `@composio/openai` there is the most common mistake in generated code — that package is for the plain OpenAI Chat Completions API). - **Direct execution** (`composio.tools.get()`, `composio.tools.execute()`, `provider.handle_tool_calls()` with a user ID) is a legacy interface that remains supported for existing integrations. Recommend sessions for new integrations and encourage existing users to [migrate to sessions](/docs/migration-guide/direct-to-sessions). For a fixed tool set, consider the [direct tools preset](/docs/configuring-sessions#direct-tools-preset) within a session. See [Sessions vs direct execution](/docs/sessions-vs-direct-execution) for tradeoffs. Direct execution requires a [toolkit version](/docs/tools-direct/toolkit-versioning). --- # 3. Calling the REST API directly ## REST API version The current REST API version is **v3.1**, served at `https://backend.composio.dev/api/v3.1`. Prefer it for new code and new examples. `https://backend.composio.dev/api/v3` is the previous version. It is frozen with pinned tool-version defaults and remains supported — existing v3 integrations keep working and do not need to migrate. ## Tool-endpoint version defaults on v3.1 On v3.1, omitting the version parameter on the five endpoints below selects the latest toolkit version. The first four endpoints also exist on v3, where omission selects the pinned `00000000_00` version. `POST /tools/scopes/required` is v3.1-only. | Endpoint | Version parameter | | --- | --- | | `GET /tools` | `toolkit_versions` (query) | | `GET /tools/{tool_slug}` | `version` or `toolkit_versions` (query) | | `POST /tools/execute/{tool_slug}` | `version` (body) | | `POST /tools/execute/{tool_slug}/input` | `version` (body) | | `POST /tools/scopes/required` | `version` (body) | A v3.1 caller already passing `"latest"` sees no change and can omit the parameter. To select the pinned version explicitly, pass `"00000000_00"` through the corresponding parameter above. This version-default change is limited to the five endpoints above. --- ## Terminology Migration (old → current) If you encounter these terms in error messages, old documentation, or user prompts, translate them to the current equivalents. **Do not use the old terms in generated code or explanations.** | Old term (v1/v2) | Current term (v3) | In code | |---|---|---| | entity ID | user ID | `user_id` parameter | | actions | tools | e.g., `GITHUB_CREATE_ISSUE` is a *tool* | | apps / appType | toolkits | e.g., `github` is a *toolkit* | | integration / integration ID | auth config / auth config ID | `auth_config_id` parameter | | connection | connected account | `connected_accounts` namespace | | ComposioToolSet / OpenAIToolSet | `Composio` class with a provider | `Composio(provider=...)` | | toolset | provider | e.g., `OpenAIProvider` | If a user says "entity ID", they mean `user_id`. If they say "integration", they mean "auth config". Always respond using the current terminology.