@devries-cameron20 / composio-1 / commits / d22f7ace0
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.

feat(fumadocs): add Twoslash type checking to core docs pages

Added TypeScript type validation via Twoslash to: - authenticating-tools.mdx (7 blocks) - connected-accounts.mdx (8 blocks) - custom-auth-configs.mdx (2 blocks) - custom-auth-params.mdx (4 blocks) - custom-tools.mdx (5 blocks) - executing-tools.mdx (7 blocks) - fetching-tools.mdx (6 blocks) - quickstart.mdx (2 blocks) Fixed type errors caught by Twoslash: - connected-accounts: redirect_url property name - executing-tools: file upload property name (filePath -> file) - custom-auth-params: beforeExecute modifier signature Uses // ---cut--- for hidden setup code and // @noErrors for examples with external dependencies (Anthropic, Vercel AI SDK) or complex Zod types. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Sushmithamallesh committed Jan 12, 2026 at 14:27 UTC d22f7ace0b33cd36cbccedce6c238199c195f47f
8 files changed +166 -45
fumadocs/content/docs/authenticating-tools.mdx
+21 -10
@@ -129,10 +129,10 @@ print(f"Visit: {redirect_url} to authenticate your account")
129 ```
130 </Tab>
131 <Tab value="TypeScript">
132 -```typescript
132 +```typescript twoslash
133 import { Composio } from '@composio/core';
134
135 -const composio = new Composio({apiKey: "your_api_key"});
135 +const composio = new Composio({ apiKey: "your_api_key" });
136
137 // Use the "AUTH CONFIG ID" from your dashboard
138 const authConfigId = 'your_auth_config_id';
@@ -202,10 +202,10 @@ print(f"Connection established: {connected_account.id}")
202 ```
203 </Tab>
204 <Tab value="TypeScript">
205 -```typescript
205 +```typescript twoslash
206 import { Composio } from '@composio/core';
207
208 -const composio = new Composio({apiKey: "YOUR_COMPOSIO_API_KEY"});
208 +const composio = new Composio({ apiKey: "YOUR_COMPOSIO_API_KEY" });
209
210 // Use the "AUTH CONFIG ID" from your dashboard
211 const authConfigId = 'your_auth_config_id';
@@ -249,8 +249,12 @@ connection_request = composio.connected_accounts.initiate(
249 ```
250 </Tab>
251 <Tab value="TypeScript">
252 -```typescript
253 -import { AuthScheme } from '@composio/core';
252 +```typescript twoslash
253 +import { Composio, AuthScheme } from '@composio/core';
254 +const composio = new Composio({ apiKey: "your_api_key" });
255 +const userId = 'user_123';
256 +const authConfigId = 'your_auth_config_id';
257 +// ---cut---
258 // For Zendesk - include subdomain
259 const connRequest = await composio.connectedAccounts.initiate(userId, authConfigId, {
260 config: AuthScheme.OAuth2({
@@ -296,7 +300,7 @@ print(f"Connection established: {connection_request.id}")
300 ```
301 </Tab>
302 <Tab value="TypeScript">
299 -```typescript
303 +```typescript twoslash
304 import { Composio, AuthScheme } from '@composio/core';
305
306 const composio = new Composio({ apiKey: 'your_api_key' });
@@ -346,7 +350,7 @@ print(f"Required fields: {auth_config.expected_input_fields}")
350 ```
351 </Tab>
352 <Tab value="TypeScript">
349 -```typescript
353 +```typescript twoslash
354 import { Composio } from '@composio/core';
355
356 const composio = new Composio({ apiKey: 'your_api_key' });
@@ -416,7 +420,11 @@ print(connected_account.id)
420 ```
421 </Tab>
422 <Tab value="TypeScript">
419 -```typescript
423 +```typescript twoslash
424 +import { Composio } from '@composio/core';
425 +const composio = new Composio({ apiKey: 'your_api_key' });
426 +const connectionRequest = await composio.connectedAccounts.initiate('user_123', 'auth_config_id', {});
427 +// ---cut---
428 // Wait for the connection to be established
429 const connectedAccount = await connectionRequest.waitForConnection();
430 console.log(connectedAccount.id);
@@ -458,7 +466,10 @@ for connection in filtered_connections.items:
466 ```
467 </Tab>
468 <Tab value="TypeScript">
461 -```typescript
469 +```typescript twoslash
470 +import { Composio } from '@composio/core';
471 +const composio = new Composio({ apiKey: 'your_api_key' });
472 +// ---cut---
473 // Get a specific connected account by its nanoid
474 const connectedAccount = await composio.connectedAccounts.get('your_connected_account_id');
475 console.log(`Status: ${connectedAccount.status}`);
fumadocs/content/docs/connected-accounts.mdx
+42 -8
@@ -28,7 +28,11 @@ active_accounts = composio.connected_accounts.list(
28 ```
29 </Tab>
30 <Tab value="TypeScript">
31 -```typescript
31 +```typescript twoslash
32 +import { Composio } from '@composio/core';
33 +const composio = new Composio({ apiKey: 'your_api_key' });
34 +const userId = 'user_123';
35 +// ---cut---
36 // List all accounts for a user
37 const accounts = await composio.connectedAccounts.list({
38 userIds: [userId]
@@ -57,7 +61,11 @@ print(f"Toolkit: {account.toolkit.slug}")
61 ```
62 </Tab>
63 <Tab value="TypeScript">
60 -```typescript
64 +```typescript twoslash
65 +import { Composio } from '@composio/core';
66 +const composio = new Composio({ apiKey: 'your_api_key' });
67 +const connectedAccountId = 'ca_123';
68 +// ---cut---
69 const account = await composio.connectedAccounts.get(connectedAccountId);
70
71 console.log('Status:', account.status);
@@ -84,7 +92,11 @@ if account.state:
92 ```
93 </Tab>
94 <Tab value="TypeScript">
87 -```typescript
95 +```typescript twoslash
96 +import { Composio } from '@composio/core';
97 +const composio = new Composio({ apiKey: 'your_api_key' });
98 +const account = await composio.connectedAccounts.get('ca_123');
99 +// ---cut---
100 // Get the connected account's authentication state
101 if (account.state) {
102 // The state contains the auth scheme and credentials
@@ -122,7 +134,11 @@ except Exception as e:
134 ```
135 </Tab>
136 <Tab value="TypeScript">
125 -```typescript
137 +```typescript twoslash
138 +import { Composio } from '@composio/core';
139 +const composio = new Composio({ apiKey: 'your_api_key' });
140 +const connectedAccountId = 'ca_123';
141 +// ---cut---
142 try {
143 const refreshed = await composio.connectedAccounts.refresh(connectedAccountId);
144 console.log('Redirect URL:', refreshed.redirect_url);
@@ -155,7 +171,11 @@ print(f"Account enabled status: {enabled.success}")
171 ```
172 </Tab>
173 <Tab value="TypeScript">
158 -```typescript
174 +```typescript twoslash
175 +import { Composio } from '@composio/core';
176 +const composio = new Composio({ apiKey: 'your_api_key' });
177 +const connectedAccountId = 'ca_123';
178 +// ---cut---
179 // Disable an account
180 const disabled = await composio.connectedAccounts.disable(connectedAccountId);
181 console.log('Account disabled status:', disabled.success);
@@ -184,7 +204,11 @@ print("Account deleted successfully")
204 ```
205 </Tab>
206 <Tab value="TypeScript">
187 -```typescript
207 +```typescript twoslash
208 +import { Composio } from '@composio/core';
209 +const composio = new Composio({ apiKey: 'your_api_key' });
210 +const connectedAccountId = 'ca_123';
211 +// ---cut---
212 // Delete a connected account
213 await composio.connectedAccounts.delete(connectedAccountId);
214 console.log('Account deleted successfully');
@@ -234,7 +258,12 @@ except Exception as e:
258 ```
259 </Tab>
260 <Tab value="TypeScript">
237 -```typescript
261 +```typescript twoslash
262 +import { Composio } from '@composio/core';
263 +const composio = new Composio({ apiKey: 'your_api_key' });
264 +const userId = 'user_123';
265 +const authConfigId = 'ac_123';
266 +// ---cut---
267 // First account
268 try {
269 const firstAccount = await composio.connectedAccounts.initiate(
@@ -286,7 +315,12 @@ print(f"Tool executed: {result}")
315 ```
316 </Tab>
317 <Tab value="TypeScript">
289 -```typescript
318 +```typescript twoslash
319 +import { Composio } from '@composio/core';
320 +const composio = new Composio({ apiKey: 'your_api_key' });
321 +const userId = 'user_123';
322 +const connectedAccountId = 'ca_123';
323 +// ---cut---
324 // Execute tool with a specific connected account
325 const result = await composio.tools.execute('GMAIL_GET_PROFILE', {
326 userId: userId,
fumadocs/content/docs/custom-auth-configs.mdx
+7 -2
@@ -101,7 +101,11 @@ print(connected_account)
101 ```
102 </Tab>
103 <Tab value="TypeScript">
104 -```typescript
104 +```typescript twoslash
105 +import { Composio } from '@composio/core';
106 +const composio = new Composio({ apiKey: 'your_api_key' });
107 +const userId = 'user_123';
108 +// ---cut---
109 const connReq = await composio.connectedAccounts.initiate(userId, "ac_1234");
110
111 console.log(connReq.redirectUrl);
@@ -175,7 +179,8 @@ def authorize_app(toolkit: str):
179 ```
180 </Tab>
181 <Tab value="TypeScript">
178 -```typescript
182 +```typescript twoslash
183 +// @noErrors
184 import type { NextApiRequest, NextApiResponse } from 'next';
185
186 export default function handler(req: NextApiRequest, res: NextApiResponse) {
fumadocs/content/docs/custom-auth-params.mdx
+12 -4
@@ -19,7 +19,7 @@ composio = Composio()
19 ```
20 </Tab>
21 <Tab value="TypeScript">
22 -```typescript
22 +```typescript twoslash
23 import { Composio } from "@composio/core";
24
25 const composio = new Composio({
@@ -64,8 +64,12 @@ def add_custom_auth(
64 ```
65 </Tab>
66 <Tab value="TypeScript">
67 -```typescript
68 -const authModifier = (toolSlug: string, toolkitSlug: string, params: any) => {
67 +```typescript twoslash
68 +const authModifier = ({ toolSlug, toolkitSlug, params }: {
69 + toolSlug: string;
70 + toolkitSlug: string;
71 + params: any;
72 +}) => {
73 // Add authentication parameters for specific toolkits
74 if (toolkitSlug === "NOTION") {
75 if (!params.customAuthParams) {
@@ -112,7 +116,11 @@ print(result)
116 ```
117 </Tab>
118 <Tab value="TypeScript">
115 -```typescript
119 +```typescript twoslash
120 +import { Composio } from '@composio/core';
121 +const composio = new Composio({ apiKey: 'your_api_key' });
122 +const authModifier = ({ params }: { toolSlug: string; toolkitSlug: string; params: any }) => params;
123 +// ---cut---
124 const result = await composio.tools.execute(
125 "NOTION_GET_DATABASE_ITEMS",
126 {
fumadocs/content/docs/custom-tools.mdx
+28 -5
@@ -44,7 +44,12 @@ def add_two_numbers(request: AddTwoNumbersInput) -> int:
44 ```
45 </Tab>
46 <Tab value="TypeScript">
47 -```typescript
47 +```typescript twoslash
48 +// @noErrors
49 +import { Composio } from '@composio/core';
50 +import { z } from 'zod';
51 +const composio = new Composio({ apiKey: 'your_api_key' });
52 +// ---cut---
53 const tool = await composio.tools.createCustomTool({
54 slug: 'CALCULATE_SQUARE',
55 name: 'Calculate Square',
@@ -108,7 +113,12 @@ def get_issue_info(
113 ```
114 </Tab>
115 <Tab value="TypeScript">
111 -```typescript
116 +```typescript twoslash
117 +// @noErrors
118 +import { Composio } from '@composio/core';
119 +import { z } from 'zod';
120 +const composio = new Composio({ apiKey: 'your_api_key' });
121 +// ---cut---
122 const tool = await composio.tools.createCustomTool({
123 slug: 'GITHUB_STAR_COMPOSIOHQ_REPOSITORY',
124 name: 'Github star composio repositories',
@@ -175,7 +185,12 @@ def get_issue_info_direct(
185 ```
186 </Tab>
187 <Tab value="TypeScript">
178 -```typescript
188 +```typescript twoslash
189 +// @noErrors
190 +import { Composio } from '@composio/core';
191 +import { z } from 'zod';
192 +const composio = new Composio({ apiKey: 'your_api_key' });
193 +// ---cut---
194 const tool = await composio.tools.createCustomTool({
195 slug: 'GITHUB_DIRECT_API',
196 name: 'Direct GitHub API Call',
@@ -242,7 +257,12 @@ def get_issue_info(
257 ```
258 </Tab>
259 <Tab value="TypeScript">
245 -```typescript
260 +```typescript twoslash
261 +// @noErrors
262 +import { Composio } from '@composio/core';
263 +import { z } from 'zod';
264 +const composio = new Composio({ apiKey: 'your_api_key' });
265 +// ---cut---
266 const tool = await composio.tools.createCustomTool({
267 slug: 'GITHUB_SEARCH_REPOSITORIES',
268 name: 'Search GitHub Repositories',
@@ -304,7 +324,10 @@ response = composio.tools.execute(
324 ```
325 </Tab>
326 <Tab value="TypeScript">
307 -```typescript
327 +```typescript twoslash
328 +import { Composio } from '@composio/core';
329 +const composio = new Composio({ apiKey: 'your_api_key' });
330 +// ---cut---
331 const result = await composio.tools.execute('TOOL_SLUG', {
332 arguments: {
333 // Tool input parameters
fumadocs/content/docs/executing-tools.mdx
+23 -8
@@ -55,7 +55,8 @@ print(result)
55 ```
56 </Tab>
57 <Tab value="TypeScript">
58 -```typescript
58 +```typescript twoslash
59 +// @noErrors
60 import { Composio } from '@composio/core';
61 import { AnthropicProvider } from '@composio/anthropic';
62 import { Anthropic } from '@anthropic-ai/sdk';
@@ -140,7 +141,8 @@ asyncio.run(main())
141 ```
142 </Tab>
143 <Tab value="TypeScript">
143 -```typescript
144 +```typescript twoslash
145 +// @noErrors
146 import { Composio } from '@composio/core';
147 import { generateText } from 'ai';
148 import { anthropic } from '@ai-sdk/anthropic';
@@ -212,7 +214,7 @@ print(result)
214 ```
215 </Tab>
216 <Tab value="TypeScript">
215 -```typescript
217 +```typescript twoslash
218 import { Composio } from "@composio/core";
219
220 const userId = "user-k7334";
@@ -268,7 +270,10 @@ print(response)
270 ```
271 </Tab>
272 <Tab value="TypeScript">
271 -```typescript
273 +```typescript twoslash
274 +import { Composio } from '@composio/core';
275 +const composio = new Composio({ apiKey: 'your_api_key' });
276 +// ---cut---
277 // Send a proxy request to the endpoint
278 const { data } = await composio.tools.proxyExecute({
279 endpoint:'/repos/composiohq/composio/issues/1',
@@ -314,7 +319,11 @@ print(result) # Print Google Drive file details
319 ```
320 </Tab>
321 <Tab value="TypeScript">
317 -```typescript
322 +```typescript twoslash
323 +import { Composio } from '@composio/core';
324 +import path from 'path';
325 +const composio = new Composio({ apiKey: 'your_api_key' });
326 +// ---cut---
327 // Upload a local file to Google Drive
328 const result = await composio.tools.execute('GOOGLEDRIVE_UPLOAD_FILE', {
329 userId: 'user-4235***',
@@ -351,7 +360,10 @@ print(result)
360 ```
361 </Tab>
362 <Tab value="TypeScript">
354 -```typescript
363 +```typescript twoslash
364 +import { Composio } from '@composio/core';
365 +const composio = new Composio({ apiKey: 'your_api_key' });
366 +// ---cut---
367 // Download a file from Google Drive
368 const result = await composio.tools.execute('GOOGLEDRIVE_DOWNLOAD_FILE', {
369 userId: 'user-1235***',
@@ -370,7 +382,10 @@ console.log(result);
382
383 You can disable automatic file handling when initializing the TypeScript SDK. When disabled, handle file uploads and downloads manually using `files.upload` and `files.download`:
384
373 -```typescript
385 +```typescript twoslash
386 +import { Composio } from '@composio/core';
387 +import path from 'path';
388 +// ---cut---
389 const composio = new Composio({
390 apiKey: process.env.COMPOSIO_API_KEY,
391 autoUploadDownloadFiles: false
@@ -378,7 +393,7 @@ const composio = new Composio({
393
394 // Now you need to handle files manually using composio.files API
395 const fileData = await composio.files.upload({
381 - filePath: path.join(__dirname, 'document.pdf'),
396 + file: path.join(__dirname, 'document.pdf'),
397 toolSlug: 'GOOGLEDRIVE_UPLOAD_FILE',
398 toolkitSlug: 'googledrive'
399 });
fumadocs/content/docs/fetching-tools.mdx
+29 -6
@@ -18,7 +18,11 @@ tools = composio.tools.get(
18 ```
19 </Tab>
20 <Tab value="TypeScript">
21 -```typescript
21 +```typescript twoslash
22 +import { Composio } from '@composio/core';
23 +const composio = new Composio({ apiKey: 'your_api_key' });
24 +const userId = 'user_123';
25 +// ---cut---
26 const tools = await composio.tools.get(userId, {
27 toolkits: ["GITHUB"]
28 });
@@ -39,7 +43,10 @@ tool = composio.tools.get_raw_composio_tool_by_slug("GMAIL_SEND_EMAIL")
43 ```
44 </Tab>
45 <Tab value="TypeScript">
42 -```typescript
46 +```typescript twoslash
47 +import { Composio } from '@composio/core';
48 +const composio = new Composio({ apiKey: 'your_api_key' });
49 +// ---cut---
50 const tool = await composio.tools.getRawComposioToolBySlug("GMAIL_SEND_EMAIL");
51 ```
52 </Tab>
@@ -75,7 +82,11 @@ raw_tools = composio.tools.get_raw_composio_tools(
82 ```
83 </Tab>
84 <Tab value="TypeScript">
78 -```typescript
85 +```typescript twoslash
86 +import { Composio } from '@composio/core';
87 +const composio = new Composio({ apiKey: 'your_api_key' });
88 +const userId = 'user_123';
89 +// ---cut---
90 // Fetch with limit for a specific user
91 const limitedTools = await composio.tools.get(userId, {
92 toolkits: ["GITHUB"],
@@ -111,7 +122,11 @@ raw_tools = composio.tools.get_raw_composio_tools(
122 ```
123 </Tab>
124 <Tab value="TypeScript">
114 -```typescript
125 +```typescript twoslash
126 +import { Composio } from '@composio/core';
127 +const composio = new Composio({ apiKey: 'your_api_key' });
128 +const userId = 'user_123';
129 +// ---cut---
130 // Fetch specific tools by name
131 const specificTools = await composio.tools.get(userId, {
132 tools: ["GITHUB_LIST_STARGAZERS", "GITHUB_STAR_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER"]
@@ -141,7 +156,11 @@ tools = composio.tools.get(
156 ```
157 </Tab>
158 <Tab value="TypeScript">
144 -```typescript
159 +```typescript twoslash
160 +import { Composio } from '@composio/core';
161 +const composio = new Composio({ apiKey: 'your_api_key' });
162 +const userId = 'user_123';
163 +// ---cut---
164 // Filter by OAuth scopes (single toolkit only)
165 const scopedTools = await composio.tools.get(userId, {
166 toolkits: ["GITHUB"],
@@ -184,7 +203,11 @@ raw_tools = composio.tools.get_raw_composio_tools(
203 ```
204 </Tab>
205 <Tab value="TypeScript">
187 -```typescript
206 +```typescript twoslash
207 +import { Composio } from '@composio/core';
208 +const composio = new Composio({ apiKey: 'your_api_key' });
209 +const userId = 'user_123';
210 +// ---cut---
211 // Search tools semantically
212 const searchResults = await composio.tools.get(userId, {
213 search: "create google calendar event"
fumadocs/content/docs/quickstart.mdx
+4 -2
@@ -108,7 +108,8 @@ Composio supports multiple LLM providers. Here's how to use Composio with some o
108 npm i @composio/core @composio/anthropic @anthropic-ai/sdk
109 ```
110
111 - ```typescript
111 + ```typescript twoslash
112 + // @noErrors
113 import { Composio } from "@composio/core";
114 import { AnthropicProvider } from "@composio/anthropic";
115 import Anthropic from "@anthropic-ai/sdk";
@@ -174,7 +175,8 @@ Composio supports multiple LLM providers. Here's how to use Composio with some o
175 npm i @composio/core @composio/vercel ai @ai-sdk/openai
176 ```
177
177 - ```typescript
178 + ```typescript twoslash
179 + // @noErrors
180 import { Composio } from "@composio/core";
181 import { VercelProvider } from "@composio/vercel";
182 import { generateText } from "ai";