Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
TypeScript agentic-aiagentsaiai-agentsaiagentsdeveloper-toolsfunction-callinggpt-4javascriptjsllmllmopsmcppythonremote-mcp-serverssetypescript
feat(fumadocs): add Twoslash type checking to core docs pages
Sushmithamalleshd22f7ace0b33
diff --git a/fumadocs/content/docs/authenticating-tools.mdx b/fumadocs/content/docs/authenticating-tools.mdxindex c2910bb14..eb6c232a5 100644--- a/fumadocs/content/docs/authenticating-tools.mdx+++ b/fumadocs/content/docs/authenticating-tools.mdx@@ -129,10 +129,10 @@ print(f"Visit: {redirect_url} to authenticate your account")```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslashimport { Composio } from '@composio/core';-const composio = new Composio({apiKey: "your_api_key"});+const composio = new Composio({ apiKey: "your_api_key" });// Use the "AUTH CONFIG ID" from your dashboardconst authConfigId = 'your_auth_config_id';@@ -202,10 +202,10 @@ print(f"Connection established: {connected_account.id}")```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslashimport { Composio } from '@composio/core';-const composio = new Composio({apiKey: "YOUR_COMPOSIO_API_KEY"});+const composio = new Composio({ apiKey: "YOUR_COMPOSIO_API_KEY" });// Use the "AUTH CONFIG ID" from your dashboardconst authConfigId = 'your_auth_config_id';@@ -249,8 +249,12 @@ connection_request = composio.connected_accounts.initiate(```</Tab><Tab value="TypeScript">-```typescript-import { AuthScheme } from '@composio/core';+```typescript twoslash+import { Composio, AuthScheme } from '@composio/core';+const composio = new Composio({ apiKey: "your_api_key" });+const userId = 'user_123';+const authConfigId = 'your_auth_config_id';+// ---cut---// For Zendesk - include subdomainconst connRequest = await composio.connectedAccounts.initiate(userId, authConfigId, {config: AuthScheme.OAuth2({@@ -296,7 +300,7 @@ print(f"Connection established: {connection_request.id}")```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslashimport { Composio, AuthScheme } from '@composio/core';const composio = new Composio({ apiKey: 'your_api_key' });@@ -346,7 +350,7 @@ print(f"Required fields: {auth_config.expected_input_fields}")```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslashimport { Composio } from '@composio/core';const composio = new Composio({ apiKey: 'your_api_key' });@@ -416,7 +420,11 @@ print(connected_account.id)```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+const connectionRequest = await composio.connectedAccounts.initiate('user_123', 'auth_config_id', {});+// ---cut---// Wait for the connection to be establishedconst connectedAccount = await connectionRequest.waitForConnection();console.log(connectedAccount.id);@@ -458,7 +466,10 @@ for connection in filtered_connections.items:```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+// ---cut---// Get a specific connected account by its nanoidconst connectedAccount = await composio.connectedAccounts.get('your_connected_account_id');console.log(`Status: ${connectedAccount.status}`);diff --git a/fumadocs/content/docs/connected-accounts.mdx b/fumadocs/content/docs/connected-accounts.mdxindex b18b7a28f..e7f50426c 100644--- a/fumadocs/content/docs/connected-accounts.mdx+++ b/fumadocs/content/docs/connected-accounts.mdx@@ -28,7 +28,11 @@ active_accounts = composio.connected_accounts.list(```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+const userId = 'user_123';+// ---cut---// List all accounts for a userconst accounts = await composio.connectedAccounts.list({userIds: [userId]@@ -57,7 +61,11 @@ print(f"Toolkit: {account.toolkit.slug}")```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+const connectedAccountId = 'ca_123';+// ---cut---const account = await composio.connectedAccounts.get(connectedAccountId);console.log('Status:', account.status);@@ -84,7 +92,11 @@ if account.state:```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+const account = await composio.connectedAccounts.get('ca_123');+// ---cut---// Get the connected account's authentication stateif (account.state) {// The state contains the auth scheme and credentials@@ -122,7 +134,11 @@ except Exception as e:```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+const connectedAccountId = 'ca_123';+// ---cut---try {const refreshed = await composio.connectedAccounts.refresh(connectedAccountId);console.log('Redirect URL:', refreshed.redirect_url);@@ -155,7 +171,11 @@ print(f"Account enabled status: {enabled.success}")```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+const connectedAccountId = 'ca_123';+// ---cut---// Disable an accountconst disabled = await composio.connectedAccounts.disable(connectedAccountId);console.log('Account disabled status:', disabled.success);@@ -184,7 +204,11 @@ print("Account deleted successfully")```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+const connectedAccountId = 'ca_123';+// ---cut---// Delete a connected accountawait composio.connectedAccounts.delete(connectedAccountId);console.log('Account deleted successfully');@@ -234,7 +258,12 @@ except Exception as e:```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+const userId = 'user_123';+const authConfigId = 'ac_123';+// ---cut---// First accounttry {const firstAccount = await composio.connectedAccounts.initiate(@@ -286,7 +315,12 @@ print(f"Tool executed: {result}")```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+const userId = 'user_123';+const connectedAccountId = 'ca_123';+// ---cut---// Execute tool with a specific connected accountconst result = await composio.tools.execute('GMAIL_GET_PROFILE', {userId: userId,diff --git a/fumadocs/content/docs/custom-auth-configs.mdx b/fumadocs/content/docs/custom-auth-configs.mdxindex 36b9b3af7..7b0158190 100644--- a/fumadocs/content/docs/custom-auth-configs.mdx+++ b/fumadocs/content/docs/custom-auth-configs.mdx@@ -101,7 +101,11 @@ print(connected_account)```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+const userId = 'user_123';+// ---cut---const connReq = await composio.connectedAccounts.initiate(userId, "ac_1234");console.log(connReq.redirectUrl);@@ -175,7 +179,8 @@ def authorize_app(toolkit: str):```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+// @noErrorsimport type { NextApiRequest, NextApiResponse } from 'next';export default function handler(req: NextApiRequest, res: NextApiResponse) {diff --git a/fumadocs/content/docs/custom-auth-params.mdx b/fumadocs/content/docs/custom-auth-params.mdxindex 6f1ac07d5..69b8f009b 100644--- a/fumadocs/content/docs/custom-auth-params.mdx+++ b/fumadocs/content/docs/custom-auth-params.mdx@@ -19,7 +19,7 @@ composio = Composio()```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslashimport { Composio } from "@composio/core";const composio = new Composio({@@ -64,8 +64,12 @@ def add_custom_auth(```</Tab><Tab value="TypeScript">-```typescript-const authModifier = (toolSlug: string, toolkitSlug: string, params: any) => {+```typescript twoslash+const authModifier = ({ toolSlug, toolkitSlug, params }: {+ toolSlug: string;+ toolkitSlug: string;+ params: any;+}) => {// Add authentication parameters for specific toolkitsif (toolkitSlug === "NOTION") {if (!params.customAuthParams) {@@ -112,7 +116,11 @@ print(result)```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+const authModifier = ({ params }: { toolSlug: string; toolkitSlug: string; params: any }) => params;+// ---cut---const result = await composio.tools.execute("NOTION_GET_DATABASE_ITEMS",{diff --git a/fumadocs/content/docs/custom-tools.mdx b/fumadocs/content/docs/custom-tools.mdxindex fcb9dbcca..c2004771b 100644--- a/fumadocs/content/docs/custom-tools.mdx+++ b/fumadocs/content/docs/custom-tools.mdx@@ -44,7 +44,12 @@ def add_two_numbers(request: AddTwoNumbersInput) -> int:```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+// @noErrors+import { Composio } from '@composio/core';+import { z } from 'zod';+const composio = new Composio({ apiKey: 'your_api_key' });+// ---cut---const tool = await composio.tools.createCustomTool({slug: 'CALCULATE_SQUARE',name: 'Calculate Square',@@ -108,7 +113,12 @@ def get_issue_info(```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+// @noErrors+import { Composio } from '@composio/core';+import { z } from 'zod';+const composio = new Composio({ apiKey: 'your_api_key' });+// ---cut---const tool = await composio.tools.createCustomTool({slug: 'GITHUB_STAR_COMPOSIOHQ_REPOSITORY',name: 'Github star composio repositories',@@ -175,7 +185,12 @@ def get_issue_info_direct(```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+// @noErrors+import { Composio } from '@composio/core';+import { z } from 'zod';+const composio = new Composio({ apiKey: 'your_api_key' });+// ---cut---const tool = await composio.tools.createCustomTool({slug: 'GITHUB_DIRECT_API',name: 'Direct GitHub API Call',@@ -242,7 +257,12 @@ def get_issue_info(```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+// @noErrors+import { Composio } from '@composio/core';+import { z } from 'zod';+const composio = new Composio({ apiKey: 'your_api_key' });+// ---cut---const tool = await composio.tools.createCustomTool({slug: 'GITHUB_SEARCH_REPOSITORIES',name: 'Search GitHub Repositories',@@ -304,7 +324,10 @@ response = composio.tools.execute(```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+// ---cut---const result = await composio.tools.execute('TOOL_SLUG', {arguments: {// Tool input parametersdiff --git a/fumadocs/content/docs/executing-tools.mdx b/fumadocs/content/docs/executing-tools.mdxindex 4c1b3aac5..8478aa3c2 100644--- a/fumadocs/content/docs/executing-tools.mdx+++ b/fumadocs/content/docs/executing-tools.mdx@@ -55,7 +55,8 @@ print(result)```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+// @noErrorsimport { Composio } from '@composio/core';import { AnthropicProvider } from '@composio/anthropic';import { Anthropic } from '@anthropic-ai/sdk';@@ -140,7 +141,8 @@ asyncio.run(main())```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+// @noErrorsimport { Composio } from '@composio/core';import { generateText } from 'ai';import { anthropic } from '@ai-sdk/anthropic';@@ -212,7 +214,7 @@ print(result)```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslashimport { Composio } from "@composio/core";const userId = "user-k7334";@@ -268,7 +270,10 @@ print(response)```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+// ---cut---// Send a proxy request to the endpointconst { data } = await composio.tools.proxyExecute({endpoint:'/repos/composiohq/composio/issues/1',@@ -314,7 +319,11 @@ print(result) # Print Google Drive file details```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+import path from 'path';+const composio = new Composio({ apiKey: 'your_api_key' });+// ---cut---// Upload a local file to Google Driveconst result = await composio.tools.execute('GOOGLEDRIVE_UPLOAD_FILE', {userId: 'user-4235***',@@ -351,7 +360,10 @@ print(result)```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+// ---cut---// Download a file from Google Driveconst result = await composio.tools.execute('GOOGLEDRIVE_DOWNLOAD_FILE', {userId: 'user-1235***',@@ -370,7 +382,10 @@ console.log(result);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`:-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+import path from 'path';+// ---cut---const composio = new Composio({apiKey: process.env.COMPOSIO_API_KEY,autoUploadDownloadFiles: false@@ -378,7 +393,7 @@ const composio = new Composio({// Now you need to handle files manually using composio.files APIconst fileData = await composio.files.upload({- filePath: path.join(__dirname, 'document.pdf'),+ file: path.join(__dirname, 'document.pdf'),toolSlug: 'GOOGLEDRIVE_UPLOAD_FILE',toolkitSlug: 'googledrive'});diff --git a/fumadocs/content/docs/fetching-tools.mdx b/fumadocs/content/docs/fetching-tools.mdxindex 257ed4f43..457546758 100644--- a/fumadocs/content/docs/fetching-tools.mdx+++ b/fumadocs/content/docs/fetching-tools.mdx@@ -18,7 +18,11 @@ tools = composio.tools.get(```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+const userId = 'user_123';+// ---cut---const tools = await composio.tools.get(userId, {toolkits: ["GITHUB"]});@@ -39,7 +43,10 @@ tool = composio.tools.get_raw_composio_tool_by_slug("GMAIL_SEND_EMAIL")```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+// ---cut---const tool = await composio.tools.getRawComposioToolBySlug("GMAIL_SEND_EMAIL");```</Tab>@@ -75,7 +82,11 @@ raw_tools = composio.tools.get_raw_composio_tools(```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+const userId = 'user_123';+// ---cut---// Fetch with limit for a specific userconst limitedTools = await composio.tools.get(userId, {toolkits: ["GITHUB"],@@ -111,7 +122,11 @@ raw_tools = composio.tools.get_raw_composio_tools(```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+const userId = 'user_123';+// ---cut---// Fetch specific tools by nameconst specificTools = await composio.tools.get(userId, {tools: ["GITHUB_LIST_STARGAZERS", "GITHUB_STAR_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER"]@@ -141,7 +156,11 @@ tools = composio.tools.get(```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+const userId = 'user_123';+// ---cut---// Filter by OAuth scopes (single toolkit only)const scopedTools = await composio.tools.get(userId, {toolkits: ["GITHUB"],@@ -184,7 +203,11 @@ raw_tools = composio.tools.get_raw_composio_tools(```</Tab><Tab value="TypeScript">-```typescript+```typescript twoslash+import { Composio } from '@composio/core';+const composio = new Composio({ apiKey: 'your_api_key' });+const userId = 'user_123';+// ---cut---// Search tools semanticallyconst searchResults = await composio.tools.get(userId, {search: "create google calendar event"diff --git a/fumadocs/content/docs/quickstart.mdx b/fumadocs/content/docs/quickstart.mdxindex e68be7535..c2b845d75 100644--- a/fumadocs/content/docs/quickstart.mdx+++ b/fumadocs/content/docs/quickstart.mdx@@ -108,7 +108,8 @@ Composio supports multiple LLM providers. Here's how to use Composio with some onpm i @composio/core @composio/anthropic @anthropic-ai/sdk```- ```typescript+ ```typescript twoslash+ // @noErrorsimport { Composio } from "@composio/core";import { AnthropicProvider } from "@composio/anthropic";import Anthropic from "@anthropic-ai/sdk";@@ -174,7 +175,8 @@ Composio supports multiple LLM providers. Here's how to use Composio with some onpm i @composio/core @composio/vercel ai @ai-sdk/openai```- ```typescript+ ```typescript twoslash+ // @noErrorsimport { Composio } from "@composio/core";import { VercelProvider } from "@composio/vercel";import { generateText } from "ai";