@devries-cameron20 / composio Mirror · read-only / commits / 005e5939f
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.

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 22, 04:30 UTC

docs: upgrade PromptBanner with shader gradient background and fix TOC

- Replace sparkle SVGs with radial gradient blobs for a mesh shader effect - Fix TOC pollution by converting markdown headings in prompt content to bold text - Move banner text left with flex-1, use slant arrow (↗) on Skills button Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Sushmitha Mallesh committed Mar 6, 2026 at 23:32 UTC 005e5939fe463a07307c43cb75ef5d1f00aa3c4d
2 files changed +73 -104
docs/components/quickstart/prompt-banner.tsx
+17 -48
@@ -21,57 +21,26 @@ export function PromptBanner({ children }: PromptBannerProps) {
21 return (
22 <div className="not-prose mb-6">
23 <div className="relative flex items-center justify-between gap-6 overflow-hidden rounded-xl border border-fd-border bg-fd-card px-5 py-4">
24 - {/* Ambient glow behind sparkle */}
24 + {/* Shader gradient blobs */}
25 <div
26 - className="pointer-events-none absolute -left-4 top-1/2 -translate-y-1/2 h-32 w-32 rounded-full blur-2xl opacity-[0.12] dark:opacity-[0.15]"
27 - style={{ background: 'var(--composio-orange)' }}
26 + className="pointer-events-none absolute -left-16 -top-24 h-64 w-64 rounded-full"
27 + style={{ background: 'radial-gradient(circle, rgba(242,139,60,0.15) 0%, rgba(242,139,60,0) 70%)' }}
28 + />
29 + <div
30 + className="pointer-events-none absolute right-20 -bottom-24 h-48 w-48 rounded-full"
31 + style={{ background: 'radial-gradient(circle, rgba(242,139,60,0.1) 0%, rgba(242,139,60,0) 70%)' }}
32 + />
33 + <div
34 + className="pointer-events-none absolute left-72 -top-20 h-44 w-44 rounded-full"
35 + style={{ background: 'radial-gradient(circle, rgba(251,191,36,0.08) 0%, rgba(251,191,36,0) 70%)' }}
36 />
37
30 - {/* Large 4-point star */}
31 - <div className="pointer-events-none absolute left-3 top-1/2 -translate-y-1/2 opacity-[0.15] dark:opacity-[0.15]">
32 - <svg width="40" height="40" viewBox="0 0 40 40" fill="none">
33 - <path
34 - d="M20 4C20 4 22 16 20 20C18 16 20 4 20 4Z"
35 - fill="var(--composio-orange)"
36 - />
37 - <path
38 - d="M20 36C20 36 18 24 20 20C22 24 20 36 20 36Z"
39 - fill="var(--composio-orange)"
40 - />
41 - <path
42 - d="M4 20C4 20 16 18 20 20C16 22 4 20 4 20Z"
43 - fill="var(--composio-orange)"
44 - />
45 - <path
46 - d="M36 20C36 20 24 22 20 20C24 18 36 20 36 20Z"
47 - fill="var(--composio-orange)"
48 - />
49 - </svg>
50 - </div>
51 -
52 - {/* Small 4-point star accent */}
53 - <div className="pointer-events-none absolute left-11 top-1.5 opacity-[0.2] dark:opacity-[0.2]">
54 - <svg width="14" height="14" viewBox="0 0 14 14" fill="none">
55 - <path
56 - d="M7 1C7 1 7.8 5.5 7 7C6.2 5.5 7 1 7 1Z"
57 - fill="var(--composio-orange)"
58 - />
59 - <path
60 - d="M7 13C7 13 6.2 8.5 7 7C7.8 8.5 7 13 7 13Z"
61 - fill="var(--composio-orange)"
62 - />
63 - <path
64 - d="M1 7C1 7 5.5 6.2 7 7C5.5 7.8 1 7 1 7Z"
65 - fill="var(--composio-orange)"
66 - />
67 - <path
68 - d="M13 7C13 7 8.5 7.8 7 7C8.5 6.2 13 7 13 7Z"
69 - fill="var(--composio-orange)"
70 - />
71 - </svg>
72 - </div>
38 + {/* Sparkle */}
39 + <svg className="relative shrink-0" width="28" height="28" viewBox="0 0 28 28" fill="none">
40 + <path d="M14 2L16.1 11.9L26 14L16.1 16.1L14 26L11.9 16.1L2 14L11.9 11.9L14 2Z" fill="var(--composio-orange)" opacity="0.25"/>
41 + </svg>
42
74 - <p className="relative pl-10 text-[15px] text-fd-foreground/70">
43 + <p className="relative flex-1 text-[15px] text-fd-foreground/70">
44 Use skills or copy prompt to get started faster!
45 </p>
46
@@ -83,7 +52,7 @@ export function PromptBanner({ children }: PromptBannerProps) {
52 className="inline-flex items-center gap-2 rounded-lg border border-[var(--composio-orange)]/30 bg-transparent px-4 py-2 text-sm font-medium text-[var(--composio-orange)] transition-all hover:border-[var(--composio-orange)]/60 hover:bg-[var(--composio-orange)]/5"
53 >
54 Skills
86 - <span aria-hidden="true">→</span>
55 + <span aria-hidden="true">↗</span>
56 </a>
57 <button
58 type="button"
docs/content/docs/quickstart.mdx
+56 -56
@@ -14,11 +14,11 @@ Build your first AI agent with Composio Tools. You'll create a [session](/docs/u
14 <IntegrationContent value="native">
15
16 <PromptBanner>
17 -# Add Composio tools to an OpenAI Agents app (Native Tools)
17 +**Add Composio tools to an OpenAI Agents app (Native Tools)**
18
19 Give your OpenAI Agent access to 1000+ tools (Gmail, GitHub, Slack, Notion, etc.) via Composio. Composio handles authentication, tool discovery, and execution. You create a **session** for a user, get tools from that session, and pass them to your Agent.
20
21 -## Install
21 +**Install**
22
23 ```bash
24 # Python
@@ -28,7 +28,7 @@ pip install composio composio-openai-agents openai-agents python-dotenv
28 npm install @composio/core @composio/openai-agents @openai/agents
29 ```
30
31 -## .env
31 +**.env**
32
33 ```
34 COMPOSIO_API_KEY=your_composio_api_key
@@ -37,9 +37,9 @@ OPENAI_API_KEY=your_openai_api_key
37
38 Get COMPOSIO_API_KEY from https://platform.composio.dev/settings
39
40 -## Complete working example
40 +**Complete working example**
41
42 -### Python
42 +**Python**
43
44 ```python
45 from dotenv import load_dotenv
@@ -64,7 +64,7 @@ result = Runner.run_sync(starting_agent=agent, input="Star the composiohq/compos
64 print(result.final_output)
65 ```
66
67 -### TypeScript
67 +**TypeScript**
68
69 ```typescript
70 import "dotenv/config";
@@ -87,13 +87,13 @@ const result = await run(agent, "Star the composiohq/composio repo on GitHub");
87 console.log(result.finalOutput);
88 ```
89
90 -## Key concepts
90 +**Key concepts**
91
92 - **Session**: Scoped environment for a user. Created with `composio.create(userId)`. Sessions have access to all toolkits by default — the agent discovers which tools to use via `COMPOSIO_SEARCH_TOOLS`.
93 - **Provider**: Translates Composio tools into the framework's tool format. For OpenAI Agents, use `OpenAIAgentsProvider`.
94 - **Authentication**: When a tool requires auth (e.g., GitHub OAuth), Composio returns an auth URL. The user authenticates once; Composio manages tokens.
95
96 -## Rules
96 +**Rules**
97
98 ALWAYS:
99 - Initialize with `OpenAIAgentsProvider` as the provider
@@ -107,7 +107,7 @@ NEVER:
107 - Import from `composio-core` (the package is `composio` for Python, `@composio/core` for TS)
108 - Use `composio.tools.get()` or `composio.tools.execute()` — these are deprecated direct execution patterns
109
110 -## Deprecated (DO NOT use)
110 +**Deprecated (DO NOT use)**
111
112 ```
113 # WRONG — old direct execution pattern
@@ -118,7 +118,7 @@ result = composio.tools.execute('GITHUB_STAR_REPO', {...})
118 from composio_core import Composio
119 ```
120
121 -## Verify before responding
121 +**Verify before responding**
122
123 1. Is `OpenAIAgentsProvider` passed to `Composio()`?
124 2. Is a session created with `composio.create(user_id)`?
@@ -264,11 +264,11 @@ readline.close();
264 <IntegrationContent value="mcp">
265
266 <PromptBanner>
267 -# Add Composio tools to an OpenAI Agents app (MCP)
267 +**Add Composio tools to an OpenAI Agents app (MCP)**
268
269 Give your OpenAI Agent access to 1000+ tools (Gmail, GitHub, Slack, Notion, etc.) via Composio's hosted MCP server. No provider package needed — you connect directly to Composio's MCP endpoint. Composio handles authentication, tool discovery, and execution. You create a **session** for a user and pass the MCP connection to your Agent.
270
271 -## Install
271 +**Install**
272
273 ```bash
274 # Python
@@ -278,7 +278,7 @@ pip install composio openai-agents python-dotenv
278 npm install @composio/core @openai/agents zod@3 dotenv
279 ```
280
281 -## .env
281 +**.env**
282
283 ```
284 COMPOSIO_API_KEY=your_composio_api_key
@@ -287,9 +287,9 @@ OPENAI_API_KEY=your_openai_api_key
287
288 Get COMPOSIO_API_KEY from https://platform.composio.dev/settings
289
290 -## Complete working example
290 +**Complete working example**
291
292 -### Python
292 +**Python**
293
294 ```python
295 from dotenv import load_dotenv
@@ -322,7 +322,7 @@ result = Runner.run_sync(starting_agent=agent, input="Star the composiohq/compos
322 print(result.final_output)
323 ```
324
325 -### TypeScript
325 +**TypeScript**
326
327 ```typescript
328 import "dotenv/config";
@@ -349,13 +349,13 @@ const result = await run(agent, "Star the composiohq/composio repo on GitHub");
349 console.log(result.finalOutput);
350 ```
351
352 -## Key concepts
352 +**Key concepts**
353
354 - **Session**: Scoped environment for a user. Created with `composio.create(userId)`. Sessions have access to all toolkits by default — the agent discovers which tools to use via `COMPOSIO_SEARCH_TOOLS`.
355 - **MCP mode**: Instead of using a provider package, you connect to Composio's hosted MCP server using `session.mcp.url` and `session.mcp.headers`. No `@composio/openai-agents` package needed.
356 - **Authentication**: When a tool requires auth (e.g., GitHub OAuth), Composio returns an auth URL. The user authenticates once; Composio manages tokens.
357
358 -## Rules
358 +**Rules**
359
360 ALWAYS:
361 - Use `session.mcp.url` and `session.mcp.headers` from the session — these are unique per session
@@ -369,7 +369,7 @@ NEVER:
369 - Import from `composio-core` (the package is `composio` for Python, `@composio/core` for TS)
370 - Use `composio.tools.get()` or `composio.tools.execute()` — these are deprecated direct execution patterns
371
372 -## Deprecated (DO NOT use)
372 +**Deprecated (DO NOT use)**
373
374 ```
375 # WRONG — old direct execution pattern
@@ -383,7 +383,7 @@ composio = Composio(provider=OpenAIAgentsProvider())
383 from composio_core import Composio
384 ```
385
386 -## Verify before responding
386 +**Verify before responding**
387
388 1. Is `Composio()` initialized WITHOUT a provider?
389 2. Is a session created with `composio.create(user_id)`?
@@ -547,11 +547,11 @@ readline.close();
547 <IntegrationContent value="native">
548
549 <PromptBanner>
550 -# Add Composio tools to a Claude Agent SDK app (Native Tools)
550 +**Add Composio tools to a Claude Agent SDK app (Native Tools)**
551
552 Give your Claude agent access to 1000+ tools (Gmail, GitHub, Slack, Notion, etc.) via Composio. Composio handles authentication, tool discovery, and execution. You create a **session** for a user, get tools, wrap them in an SDK MCP server, and pass that server to ClaudeAgentOptions.
553
554 -## Install
554 +**Install**
555
556 ```bash
557 # Python
@@ -561,7 +561,7 @@ pip install composio composio-claude-agent-sdk claude-agent-sdk python-dotenv
561 npm install @composio/core @composio/claude-agent-sdk @anthropic-ai/claude-agent-sdk dotenv
562 ```
563
564 -## .env
564 +**.env**
565
566 ```
567 COMPOSIO_API_KEY=your_composio_api_key
@@ -570,9 +570,9 @@ ANTHROPIC_API_KEY=your_anthropic_api_key
570
571 Get COMPOSIO_API_KEY from https://platform.composio.dev/settings
572
573 -## Complete working example
573 +**Complete working example**
574
575 -### Python
575 +**Python**
576
577 ```python
578 import asyncio
@@ -608,7 +608,7 @@ async def main():
608 asyncio.run(main())
609 ```
610
611 -### TypeScript
611 +**TypeScript**
612
613 ```typescript
614 import "dotenv/config";
@@ -642,14 +642,14 @@ for await (const stream of query({
642 }
643 ```
644
645 -## Key concepts
645 +**Key concepts**
646
647 - **Session**: Scoped environment for a user. Created with `composio.create(userId)`. Sessions have access to all toolkits by default — the agent discovers which tools to use via `COMPOSIO_SEARCH_TOOLS`.
648 - **Provider**: Translates Composio tools into the framework's tool format. For Claude Agent SDK, use `ClaudeAgentSDKProvider`.
649 - **SDK MCP server**: Tools must be wrapped in an SDK MCP server via `create_sdk_mcp_server` / `createSdkMcpServer` before passing to `ClaudeAgentOptions.mcp_servers`. Do NOT pass tools directly.
650 - **Authentication**: When a tool requires auth (e.g., GitHub OAuth), Composio returns an auth URL. The user authenticates once; Composio manages tokens.
651
652 -## Rules
652 +**Rules**
653
654 ALWAYS:
655 - Initialize with `ClaudeAgentSDKProvider` as the provider
@@ -664,7 +664,7 @@ NEVER:
664 - Import from `composio-core` (the package is `composio` for Python, `@composio/core` for TS)
665 - Use `composio.tools.get()` or `composio.tools.execute()` — these are deprecated direct execution patterns
666
667 -## Deprecated (DO NOT use)
667 +**Deprecated (DO NOT use)**
668
669 ```
670 # WRONG — old direct execution pattern
@@ -678,7 +678,7 @@ options = ClaudeAgentOptions(tools=tools)
678 from composio_core import Composio
679 ```
680
681 -## Verify before responding
681 +**Verify before responding**
682
683 1. Is `ClaudeAgentSDKProvider` passed to `Composio()`?
684 2. Is a session created with `composio.create(user_id)`?
@@ -848,11 +848,11 @@ readline.close();
848 <IntegrationContent value="mcp">
849
850 <PromptBanner>
851 -# Add Composio tools to a Claude Agent SDK app (MCP)
851 +**Add Composio tools to a Claude Agent SDK app (MCP)**
852
853 Give your Claude agent access to 1000+ tools (Gmail, GitHub, Slack, Notion, etc.) via Composio's hosted MCP server. No provider package needed — you connect directly to Composio's MCP endpoint. Composio handles authentication, tool discovery, and execution. You create a **session** for a user and pass the MCP connection to ClaudeAgentOptions.
854
855 -## Install
855 +**Install**
856
857 ```bash
858 # Python
@@ -862,7 +862,7 @@ pip install composio claude-agent-sdk python-dotenv
862 npm install @composio/core @anthropic-ai/claude-agent-sdk dotenv
863 ```
864
865 -## .env
865 +**.env**
866
867 ```
868 COMPOSIO_API_KEY=your_composio_api_key
@@ -871,9 +871,9 @@ ANTHROPIC_API_KEY=your_anthropic_api_key
871
872 Get COMPOSIO_API_KEY from https://platform.composio.dev/settings
873
874 -## Complete working example
874 +**Complete working example**
875
876 -### Python
876 +**Python**
877
878 ```python
879 import asyncio
@@ -912,7 +912,7 @@ async def main():
912 asyncio.run(main())
913 ```
914
915 -### TypeScript
915 +**TypeScript**
916
917 ```typescript
918 import "dotenv/config";
@@ -947,13 +947,13 @@ for await (const stream of query({
947 }
948 ```
949
950 -## Key concepts
950 +**Key concepts**
951
952 - **Session**: Scoped environment for a user. Created with `composio.create(userId)`. Sessions have access to all toolkits by default — the agent discovers which tools to use via `COMPOSIO_SEARCH_TOOLS`.
953 - **MCP mode**: Instead of using a provider package, you connect to Composio's hosted MCP server using `session.mcp.url` and `session.mcp.headers`. No `@composio/claude-agent-sdk` package needed.
954 - **Authentication**: When a tool requires auth (e.g., GitHub OAuth), Composio returns an auth URL. The user authenticates once; Composio manages tokens.
955
956 -## Rules
956 +**Rules**
957
958 ALWAYS:
959 - Use `session.mcp.url` and `session.mcp.headers` from the session — these are unique per session
@@ -968,7 +968,7 @@ NEVER:
968 - Import from `composio-core` (the package is `composio` for Python, `@composio/core` for TS)
969 - Use `composio.tools.get()` or `composio.tools.execute()` — these are deprecated direct execution patterns
970
971 -## Deprecated (DO NOT use)
971 +**Deprecated (DO NOT use)**
972
973 ```
974 # WRONG — old direct execution pattern
@@ -982,7 +982,7 @@ composio = Composio(provider=ClaudeAgentSDKProvider())
982 from composio_core import Composio
983 ```
984
985 -## Verify before responding
985 +**Verify before responding**
986
987 1. Is `Composio()` initialized WITHOUT a provider?
988 2. Is a session created with `composio.create(user_id)`?
@@ -1170,17 +1170,17 @@ readline.close();
1170 <IntegrationContent value="native">
1171
1172 <PromptBanner>
1173 -# Add Composio tools to a Vercel AI SDK app (Native Tools)
1173 +**Add Composio tools to a Vercel AI SDK app (Native Tools)**
1174
1175 Give your Vercel AI agent access to 1000+ tools (Gmail, GitHub, Slack, Notion, etc.) via Composio. Composio handles authentication, tool discovery, and execution. You create a **session** for a user, get tools from that session, and pass them to `streamText` or `generateText`. TypeScript only.
1176
1177 -## Install
1177 +**Install**
1178
1179 ```bash
1180 npm install @composio/core @composio/vercel ai @ai-sdk/anthropic
1181 ```
1182
1183 -## .env
1183 +**.env**
1184
1185 ```
1186 COMPOSIO_API_KEY=your_composio_api_key
@@ -1189,7 +1189,7 @@ ANTHROPIC_API_KEY=your_anthropic_api_key
1189
1190 Get COMPOSIO_API_KEY from https://platform.composio.dev/settings
1191
1192 -## Complete working example
1192 +**Complete working example**
1193
1194 ```typescript
1195 import "dotenv/config";
@@ -1214,14 +1214,14 @@ const result = await generateText({
1214 console.log(result.text);
1215 ```
1216
1217 -## Key concepts
1217 +**Key concepts**
1218
1219 - **Session**: Scoped environment for a user. Created with `composio.create(userId)`. Sessions have access to all toolkits by default — the agent discovers which tools to use via `COMPOSIO_SEARCH_TOOLS`.
1220 - **Provider**: Translates Composio tools into the framework's tool format. For Vercel AI, use `VercelProvider`.
1221 - **streamText vs generateText**: Use `streamText` for streaming responses, `generateText` for single responses. Both accept Composio tools via the `tools` parameter.
1222 - **Authentication**: When a tool requires auth (e.g., GitHub OAuth), Composio returns an auth URL. The user authenticates once; Composio manages tokens.
1223
1224 -## Rules
1224 +**Rules**
1225
1226 ALWAYS:
1227 - Initialize with `VercelProvider` as the provider
@@ -1238,7 +1238,7 @@ NEVER:
1238 - Use `composio.tools.get()` or `composio.tools.execute()` — these are deprecated direct execution patterns
1239 - Forget `maxSteps` — without it, the model won't execute tool calls
1240
1241 -## Deprecated (DO NOT use)
1241 +**Deprecated (DO NOT use)**
1242
1243 ```
1244 // WRONG — old direct execution pattern
@@ -1249,7 +1249,7 @@ const result = composio.tools.execute('GITHUB_STAR_REPO', {...});
1249 const result = await generateText({ model, tools, prompt });
1250 ```
1251
1252 -## Verify before responding
1252 +**Verify before responding**
1253
1254 1. Is `VercelProvider` passed to `Composio()`?
1255 2. Is a session created with `composio.create(userId)`?
@@ -1351,17 +1351,17 @@ readline.close();
1351 <IntegrationContent value="mcp">
1352
1353 <PromptBanner>
1354 -# Add Composio tools to a Vercel AI SDK app (MCP)
1354 +**Add Composio tools to a Vercel AI SDK app (MCP)**
1355
1356 Give your Vercel AI agent access to 1000+ tools (Gmail, GitHub, Slack, Notion, etc.) via Composio's hosted MCP server. No provider package needed — you connect directly to Composio's MCP endpoint using `@ai-sdk/mcp`. Composio handles authentication, tool discovery, and execution. TypeScript only.
1357
1358 -## Install
1358 +**Install**
1359
1360 ```bash
1361 npm install @composio/core ai @ai-sdk/anthropic @ai-sdk/mcp dotenv
1362 ```
1363
1364 -## .env
1364 +**.env**
1365
1366 ```
1367 COMPOSIO_API_KEY=your_composio_api_key
@@ -1370,7 +1370,7 @@ ANTHROPIC_API_KEY=your_anthropic_api_key
1370
1371 Get COMPOSIO_API_KEY from https://platform.composio.dev/settings
1372
1373 -## Complete working example
1373 +**Complete working example**
1374
1375 ```typescript
1376 import "dotenv/config";
@@ -1404,14 +1404,14 @@ console.log(result.text);
1404 await client.close();
1405 ```
1406
1407 -## Key concepts
1407 +**Key concepts**
1408
1409 - **Session**: Scoped environment for a user. Created with `composio.create(userId)`. Sessions have access to all toolkits by default — the agent discovers which tools to use via `COMPOSIO_SEARCH_TOOLS`.
1410 - **MCP mode**: Instead of using a provider package, you connect to Composio's hosted MCP server using `session.mcp.url` and `session.mcp.headers` via `@ai-sdk/mcp`. No `@composio/vercel` package needed.
1411 - **Client lifecycle**: Always close the MCP client with `await client.close()` when done.
1412 - **Authentication**: When a tool requires auth (e.g., GitHub OAuth), Composio returns an auth URL. The user authenticates once; Composio manages tokens.
1413
1414 -## Rules
1414 +**Rules**
1415
1416 ALWAYS:
1417 - Use `mcp.url` and `mcp.headers` from the session — destructure with `const { mcp } = await composio.create(userId)`
@@ -1428,7 +1428,7 @@ NEVER:
1428 - Forget `maxSteps` — without it, the model won't execute tool calls
1429 - Forget `await client.close()` — this leaks the MCP connection
1430
1431 -## Deprecated (DO NOT use)
1431 +**Deprecated (DO NOT use)**
1432
1433 ```
1434 // WRONG — old direct execution pattern
@@ -1442,7 +1442,7 @@ const composio = new Composio({ provider: new VercelProvider() });
1442 const result = await generateText({ model, tools, prompt });
1443 ```
1444
1445 -## Verify before responding
1445 +**Verify before responding**
1446
1447 1. Is `Composio()` initialized WITHOUT a provider?
1448 2. Is `mcp.url` and `mcp.headers` destructured from `composio.create(userId)`?