Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 03:37 UTC
| 1 | --- |
| 2 | title: Glossary |
| 3 | description: Definitions of key Composio terms and concepts. |
| 4 | llmGuardrails: "none" |
| 5 | keywords: [glossary, definitions, terminology] |
| 6 | --- |
| 7 | |
| 8 | <Glossary> |
| 9 | |
| 10 | <GlossaryTerm name="App"> |
| 11 | A grouping of sibling toolkits for one product in the catalog. The Notion app, for example, contains the `notion` and `notion_mcp` toolkits. Use an App to compare toolkits. SDK and API toolkit parameters take exact toolkit slugs, not App display names. See [Apps and toolkits](/docs/apps-and-toolkits). |
| 12 | </GlossaryTerm> |
| 13 | |
| 14 | <GlossaryTerm name="Auth Config"> |
| 15 | A blueprint that defines how authentication works for a toolkit: the auth method (`OAUTH2`, `API_KEY`, `BEARER_TOKEN`, or `BASIC`), scopes, and credentials. A [session](/docs/how-composio-works) creates one automatically when it needs one. To use your own OAuth credentials or non-default scopes, [create a custom one](/docs/auth-configuration/custom-auth-configs). |
| 16 | </GlossaryTerm> |
| 17 | |
| 18 | <GlossaryTerm name="Auth Scheme"> |
| 19 | The authentication method an auth config uses, such as `OAUTH2`, `API_KEY`, `BEARER_TOKEN`, or `BASIC`. |
| 20 | </GlossaryTerm> |
| 21 | |
| 22 | <GlossaryTerm name="Callback URL"> |
| 23 | The URL a user returns to after completing an OAuth flow through a Connect Link. You pass it as `callbackUrl` when you initiate authentication. |
| 24 | </GlossaryTerm> |
| 25 | |
| 26 | <GlossaryTerm name="Composio API Key"> |
| 27 | A project-scoped secret that authenticates your SDK and API requests. Every resource you create with it is scoped to that project. |
| 28 | </GlossaryTerm> |
| 29 | |
| 30 | <GlossaryTerm name="Composio Built"> |
| 31 | A toolkit that Composio builds and maintains on the product's public API, like the `notion` toolkit. Composio Built toolkits can have triggers and commonly authenticate with `OAUTH2` or `API_KEY`, often through Composio Managed Auth. See [Apps and toolkits](/docs/apps-and-toolkits). |
| 32 | </GlossaryTerm> |
| 33 | |
| 34 | <GlossaryTerm name="Composio Managed Auth"> |
| 35 | The default mode in which Composio supplies its own OAuth app credentials for each toolkit. It requires no setup. |
| 36 | </GlossaryTerm> |
| 37 | |
| 38 | <GlossaryTerm name="Connect Link"> |
| 39 | A hosted page where a user authorizes access to a toolkit. It is returned as a `redirect_url` from `session.authorize()` or `connectedAccounts.link()`, and Composio manages the full OAuth flow. See [Authentication](/docs/authentication). |
| 40 | </GlossaryTerm> |
| 41 | |
| 42 | <GlossaryTerm name="Connected Account"> |
| 43 | A stored set of credentials (OAuth tokens or API keys) linked to a userID, created when a user authenticates with a toolkit. Composio refreshes OAuth tokens automatically, and a user can have [multiple connected accounts](/docs/authentication/managing-multiple-connected-accounts) for the same toolkit. IDs are prefixed `ca_`. |
| 44 | </GlossaryTerm> |
| 45 | |
| 46 | <GlossaryTerm name="Connection Request"> |
| 47 | The object returned when you initiate authentication. It contains the Connect Link URL and a `waitForConnection()` method that resolves once the user completes the flow. |
| 48 | </GlossaryTerm> |
| 49 | |
| 50 | <GlossaryTerm name="Custom MCP"> |
| 51 | Your own remote MCP server registered into your project as a toolkit with a `CUSTOM_*` slug, usable in sessions alongside catalog toolkits. Custom MCP toolkits can be shared within your project or private to one user. See [Custom MCP](/docs/extending-sessions/custom-mcp). |
| 52 | </GlossaryTerm> |
| 53 | |
| 54 | <GlossaryTerm name="DCR OAuth"> |
| 55 | OAuth Dynamic Client Registration, the auth scheme many Provider MCP toolkits use. The client registers itself with the product's MCP server automatically, so your user just approves access and there is no OAuth app to register. |
| 56 | </GlossaryTerm> |
| 57 | |
| 58 | <GlossaryTerm name="In-Chat Authentication"> |
| 59 | A flow in which the agent handles authentication itself by calling `COMPOSIO_MANAGE_CONNECTIONS` to generate a Connect Link and send it to the user in the conversation. See [In-chat authentication](/docs/authentication#in-chat-authentication). |
| 60 | </GlossaryTerm> |
| 61 | |
| 62 | <GlossaryTerm name="Local Tool"> |
| 63 | A tool you define yourself that runs in your application process alongside Composio's built-in tools. Previously called a custom tool. Add experimental local tools and local toolkits through [Local tools and toolkits](/docs/extending-sessions/local-tools-and-toolkits). |
| 64 | </GlossaryTerm> |
| 65 | |
| 66 | <GlossaryTerm name="MCP (Model Context Protocol)"> |
| 67 | An open protocol for connecting AI models to external tools. Create a session with `mcp: true` to expose `session.mcp.url` and `session.mcp.headers`, an MCP-compatible endpoint any MCP client can connect to. See [Using sessions via MCP](/docs/sessions-via-mcp). |
| 68 | </GlossaryTerm> |
| 69 | |
| 70 | <GlossaryTerm name="Manual Authentication"> |
| 71 | Authenticating users from your own code with `session.authorize()` or `connectedAccounts.link()`, rather than letting the agent handle it through in-chat authentication. See [Manual authentication](/docs/authentication/manually-authenticating). |
| 72 | </GlossaryTerm> |
| 73 | |
| 74 | <GlossaryTerm name="Meta Tools"> |
| 75 | A set of tools included in every session: `COMPOSIO_SEARCH_TOOLS`, `COMPOSIO_GET_TOOL_SCHEMAS`, `COMPOSIO_MANAGE_CONNECTIONS`, `COMPOSIO_MULTI_EXECUTE_TOOL`, `COMPOSIO_REMOTE_WORKBENCH`, and `COMPOSIO_REMOTE_BASH_TOOL`. They let the agent discover tools, manage auth, execute in parallel, and run code without loading hundreds of tool definitions upfront. See [Meta Tools Reference](/toolkits/meta-tools). |
| 76 | </GlossaryTerm> |
| 77 | |
| 78 | <GlossaryTerm name="Modifiers"> |
| 79 | Middleware that transforms tool behavior. [Schema modifiers](/docs/tools-direct/modify-tool-behavior/schema-modifiers) change a tool's schema before the agent sees it, [before-execution modifiers](/docs/tools-direct/modify-tool-behavior/before-execution-modifiers) change arguments before a tool runs, and [after-execution modifiers](/docs/tools-direct/modify-tool-behavior/after-execution-modifiers) transform the result. In Python, [`@before_file_upload`](/docs/tools-direct/modify-tool-behavior/before-execution-modifiers#before-file-upload-python) intercepts local paths for `file_uploadable` parameters before read and upload. |
| 80 | </GlossaryTerm> |
| 81 | |
| 82 | <GlossaryTerm name="Native Tools"> |
| 83 | Tools you access through provider packages with `session.tools()` and call directly, rather than over MCP. Both paths give the agent the same capabilities, but tools called directly integrate with your AI framework and support modifiers and local tools. |
| 84 | </GlossaryTerm> |
| 85 | |
| 86 | <GlossaryTerm name="Organization"> |
| 87 | The top-level Composio account entity. It contains team members and projects. |
| 88 | </GlossaryTerm> |
| 89 | |
| 90 | <GlossaryTerm name="Organization API Key"> |
| 91 | A key (`x-org-api-key`) for organization-level operations such as creating and managing projects. It is distinct from the project-scoped Composio API Key. |
| 92 | </GlossaryTerm> |
| 93 | |
| 94 | <GlossaryTerm name="Project"> |
| 95 | An isolated environment within an organization that scopes API keys, connected accounts, auth configs, and webhooks. Resources in one project are inaccessible from another. IDs are prefixed `proj_`. See [Projects](/reference/api-reference/projects). |
| 96 | </GlossaryTerm> |
| 97 | |
| 98 | <GlossaryTerm name="Proxy Execute"> |
| 99 | Making authenticated HTTP requests through a toolkit's connected account without a predefined tool. Use it for API endpoints Composio has no built-in tool for. |
| 100 | </GlossaryTerm> |
| 101 | |
| 102 | <GlossaryTerm name="Provider"> |
| 103 | An adapter package that transforms Composio tools into the format an AI framework expects (OpenAI, Anthropic, LangChain, Vercel AI SDK, and others). See [Providers](/docs/providers). |
| 104 | </GlossaryTerm> |
| 105 | |
| 106 | <GlossaryTerm name="Provider MCP"> |
| 107 | A toolkit that connects to the product's own hosted MCP server, maintained by that product. Many slugs end in `_mcp`, such as `notion_mcp`. Check the catalog type and the toolkit's authentication methods. Not to be confused with a provider, which is an AI-framework adapter. See [Apps and toolkits](/docs/apps-and-toolkits). |
| 108 | </GlossaryTerm> |
| 109 | |
| 110 | <GlossaryTerm name="Session"> |
| 111 | An ephemeral, immutable configuration object returned by `composio.create(userId)`. It ties together a userID, the available toolkits, an auth config, and connected accounts, and it exposes `tools()`, `authorize()`, and `toolkits()` (plus `mcp.url` when created with `mcp: true`). See [What is a session?](/docs/how-composio-works). |
| 112 | </GlossaryTerm> |
| 113 | |
| 114 | <GlossaryTerm name="Session ID"> |
| 115 | The unique identifier for a session. Meta tools use it internally to share context across calls within the same session. |
| 116 | </GlossaryTerm> |
| 117 | |
| 118 | <GlossaryTerm name="Tool"> |
| 119 | An individual action an agent can execute. It has an input schema and an output schema, and is named `{TOOLKIT}_{ACTION}` (for example, `GITHUB_CREATE_AN_ISSUE`). |
| 120 | </GlossaryTerm> |
| 121 | |
| 122 | <GlossaryTerm name="Tool Slug"> |
| 123 | A tool's unique identifier, in the `{TOOLKIT}_{ACTION}` pattern (for example, `GITHUB_CREATE_AN_ISSUE`). |
| 124 | </GlossaryTerm> |
| 125 | |
| 126 | <GlossaryTerm name="Toolkit"> |
| 127 | A collection of related tools for a single external service. Users connect to a toolkit through authentication, and all of its tools execute with the user's credentials. |
| 128 | </GlossaryTerm> |
| 129 | |
| 130 | <GlossaryTerm name="Toolkit Slug"> |
| 131 | The lowercase identifier for a toolkit (for example, `github`, `gmail`, or `slack`). Use it when configuring sessions, fetching tools, or creating triggers. |
| 132 | </GlossaryTerm> |
| 133 | |
| 134 | <GlossaryTerm name="Toolkit Versioning"> |
| 135 | Pinning a toolkit to a specific version so your integration keeps a consistent set of tools even as Composio updates its definitions. See [Toolkit versioning](/docs/tools-direct/toolkit-versioning). |
| 136 | </GlossaryTerm> |
| 137 | |
| 138 | <GlossaryTerm name="Trigger"> |
| 139 | A source that sends structured payloads to your application when something happens in a connected app. Triggers come in two kinds: realtime (the provider pushes events the moment they happen, for example Slack, GitHub, or Asana) and polling (Composio checks the provider on a schedule, for example Gmail). Either way, events arrive at your subscription or webhook URL. See [Triggers](/docs/triggers). |
| 140 | </GlossaryTerm> |
| 141 | |
| 142 | <GlossaryTerm name="Trigger Instance"> |
| 143 | A specific, active trigger scoped to a user's connected account. |
| 144 | </GlossaryTerm> |
| 145 | |
| 146 | <GlossaryTerm name="Webhook Endpoint"> |
| 147 | The ingress URL Composio issues per OAuth app for webhook triggers, plus the signing secret used to verify each inbound request. Composio configures it for you in most cases. When a trigger type's `requires_webhook_endpoint_setup` flag is `true`, you configure it yourself once per OAuth app through the [Webhook Endpoints API](/reference/api-reference/webhook-endpoints). See [Custom OAuth webhooks](/docs/setting-up-triggers/custom-oauth-webhooks). |
| 148 | </GlossaryTerm> |
| 149 | |
| 150 | <GlossaryTerm name="Webhook Subscription"> |
| 151 | The URL Composio delivers signed events to in your application. There is one per project, configured through the dashboard or the [Webhook Subscriptions API](/reference/api-reference/webhook-subscriptions). See [Subscribing to events](/docs/setting-up-triggers/subscribing-to-events). |
| 152 | </GlossaryTerm> |
| 153 | |
| 154 | <GlossaryTerm name="userID"> |
| 155 | An identifier from your application that Composio uses to scope connected accounts, tool executions, and authorizations. Connections are fully isolated between userIDs. See [What is a session?](/docs/how-composio-works). |
| 156 | </GlossaryTerm> |
| 157 | |
| 158 | <GlossaryTerm name="White-Labeling"> |
| 159 | Customizing the auth experience so users see your brand during the OAuth flow. You provide your own OAuth credentials, redirect URIs, and branding. See [White-labeling authentication](/docs/authentication/white-labeling-authentication). |
| 160 | </GlossaryTerm> |
| 161 | |
| 162 | <GlossaryTerm name="Sandbox"> |
| 163 | A persistent Python environment (previously called the workbench) exposed through the `COMPOSIO_REMOTE_WORKBENCH` meta tool. Its state persists across calls within a session, which makes it useful for bulk operations, data transformations, and processing large tool responses. Configure it with the `sandbox` session key; `workbench` still works as an alias. See [Sandbox](/docs/sandbox/remote). |
| 164 | </GlossaryTerm> |
| 165 | |
| 166 | </Glossary> |