@devries-cameron20 / composio-1 / commits / 91612ff70
Fork 0

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: improve prompt quality — dual-language deprecated examples, fix rules

- Add TypeScript deprecated examples alongside Python for prompts 1-4 - Prefix Python-specific rules with "In Python," (require_approval, permission_mode) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Sushmitha Mallesh committed Mar 6, 2026 at 23:55 UTC 91612ff7009cce1771f8fc74a92eb6d47535311e
1 file changed +41 -3
docs/content/docs/quickstart.mdx
+41 -3
@@ -40,6 +40,7 @@ NEVER:
40
41 **Deprecated (DO NOT use)**
42
43 +Python:
44 ```
45 # WRONG — old direct execution pattern
46 tools = composio.tools.get(user_id, { toolkits: ['github'] })
@@ -49,6 +50,13 @@ result = composio.tools.execute('GITHUB_STAR_REPO', {...})
50 from composio_core import Composio
51 ```
52
53 +TypeScript:
54 +```
55 +// WRONG — old direct execution pattern
56 +const tools = composio.tools.get(userId, { toolkits: ['github'] });
57 +const result = composio.tools.execute('GITHUB_STAR_REPO', {...});
58 +```
59 +
60 **Verify before responding**
61
62 1. Is `OpenAIAgentsProvider` passed to `Composio()`?
@@ -208,7 +216,7 @@ Give your OpenAI Agent access to 1000+ tools (Gmail, GitHub, Slack, Notion, etc.
216
217 ALWAYS:
218 - Use `session.mcp.url` and `session.mcp.headers` from the session — these are unique per session
211 -- Set `require_approval` to `"never"` in the Python tool_config
219 +- In Python, set `require_approval` to `"never"` in the tool_config
220 - Create a session with a user ID before accessing `session.mcp`
221 - Store API keys in .env, load with dotenv
222
@@ -220,6 +228,7 @@ NEVER:
228
229 **Deprecated (DO NOT use)**
230
231 +Python:
232 ```
233 # WRONG — old direct execution pattern
234 tools = composio.tools.get(user_id, { toolkits: ['github'] })
@@ -232,12 +241,21 @@ composio = Composio(provider=OpenAIAgentsProvider())
241 from composio_core import Composio
242 ```
243
244 +TypeScript:
245 +```
246 +// WRONG — old direct execution pattern
247 +const tools = composio.tools.get(userId, { toolkits: ['github'] });
248 +
249 +// WRONG — using a provider with MCP (not needed)
250 +const composio = new Composio({ provider: new OpenAIAgentsProvider() });
251 +```
252 +
253 **Verify before responding**
254
255 1. Is `Composio()` initialized WITHOUT a provider?
256 2. Is a session created with `composio.create(user_id)`?
257 3. Are `session.mcp.url` and `session.mcp.headers` used for the MCP connection?
240 -4. Is `require_approval` set to `"never"` in Python?
258 +4. In Python, is `require_approval` set to `"never"`?
259 5. Are API keys in .env, not hardcoded?
260
261 </PromptBanner>
@@ -423,6 +441,7 @@ NEVER:
441
442 **Deprecated (DO NOT use)**
443
444 +Python:
445 ```
446 # WRONG — old direct execution pattern
447 tools = composio.tools.get(user_id, { toolkits: ['github'] })
@@ -435,6 +454,15 @@ options = ClaudeAgentOptions(tools=tools)
454 from composio_core import Composio
455 ```
456
457 +TypeScript:
458 +```
459 +// WRONG — old direct execution pattern
460 +const tools = composio.tools.get(userId, { toolkits: ['github'] });
461 +
462 +// WRONG — passing tools directly without MCP server wrapper
463 +const options = new ClaudeAgentOptions({ tools });
464 +```
465 +
466 **Verify before responding**
467
468 1. Is `ClaudeAgentSDKProvider` passed to `Composio()`?
@@ -619,7 +647,7 @@ Give your Claude agent access to 1000+ tools (Gmail, GitHub, Slack, Notion, etc.
647 ALWAYS:
648 - Use `session.mcp.url` and `session.mcp.headers` from the session — these are unique per session
649 - Set MCP server type to `"http"` in the mcp_servers config
622 -- Set `permission_mode` to `"bypassPermissions"`
650 +- In Python, set `permission_mode` to `"bypassPermissions"` in the mcp_servers config
651 - Use `async/await` — Claude Agent SDK is fully async
652 - Store API keys in .env, load with dotenv
653
@@ -631,6 +659,7 @@ NEVER:
659
660 **Deprecated (DO NOT use)**
661
662 +Python:
663 ```
664 # WRONG — old direct execution pattern
665 tools = composio.tools.get(user_id, { toolkits: ['github'] })
@@ -643,6 +672,15 @@ composio = Composio(provider=ClaudeAgentSDKProvider())
672 from composio_core import Composio
673 ```
674
675 +TypeScript:
676 +```
677 +// WRONG — old direct execution pattern
678 +const tools = composio.tools.get(userId, { toolkits: ['github'] });
679 +
680 +// WRONG — using a provider with MCP (not needed)
681 +const composio = new Composio({ provider: new ClaudeAgentSDKProvider() });
682 +```
683 +
684 **Verify before responding**
685
686 1. Is `Composio()` initialized WITHOUT a provider?