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: deduplicate PromptBanner prompts — reference page code instead of repeating it
Strip install commands and full code examples from PromptBanner prompts since they duplicate the Steps tutorial below. Keep only context, key concepts, rules, deprecated patterns, and verify checklist. Fixes twoslash build failure caused by typescript code blocks inside PromptBanner. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sushmitha Mallesh committed
Mar 6, 2026 at 23:42 UTC
7ec912f6ed7ee0ce6d094c3b9f1bfd66d2b21d89
1 file changed
+6
-419
docs/content/docs/quickstart.mdx
+6
-419
@@ -18,74 +18,7 @@ Build your first AI agent with Composio Tools. You'll create a [session](/docs/u
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**
22
-
23
-```bash
24
-# Python
25
-pip install composio composio-openai-agents openai-agents python-dotenv
26
-
27
-# TypeScript
28
-npm install @composio/core @composio/openai-agents @openai/agents
29
-```
30
-
31
-**.env**
32
-
33
-```
34
-COMPOSIO_API_KEY=your_composio_api_key
35
-OPENAI_API_KEY=your_openai_api_key
36
-```
37
-
38
-Get COMPOSIO_API_KEY from https://platform.composio.dev/settings
39
-
40
-**Complete working example**
41
-
42
-**Python**
43
-
44
-```python
45
-from dotenv import load_dotenv
46
-from composio import Composio
47
-from composio_openai_agents import OpenAIAgentsProvider
48
-from agents import Agent, Runner
49
-
50
-load_dotenv()
51
-
52
-composio = Composio(provider=OpenAIAgentsProvider())
53
-
54
-session = composio.create(user_id="user_123")
55
-tools = session.tools()
56
-
57
-agent = Agent(
58
- name="Assistant",
59
- instructions="You are a helpful assistant. Use Composio tools to take action.",
60
- tools=tools,
61
-)
62
-
63
-result = Runner.run_sync(starting_agent=agent, input="Star the composiohq/composio repo on GitHub")
64
-print(result.final_output)
65
-```
66
-
67
-**TypeScript**
68
-
69
-```typescript
70
-import "dotenv/config";
71
-import { Composio } from "@composio/core";
72
-import { OpenAIAgentsProvider } from "@composio/openai-agents";
73
-import { Agent, run } from "@openai/agents";
74
-
75
-const composio = new Composio({ provider: new OpenAIAgentsProvider() });
76
-
77
-const session = await composio.create("user_123");
78
-const tools = await session.tools();
79
-
80
-const agent = new Agent({
81
- name: "Assistant",
82
- instructions: "You are a helpful assistant. Use Composio tools to take action.",
83
- tools,
84
-});
85
-
86
-const result = await run(agent, "Star the composiohq/composio repo on GitHub");
87
-console.log(result.finalOutput);
88
-```
21
+Use the install commands and code examples from this page as reference.
22
23
**Key concepts**
24
@@ -268,86 +201,7 @@ readline.close();
201
202
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.
203
271
-**Install**
272
-
273
-```bash
274
-# Python
275
-pip install composio openai-agents python-dotenv
276
-
277
-# TypeScript
278
-npm install @composio/core @openai/agents zod@3 dotenv
279
-```
280
-
281
-**.env**
282
-
283
-```
284
-COMPOSIO_API_KEY=your_composio_api_key
285
-OPENAI_API_KEY=your_openai_api_key
286
-```
287
-
288
-Get COMPOSIO_API_KEY from https://platform.composio.dev/settings
289
-
290
-**Complete working example**
291
-
292
-**Python**
293
-
294
-```python
295
-from dotenv import load_dotenv
296
-from composio import Composio
297
-from agents import Agent, Runner, HostedMCPTool
298
-
299
-load_dotenv()
300
-
301
-composio = Composio()
302
-
303
-session = composio.create(user_id="user_123")
304
-
305
-agent = Agent(
306
- name="Assistant",
307
- instructions="You are a helpful assistant. Use Composio tools to take action.",
308
- tools=[
309
- HostedMCPTool(
310
- tool_config={
311
- "type": "mcp",
312
- "server_label": "composio",
313
- "server_url": session.mcp.url,
314
- "require_approval": "never",
315
- "headers": session.mcp.headers,
316
- }
317
- )
318
- ],
319
-)
320
-
321
-result = Runner.run_sync(starting_agent=agent, input="Star the composiohq/composio repo on GitHub")
322
-print(result.final_output)
323
-```
324
-
325
-**TypeScript**
326
-
327
-```typescript
328
-import "dotenv/config";
329
-import { Composio } from "@composio/core";
330
-import { Agent, run, hostedMcpTool } from "@openai/agents";
331
-
332
-const composio = new Composio();
333
-
334
-const session = await composio.create("user_123");
335
-
336
-const agent = new Agent({
337
- name: "Assistant",
338
- instructions: "You are a helpful assistant. Use Composio tools to take action.",
339
- tools: [
340
- hostedMcpTool({
341
- serverLabel: "composio",
342
- serverUrl: session.mcp.url,
343
- headers: session.mcp.headers,
344
- }),
345
- ],
346
-});
347
-
348
-const result = await run(agent, "Star the composiohq/composio repo on GitHub");
349
-console.log(result.finalOutput);
350
-```
204
+Use the install commands and code examples from this page as reference.
205
206
**Key concepts**
207
@@ -551,96 +405,7 @@ readline.close();
405
406
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.
407
554
-**Install**
555
-
556
-```bash
557
-# Python
558
-pip install composio composio-claude-agent-sdk claude-agent-sdk python-dotenv
559
-
560
-# TypeScript
561
-npm install @composio/core @composio/claude-agent-sdk @anthropic-ai/claude-agent-sdk dotenv
562
-```
563
-
564
-**.env**
565
-
566
-```
567
-COMPOSIO_API_KEY=your_composio_api_key
568
-ANTHROPIC_API_KEY=your_anthropic_api_key
569
-```
570
-
571
-Get COMPOSIO_API_KEY from https://platform.composio.dev/settings
572
-
573
-**Complete working example**
574
-
575
-**Python**
576
-
577
-```python
578
-import asyncio
579
-from dotenv import load_dotenv
580
-from composio import Composio
581
-from composio_claude_agent_sdk import ClaudeAgentSDKProvider
582
-from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions, create_sdk_mcp_server, AssistantMessage, TextBlock
583
-
584
-load_dotenv()
585
-
586
-composio = Composio(provider=ClaudeAgentSDKProvider())
587
-
588
-session = composio.create(user_id="user_123")
589
-tools = session.tools()
590
-
591
-custom_server = create_sdk_mcp_server(name="composio", version="1.0.0", tools=tools)
592
-
593
-async def main():
594
- options = ClaudeAgentOptions(
595
- system_prompt="You are a helpful assistant. Use tools to complete tasks.",
596
- permission_mode="bypassPermissions",
597
- mcp_servers={"composio": custom_server},
598
- )
599
- async with ClaudeSDKClient(options=options) as client:
600
- await client.query("Star the composiohq/composio repo on GitHub")
601
- async for message in client.receive_response():
602
- if isinstance(message, AssistantMessage):
603
- for block in message.content:
604
- if isinstance(block, TextBlock):
605
- print(block.text, end="", flush=True)
606
- print()
607
-
608
-asyncio.run(main())
609
-```
610
-
611
-**TypeScript**
612
-
613
-```typescript
614
-import "dotenv/config";
615
-import { Composio } from "@composio/core";
616
-import { ClaudeAgentSDKProvider } from "@composio/claude-agent-sdk";
617
-import { createSdkMcpServer, query } from "@anthropic-ai/claude-agent-sdk";
618
-
619
-const composio = new Composio({ provider: new ClaudeAgentSDKProvider() });
620
-
621
-const session = await composio.create("user_123");
622
-const tools = await session.tools();
623
-
624
-const customServer = createSdkMcpServer({
625
- name: "composio",
626
- version: "1.0.0",
627
- tools,
628
-});
629
-
630
-for await (const stream of query({
631
- prompt: "Star the composiohq/composio repo on GitHub",
632
- options: {
633
- mcpServers: { composio: customServer },
634
- permissionMode: "bypassPermissions",
635
- },
636
-})) {
637
- if (stream.type === "assistant") {
638
- for (const block of stream.message.content) {
639
- if (block.type === "text") process.stdout.write(block.text);
640
- }
641
- }
642
-}
643
-```
408
+Use the install commands and code examples from this page as reference.
409
410
**Key concepts**
411
@@ -852,100 +617,7 @@ readline.close();
617
618
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.
619
855
-**Install**
856
-
857
-```bash
858
-# Python
859
-pip install composio claude-agent-sdk python-dotenv
860
-
861
-# TypeScript
862
-npm install @composio/core @anthropic-ai/claude-agent-sdk dotenv
863
-```
864
-
865
-**.env**
866
-
867
-```
868
-COMPOSIO_API_KEY=your_composio_api_key
869
-ANTHROPIC_API_KEY=your_anthropic_api_key
870
-```
871
-
872
-Get COMPOSIO_API_KEY from https://platform.composio.dev/settings
873
-
874
-**Complete working example**
875
-
876
-**Python**
877
-
878
-```python
879
-import asyncio
880
-from dotenv import load_dotenv
881
-from composio import Composio
882
-from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions, AssistantMessage, TextBlock
883
-
884
-load_dotenv()
885
-
886
-composio = Composio()
887
-
888
-session = composio.create(user_id="user_123")
889
-
890
-options = ClaudeAgentOptions(
891
- system_prompt="You are a helpful assistant. Use tools to complete tasks.",
892
- mcp_servers={
893
- "composio": {
894
- "type": "http",
895
- "url": session.mcp.url,
896
- "headers": session.mcp.headers,
897
- }
898
- },
899
- permission_mode="bypassPermissions",
900
-)
901
-
902
-async def main():
903
- async with ClaudeSDKClient(options) as client:
904
- await client.query("Star the composiohq/composio repo on GitHub")
905
- async for msg in client.receive_response():
906
- if isinstance(msg, AssistantMessage):
907
- for block in msg.content:
908
- if isinstance(block, TextBlock):
909
- print(block.text, end="", flush=True)
910
- print()
911
-
912
-asyncio.run(main())
913
-```
914
-
915
-**TypeScript**
916
-
917
-```typescript
918
-import "dotenv/config";
919
-import { Composio } from "@composio/core";
920
-import { query, type Options } from "@anthropic-ai/claude-agent-sdk";
921
-
922
-const composio = new Composio();
923
-
924
-const session = await composio.create("user_123");
925
-
926
-const options: Options = {
927
- systemPrompt: "You are a helpful assistant. Use tools to complete tasks.",
928
- mcpServers: {
929
- composio: {
930
- type: "http",
931
- url: session.mcp.url,
932
- headers: session.mcp.headers,
933
- },
934
- },
935
- permissionMode: "bypassPermissions",
936
-};
937
-
938
-for await (const stream of query({
939
- prompt: "Star the composiohq/composio repo on GitHub",
940
- options,
941
-})) {
942
- if (stream.type === "assistant") {
943
- for (const block of stream.message.content) {
944
- if (block.type === "text") process.stdout.write(block.text);
945
- }
946
- }
947
-}
948
-```
620
+Use the install commands and code examples from this page as reference.
621
622
**Key concepts**
623
@@ -1174,45 +846,7 @@ readline.close();
846
847
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.
848
1177
-**Install**
1178
-
1179
-```bash
1180
-npm install @composio/core @composio/vercel ai @ai-sdk/anthropic
1181
-```
1182
-
1183
-**.env**
1184
-
1185
-```
1186
-COMPOSIO_API_KEY=your_composio_api_key
1187
-ANTHROPIC_API_KEY=your_anthropic_api_key
1188
-```
1189
-
1190
-Get COMPOSIO_API_KEY from https://platform.composio.dev/settings
1191
-
1192
-**Complete working example**
1193
-
1194
-```typescript
1195
-import "dotenv/config";
1196
-import { Composio } from "@composio/core";
1197
-import { VercelProvider } from "@composio/vercel";
1198
-import { anthropic } from "@ai-sdk/anthropic";
1199
-import { generateText } from "ai";
1200
-
1201
-const composio = new Composio({ provider: new VercelProvider() });
1202
-
1203
-const session = await composio.create("user_123");
1204
-const tools = await session.tools();
1205
-
1206
-const result = await generateText({
1207
- model: anthropic("claude-sonnet-4-6"),
1208
- tools,
1209
- system: "You are a helpful assistant. Use Composio tools to take action.",
1210
- prompt: "Star the composiohq/composio repo on GitHub",
1211
- maxSteps: 10,
1212
-});
1213
-
1214
-console.log(result.text);
1215
-```
849
+Use the install commands and code examples from this page as reference.
850
851
**Key concepts**
852
@@ -1355,54 +989,7 @@ readline.close();
989
990
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.
991
1358
-**Install**
1359
-
1360
-```bash
1361
-npm install @composio/core ai @ai-sdk/anthropic @ai-sdk/mcp dotenv
1362
-```
1363
-
1364
-**.env**
1365
-
1366
-```
1367
-COMPOSIO_API_KEY=your_composio_api_key
1368
-ANTHROPIC_API_KEY=your_anthropic_api_key
1369
-```
1370
-
1371
-Get COMPOSIO_API_KEY from https://platform.composio.dev/settings
1372
-
1373
-**Complete working example**
1374
-
1375
-```typescript
1376
-import "dotenv/config";
1377
-import { Composio } from "@composio/core";
1378
-import { anthropic } from "@ai-sdk/anthropic";
1379
-import { createMCPClient } from "@ai-sdk/mcp";
1380
-import { generateText } from "ai";
1381
-
1382
-const composio = new Composio();
1383
-
1384
-const { mcp } = await composio.create("user_123");
1385
-
1386
-const client = await createMCPClient({
1387
- transport: {
1388
- type: "http",
1389
- url: mcp.url,
1390
- headers: mcp.headers,
1391
- },
1392
-});
1393
-const tools = await client.tools();
1394
-
1395
-const result = await generateText({
1396
- model: anthropic("claude-sonnet-4-6"),
1397
- tools,
1398
- system: "You are a helpful assistant. Use Composio tools to take action.",
1399
- prompt: "Star the composiohq/composio repo on GitHub",
1400
- maxSteps: 10,
1401
-});
1402
-
1403
-console.log(result.text);
1404
-await client.close();
1405
-```
992
+Use the install commands and code examples from this page as reference.
993
994
**Key concepts**
995