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.

docs: add v1→v3 terminology migration table to LLM guardrails

Sushmitha Malleshb991d4d80e89
diff --git a/docs/lib/llm-guardrails/direct-execution.ts b/docs/lib/llm-guardrails/direct-execution.ts
index 3e89d0a12..f7b57689c 100644
--- a/docs/lib/llm-guardrails/direct-execution.ts
+++ b/docs/lib/llm-guardrails/direct-execution.ts
@@ -68,4 +68,22 @@ const result = await composio.tools.execute("GITHUB_CREATE_ISSUE", {
2. **\`tools.execute()\` signature** — Python: \`execute(slug, arguments_dict, *, user_id=...)\` (arguments is the second positional param). TypeScript: \`execute(slug, { userId, arguments })\`.
3. **Provider at init** — \`Composio(provider=OpenAIProvider())\` in Python, \`new Composio({ provider: new OpenAIProvider() })\` in TypeScript. Defaults to OpenAI if omitted.
4. **Correct provider imports** — \`composio_<provider>\` for Python, \`@composio/<provider>\` for TypeScript. For OpenAI Agents SDK use \`composio_openai_agents\` / \`@composio/openai-agents\`.
+
+---
+
+## 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.
`;
diff --git a/docs/lib/llm-guardrails/session.ts b/docs/lib/llm-guardrails/session.ts
index c75f31450..5f1ed5ff2 100644
--- a/docs/lib/llm-guardrails/session.ts
+++ b/docs/lib/llm-guardrails/session.ts
@@ -65,4 +65,22 @@ Use \`session.mcp.url\` and \`session.mcp.headers\` with any MCP-compatible clie
Do **not** generate \`composio.tools.get()\`, \`composio.tools.execute()\`, or \`composio.provider.handle_tool_calls()\` unless the user explicitly requests direct tool execution. These are a supported but **not recommended** low-level interface.
+---
+
+## 3. 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.
+
`;