Skip to content

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(docs): add MCP to SDK reference and move generators to docs/

Sushmithamallesh98dec584c468
diff --git a/.github/workflows/generate-sdk-docs.yml b/.github/workflows/generate-sdk-docs.yml
index 4ab3673e5..cb45209bb 100644
--- a/.github/workflows/generate-sdk-docs.yml
+++ b/.github/workflows/generate-sdk-docs.yml
@@ -24,7 +24,9 @@ jobs:
- run: pnpm install --frozen-lockfile
- - run: pnpm --filter @composio/core generate:docs
+ - name: Generate TypeScript SDK docs
+ working-directory: docs
+ run: bun run generate:sdk-reference:ts
- name: Create Pull Request
uses: peter-evans/create-pull-request@98357b18bf14b5342f975ff684046ec3b2a07725 # v8.0.0
@@ -49,7 +51,9 @@ jobs:
- name: Setup Python with UV
uses: ./.github/actions/setup-python-uv
- - run: cd python && uv run --with griffe python scripts/generate-docs.py
+ - name: Generate Python SDK docs
+ working-directory: docs
+ run: uv run --with griffe python scripts/sdk-reference/generate-python.py
- name: Create Pull Request
uses: peter-evans/create-pull-request@98357b18bf14b5342f975ff684046ec3b2a07725 # v8.0.0
diff --git a/docs/CLAUDE.md b/docs/CLAUDE.md
index d3465fce2..8f2d34197 100644
--- a/docs/CLAUDE.md
+++ b/docs/CLAUDE.md
@@ -21,15 +21,18 @@ Auto-generated SDK documentation from source code.
### TypeScript SDK
- **Source**: `ts/packages/core/src/models/*.ts` (JSDoc comments)
-- **Generator**: `ts/packages/core/scripts/generate-docs.ts`
+- **Generator**: `scripts/sdk-reference/generate-typescript.ts`
- **Output**: `content/reference/sdk-reference/typescript/`
-- **Regenerate**: `pnpm --filter @composio/core generate:docs`
+- **Regenerate**: `bun run generate:sdk-reference:ts`
### Python SDK
- **Source**: `python/composio/**/*.py` (docstrings)
-- **Generator**: `python/scripts/generate-docs.py` (uses griffe)
+- **Generator**: `scripts/sdk-reference/generate-python.py` (uses griffe)
- **Output**: `content/reference/sdk-reference/python/`
-- **Regenerate**: `cd python && uv run --with griffe python scripts/generate-docs.py`
+- **Regenerate**: `bun run generate:sdk-reference:py`
+
+### Both SDKs
+- **Regenerate all**: `bun run generate:sdk-reference`
CI auto-generates on changes to `ts/packages/core/src/**` or `python/composio/**` via `.github/workflows/generate-sdk-docs.yml`.
diff --git a/docs/content/reference/sdk-reference/python/composio.mdx b/docs/content/reference/sdk-reference/python/composio.mdx
index 4b40faba3..3c4934703 100644
--- a/docs/content/reference/sdk-reference/python/composio.mdx
+++ b/docs/content/reference/sdk-reference/python/composio.mdx
@@ -12,5 +12,6 @@ description: Composio SDK for Python.
| [`triggers`](/reference/sdk-reference/python/triggers) | `Triggers` |
| [`auth_configs`](/reference/sdk-reference/python/auth-configs) | `AuthConfigs` |
| [`connected_accounts`](/reference/sdk-reference/python/connected-accounts) | `ConnectedAccounts` |
+| [`mcp`](/reference/sdk-reference/python/mcp) | `MCP` |
[View source](https://github.com/composiohq/composio/blob/next/python/composio/sdk.py#L53)
diff --git a/docs/content/reference/sdk-reference/python/index.mdx b/docs/content/reference/sdk-reference/python/index.mdx
index ac1a95500..2aa6f8405 100644
--- a/docs/content/reference/sdk-reference/python/index.mdx
+++ b/docs/content/reference/sdk-reference/python/index.mdx
@@ -29,6 +29,7 @@ uv add composio
| [`Triggers`](/reference/sdk-reference/python/triggers) | Triggers (instance) class |
| [`ConnectedAccounts`](/reference/sdk-reference/python/connected-accounts) | Manage connected accounts. This class is used to manage connected accounts in t... |
| [`AuthConfigs`](/reference/sdk-reference/python/auth-configs) | Manage authentication configurations. |
+| [`MCP`](/reference/sdk-reference/python/mcp) | MCP (Model Control Protocol) class. Provides enhanced MCP server operations Thi... |
## Quick Start
diff --git a/docs/content/reference/sdk-reference/python/mcp.mdx b/docs/content/reference/sdk-reference/python/mcp.mdx
new file mode 100644
index 000000000..8da79747c
--- /dev/null
+++ b/docs/content/reference/sdk-reference/python/mcp.mdx
@@ -0,0 +1,250 @@
+---
+title: MCP
+description: MCP (Model Control Protocol) class. Provides enhanced MCP server operations This matches the TypeScript ExperimentalMCP class functionality.
+---
+
+## Methods
+
+### create()
+
+Create a new MCP server configuration with specified toolkits and authentication settings.
+
+```python
+def create(name: str, toolkits: List[Union[ConfigToolkit, str]], manually_manage_connections: bool = ..., allowed_tools: List[str | None] = ...) -> MCPCreateResponse
+```
+
+**Parameters**
+
+| Name | Type |
+|------|------|
+| `name` | `str` |
+| `toolkits` | `List[Union[ConfigToolkit, str]]` |
+| `manually_manage_connections?` | `bool` |
+| `allowed_tools?` | `List[str \| None]` |
+
+**Returns**
+
+`MCPCreateResponse` — Created server details with generate method
+
+**Example**
+
+```python
+>>> # Using toolkit configuration objects with auth
+ >>> server = composio.experimental.mcp.create(
+ ... 'personal-mcp-server',
+ ... toolkits=[
+ ... {
+ ... 'toolkit': 'github',
+ ... 'auth_config_id': 'ac_xyz',
+ ... },
+ ... {
+ ... 'toolkit': 'slack',
+ ... 'auth_config_id': 'ac_abc',
+ ... },
+ ... ],
+ ... allowed_tools=['GITHUB_CREATE_ISSUE', 'GITHUB_LIST_REPOS', 'SLACK_SEND_MESSAGE'],
+ ... manually_manage_connections=False
+ ... )
+ >>>
+ >>> # Using simple toolkit names (most common usage)
+ >>> server = composio.experimental.mcp.create(
+ ... 'simple-mcp-server',
+ ... toolkits=['composio_search', 'text_to_pdf'],
+ ... allowed_tools=['COMPOSIO_SEARCH_DUCK_DUCK_GO_SEARCH', 'TEXT_TO_PDF_CONVERT_TEXT_TO_PDF']
+ ... )
+ >>>
+ >>> # Using all tools from toolkits (default behavior)
+ >>> server = composio.experimental.mcp.create(
+ ... 'all-tools-server',
+ ... toolkits=['composio_search', 'text_to_pdf']
+ ... # allowed_tools=None means all tools from these toolkits
+ ... )
+ >>>
+ >>> # Get server instance for a user
+ >>> mcp = server.generate('user_12345')
+```
+
+---
+
+### list()
+
+List MCP servers with optional filtering and pagination.
+
+```python
+def list(page_no: int | None = ..., limit: int | None = ..., toolkits: str | None = ..., auth_config_ids: str | None = ..., name: str | None = ..., order_by: Literal['created_at', 'updated_at' | None] = ..., order_direction: Literal['asc', 'desc' | None] = ...) -> MCPListResponse
+```
+
+**Parameters**
+
+| Name | Type |
+|------|------|
+| `page_no?` | `int \| None` |
+| `limit?` | `int \| None` |
+| `toolkits?` | `str \| None` |
+| `auth_config_ids?` | `str \| None` |
+| `name?` | `str \| None` |
+| `order_by?` | `Literal['created_at', 'updated_at' \| None]` |
+| `order_direction?` | `Literal['asc', 'desc' \| None]` |
+
+**Returns**
+
+`MCPListResponse` — Paginated list of MCP servers
+
+**Example**
+
+```python
+>>> # List all servers
+ >>> all_servers = composio.experimental.mcp.list()
+ >>>
+ >>> # List with pagination
+ >>> paged_servers = composio.experimental.mcp.list(page_no=2, limit=5)
+ >>>
+ >>> # Filter by toolkit
+ >>> github_servers = composio.experimental.mcp.list(toolkits='github', name='personal')
+```
+
+---
+
+### get()
+
+Retrieve detailed information about a specific MCP server/config.
+
+```python
+def get(server_id: str)
+```
+
+**Parameters**
+
+| Name | Type |
+|------|------|
+| `server_id` | `str` |
+
+**Example**
+
+```python
+>>> server = composio.experimental.mcp.get('mcp_12345')
+ >>>
+ >>> print(server['name']) # "My Personal MCP Server"
+ >>> print(server['allowed_tools']) # ["GITHUB_CREATE_ISSUE", "SLACK_SEND_MESSAGE"]
+ >>> print(server['toolkits']) # ["github", "slack"]
+ >>> print(server['server_instance_count']) # 3
+```
+
+---
+
+### update()
+
+Update an existing MCP server configuration.
+
+```python
+def update(server_id: str, name: str | None = ..., toolkits: List[Union[ConfigToolkit, str | None]] = ..., manually_manage_connections: bool | None = ..., allowed_tools: List[str | None] = ...)
+```
+
+**Parameters**
+
+| Name | Type |
+|------|------|
+| `server_id` | `str` |
+| `name?` | `str \| None` |
+| `toolkits?` | `List[Union[ConfigToolkit, str \| None]]` |
+| `manually_manage_connections?` | `bool \| None` |
+| `allowed_tools?` | `List[str \| None]` |
+
+**Example**
+
+```python
+>>> # Update server name only
+ >>> updated_server = composio.experimental.mcp.update(
+ ... 'mcp_12345',
+ ... name='My Updated MCP Server'
+ ... )
+ >>>
+ >>> # Update toolkits and tools
+ >>> server_with_new_tools = composio.experimental.mcp.update(
+ ... 'mcp_12345',
+ ... toolkits=['github', 'slack'],
+ ... allowed_tools=['GITHUB_CREATE_ISSUE', 'SLACK_SEND_MESSAGE']
+ ... )
+ >>>
+ >>> # Update with auth configs
+ >>> server_with_auth = composio.experimental.mcp.update(
+ ... 'mcp_12345',
+ ... toolkits=[
+ ... {'toolkit': 'github', 'auth_config_id': 'auth_abc123'},
+ ... {'toolkit': 'slack', 'auth_config_id': 'auth_def456'}
+ ... ],
+ ... allowed_tools=['GITHUB_CREATE_ISSUE', 'SLACK_SEND_MESSAGE'],
+ ... manually_manage_connections=False
+ ... )
+```
+
+---
+
+### delete()
+
+Permanently delete an MCP server configuration.
+
+```python
+def delete(server_id: str) -> Dict[str, Any]
+```
+
+**Parameters**
+
+| Name | Type |
+|------|------|
+| `server_id` | `str` |
+
+**Returns**
+
+`Dict[str, Any]` — Deletion result
+
+**Example**
+
+```python
+>>> # Delete a server
+ >>> result = composio.experimental.mcp.delete('mcp_12345')
+ >>>
+ >>> if result['deleted']:
+ ... print(f"Server {result['id']} has been successfully deleted")
+ >>> else:
+ ... print(f"Failed to delete server {result['id']}")
+```
+
+---
+
+### generate()
+
+Get server URLs for an existing MCP server. This matches the TypeScript implementation exactly.
+
+```python
+def generate(user_id: str, mcp_config_id: str, manually_manage_connections: bool | None = ...) -> MCPServerInstance
+```
+
+**Parameters**
+
+| Name | Type |
+|------|------|
+| `user_id` | `str` |
+| `mcp_config_id` | `str` |
+| `manually_manage_connections?` | `bool \| None` |
+
+**Returns**
+
+`MCPServerInstance` — MCP server instance
+
+**Example**
+
+```python
+>>> mcp = composio.experimental.mcp.generate(
+ ... 'user_12345',
+ ... 'mcp_67890',
+ ... manually_manage_connections=False
+ ... )
+ >>>
+ >>> print(mcp['url']) # Server URL for the user
+ >>> print(mcp['allowed_tools']) # Available tools
+```
+
+---
+
+[View source](https://github.com/composiohq/composio/blob/next/python/composio/core/models/mcp.py#L88)
diff --git a/docs/content/reference/sdk-reference/python/meta.json b/docs/content/reference/sdk-reference/python/meta.json
index 502bdbc49..afc5ea0c3 100644
--- a/docs/content/reference/sdk-reference/python/meta.json
+++ b/docs/content/reference/sdk-reference/python/meta.json
@@ -6,6 +6,7 @@
"toolkits",
"triggers",
"connected-accounts",
- "auth-configs"
+ "auth-configs",
+ "mcp"
]
}
\ No newline at end of file
diff --git a/docs/content/reference/sdk-reference/typescript/index.mdx b/docs/content/reference/sdk-reference/typescript/index.mdx
index b52a31549..bb1a60701 100644
--- a/docs/content/reference/sdk-reference/typescript/index.mdx
+++ b/docs/content/reference/sdk-reference/typescript/index.mdx
@@ -35,6 +35,7 @@ bun add @composio/core
| [`Composio`](/reference/sdk-reference/typescript/composio) | This is the core class for Composio. |
| [`AuthConfigs`](/reference/sdk-reference/typescript/auth-configs) | AuthConfigs class |
| [`ConnectedAccounts`](/reference/sdk-reference/typescript/connected-accounts) | ConnectedAccounts class |
+| [`MCP`](/reference/sdk-reference/typescript/mcp) | MCP (Model Control Protocol) class |
| [`Toolkits`](/reference/sdk-reference/typescript/toolkits) | Toolkits class |
| [`Tools`](/reference/sdk-reference/typescript/tools) | This class is used to manage tools in the Composio SDK. |
| [`Triggers`](/reference/sdk-reference/typescript/triggers) | Trigger (Instance) class |
diff --git a/docs/content/reference/sdk-reference/typescript/mcp.mdx b/docs/content/reference/sdk-reference/typescript/mcp.mdx
new file mode 100644
index 000000000..6efd5265d
--- /dev/null
+++ b/docs/content/reference/sdk-reference/typescript/mcp.mdx
@@ -0,0 +1,290 @@
+---
+title: MCP
+description: MCP (Model Control Protocol) class Handles MCP server operations. When `config.experimental.mcp` is enabled, this class augments the features of `composio.mcp`.
+---
+
+## Usage
+
+Access this class through the `composio.mcp` property:
+
+```typescript
+const composio = new Composio({ apiKey: 'your-api-key' });
+const result = await composio.mcp.list();
+```
+
+## Properties
+
+| Name | Type |
+|------|------|
+| `client` | `Composio` |
+
+## Methods
+
+### create()
+
+Create a new MCP configuration.
+
+```typescript
+async create(name: string, mcpConfig: object): Promise<MCPConfigCreateResponse>
+```
+
+**Parameters**
+
+| Name | Type |
+|------|------|
+| `name` | `string` |
+| `mcpConfig` | `object` |
+
+**Returns**
+
+`Promise<MCPConfigCreateResponse>` — Created server details with instance getter
+
+**Example**
+
+```typescript
+const server = await composio.mcpConfig.create("personal-mcp-server", {
+ toolkits: ["github", "slack"],
+ allowedTools: ["GMAIL_FETCH_EMAILS", "SLACK_SEND_MESSAGE"],
+ manuallyManageConnections: false
+ }
+});
+
+const server = await composio.mcpConfig.create("personal-mcp-server", {
+ toolkits: [{ toolkit: "gmail", authConfigId: "ac_243434343" }],
+ allowedTools: ["GMAIL_FETCH_EMAILS"],
+ manuallyManageConnections: false
+ }
+});
+```
+
+---
+
+### delete()
+
+Delete an MCP server configuration permanently
+
+```typescript
+async delete(serverId: string): Promise<{ deleted: boolean; id: string }>
+```
+
+**Parameters**
+
+| Name | Type | Description |
+|------|------|-------------|
+| `serverId` | `string` | The unique identifier of the MCP server to delete |
+
+**Returns**
+
+`Promise<...>` — Confirmation object with server ID and deletion status
+
+**Example**
+
+```typescript
+// Delete an MCP server by ID
+const result = await composio.experimental.mcp.delete("mcp_12345");
+
+if (result.deleted) {
+ console.log(`Server ${result.id} has been successfully deleted`);
+} else {
+ console.log(`Failed to delete server ${result.id}`);
+}
+
+// Example with error handling
+try {
+ const result = await composio.experimental.mcp.delete("mcp_12345");
+ console.log("Deletion successful:", result);
+} catch (error) {
+ console.error("Failed to delete MCP server:", error.message);
+}
+
+// Delete and verify from list
+await composio.experimental.mcp.delete("mcp_12345");
+const servers = await composio.experimental.mcp.list({});
+const serverExists = servers.items.some(server => server.id === "mcp_12345");
+console.log("Server still exists:", serverExists); // Should be false
+```
+
+---
+
+### generate()
+
+Get server URLs for an existing MCP server.
+The response is wrapped according to the provider's specifications.
+
+```typescript
+async generate(userId: string, mcpConfigId: string, options?: { manuallyManageConnections?: boolean }): Promise<...>
+```
+
+**Parameters**
+
+| Name | Type | Description |
+|------|------|-------------|
+| `userId` | `string` | \{string\} external user id from your database for whom you want the server for |
+| `mcpConfigId` | `string` | \{string\} config id of the MCPConfig for which you want to create a server for |
+| `options?` | `object` | \{object\} additional options |
+
+**Returns**
+
+`Promise<...>`
+
+**Example**
+
+```typescript
+import { Composio } from "@composio/code";
+
+const composio = new Composio();
+const mcp = await composio.experimental.mcp.generate("default", "<mcp_config_id>");
+```
+
+---
+
+### get()
+
+Retrieve detailed information about a specific MCP server by its ID
+
+```typescript
+async get(serverId: string): Promise<...>
+```
+
+**Parameters**
+
+| Name | Type | Description |
+|------|------|-------------|
+| `serverId` | `string` | The unique identifier of the MCP server to retrieve |
+
+**Returns**
+
+`Promise<...>` — Complete MCP server details including configuration, tools, and metadata
+
+**Example**
+
+```typescript
+// Get a specific MCP server by ID
+const server = await composio.experimental.mcp.get("mcp_12345");
+
+console.log(server.name); // "My Personal MCP Server"
+console.log(server.allowedTools); // ["GITHUB_CREATE_ISSUE", "SLACK_SEND_MESSAGE"]
+console.log(server.toolkits); // ["github", "slack"]
+console.log(server.serverInstanceCount); // 3
+
+// Access setup commands for different clients
+console.log(server.commands.claude); // Claude setup command
+console.log(server.commands.cursor); // Cursor setup command
+console.log(server.commands.windsurf); // Windsurf setup command
+
+// Use the MCP URL for direct connections
+const mcpUrl = server.MCPUrl;
+```
+
+---
+
+### list()
+
+List the MCP servers with optional filtering and pagination
+
+```typescript
+async list(options: { authConfigs: string[]; limit: number; name?: string; page: number; toolkits: string[] }): Promise<...>
+```
+
+**Parameters**
+
+| Name | Type | Description |
+|------|------|-------------|
+| `options` | `object` | Filtering and pagination options |
+
+**Returns**
+
+`Promise<...>` — Paginated list of MCP servers with metadata
+
+**Example**
+
+```typescript
+// List all MCP servers
+const allServers = await composio.experimental.mcp.list({});
+
+// List with pagination
+const pagedServers = await composio.experimental.mcp.list({
+ page: 2,
+ limit: 5
+});
+
+// Filter by toolkit
+const githubServers = await composio.experimental.mcp.list({
+ toolkits: ['github', 'slack']
+});
+
+// Filter by name
+const namedServers = await composio.experimental.mcp.list({
+ name: 'personal'
+});
+```
+
+---
+
+### update()
+
+Update an existing MCP server configuration with new settings
+
+```typescript
+async update(serverId: string, config: object): Promise<...>
+```
+
+**Parameters**
+
+| Name | Type | Description |
+|------|------|-------------|
+| `serverId` | `string` | The unique identifier of the MCP server to update |
+| `config` | `object` | Update configuration parameters |
+
+**Returns**
+
+`Promise<...>` — Updated MCP server configuration with all details
+
+**Example**
+
+```typescript
+// Update server name only
+const updatedServer = await composio.experimental.mcp.update("mcp_12345", {
+ name: "My Updated MCP Server"
+});
+
+// Update toolkits and tools
+const serverWithNewTools = await composio.experimental.mcp.update("mcp_12345", {
+ toolkits: [
+ {
+ toolkit: "github",
+ authConfigId: "auth_abc123",
+ allowedTools: ["GITHUB_CREATE_ISSUE", "GITHUB_LIST_REPOS"]
+ },
+ {
+ toolkit: "slack",
+ authConfigId: "auth_xyz789",
+ allowedTools: ["SLACK_SEND_MESSAGE", "SLACK_LIST_CHANNELS"]
+ }
+ ]
+});
+
+// Update connection management setting
+const serverWithManualAuth = await composio.experimental.mcp.update("mcp_12345", {
+ name: "Manual Auth Server",
+ manuallyManageConnections: true
+});
+
+// Complete update example
+const fullyUpdatedServer = await composio.experimental.mcp.update("mcp_12345", {
+ name: "Production MCP Server",
+ toolkits: [
+ {
+ toolkit: "gmail",
+ authConfigId: "auth_gmail_prod",
+ }
+ ],
+ allowedTools: ["GMAIL_SEND_EMAIL", "GMAIL_FETCH_EMAILS"]
+ manuallyManageConnections: false
+});
+
+console.log("Updated server:", fullyUpdatedServer.name);
+console.log("New tools:", fullyUpdatedServer.allowedTools);
+```
+
+---
diff --git a/docs/content/reference/sdk-reference/typescript/meta.json b/docs/content/reference/sdk-reference/typescript/meta.json
index 89c191256..0ba43a906 100644
--- a/docs/content/reference/sdk-reference/typescript/meta.json
+++ b/docs/content/reference/sdk-reference/typescript/meta.json
@@ -4,6 +4,7 @@
"composio",
"auth-configs",
"connected-accounts",
+ "mcp",
"toolkits",
"tools",
"triggers"
diff --git a/docs/package.json b/docs/package.json
index aecec9f9d..86780066f 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -10,7 +10,10 @@
"postinstall": "fumadocs-mdx",
"lint": "eslint",
"lint:links": "bun scripts/validate-links.ts",
- "generate:toolkits": "bun scripts/generate-toolkits.ts"
+ "generate:toolkits": "bun scripts/generate-toolkits.ts",
+ "generate:sdk-reference:ts": "bun scripts/sdk-reference/generate-typescript.ts",
+ "generate:sdk-reference:py": "uv run --with griffe python scripts/sdk-reference/generate-python.py",
+ "generate:sdk-reference": "bun run generate:sdk-reference:ts && bun run generate:sdk-reference:py"
},
"dependencies": {
"@radix-ui/react-tabs": "^1.1.13",
@@ -30,6 +33,7 @@
"tailwind-merge": "^3.4.0"
},
"devDependencies": {
+ "typedoc": "^0.28.5",
"@ai-sdk/anthropic": "^3.0.11",
"@ai-sdk/mcp": "^1.0.6",
"@ai-sdk/openai": "^3.0.9",
diff --git a/python/scripts/generate-docs.py b/docs/scripts/sdk-reference/generate-python.py
similarity index 97%
rename from python/scripts/generate-docs.py
rename to docs/scripts/sdk-reference/generate-python.py
index 384f13024..cdf4776c3 100644
--- a/python/scripts/generate-docs.py
+++ b/docs/scripts/sdk-reference/generate-python.py
@@ -5,7 +5,7 @@ Python SDK Documentation Generator
Generates MDX documentation from Python source code using griffe.
Output is written to the docs content directory.
-Run: cd python && uv run --with griffe python scripts/generate-docs.py
+Run from docs/: uv run --with griffe python scripts/sdk-reference/generate-python.py
"""
from __future__ import annotations
@@ -22,17 +22,11 @@ except ImportError:
print("Error: griffe not installed. Run: pip install griffe")
raise SystemExit(1)
-# Paths
+# Paths (relative to docs/scripts/sdk-reference/)
SCRIPT_DIR = Path(__file__).parent
-PACKAGE_DIR = SCRIPT_DIR.parent
-OUTPUT_DIR = (
- PACKAGE_DIR.parent
- / "docs"
- / "content"
- / "reference"
- / "sdk-reference"
- / "python"
-)
+DOCS_DIR = SCRIPT_DIR.parent.parent
+PY_SDK_DIR = DOCS_DIR.parent / "python"
+OUTPUT_DIR = DOCS_DIR / "content" / "reference" / "sdk-reference" / "python"
# GitHub base URL for source links
GITHUB_BASE = "https://github.com/composiohq/composio/blob/next/python"
@@ -54,6 +48,7 @@ EXPECTED_CLASSES = {
"Triggers": "triggers",
"ConnectedAccounts": "connected_accounts",
"AuthConfigs": "auth_configs",
+ "MCP": "mcp",
}
# Modules to search for classes
@@ -63,6 +58,7 @@ CLASS_MODULES = [
"core.models.triggers",
"core.models.connected_accounts",
"core.models.auth_configs",
+ "core.models.mcp",
]
@@ -92,7 +88,7 @@ def get_source_link(obj: griffe.Object) -> str | None:
resolved_path = raw_filepath
if not resolved_path:
return None
- rel_path = resolved_path.relative_to(PACKAGE_DIR)
+ rel_path = resolved_path.relative_to(PY_SDK_DIR)
except ValueError:
return None
line = obj.lineno if hasattr(obj, "lineno") and obj.lineno else 1
@@ -459,7 +455,7 @@ def main():
# Load package
print("Loading composio package...")
try:
- package = griffe.load("composio", search_paths=[str(PACKAGE_DIR)])
+ package = griffe.load("composio", search_paths=[str(PY_SDK_DIR)])
except Exception as e:
print(f"Error: {e}")
raise SystemExit(1)
diff --git a/ts/packages/core/scripts/generate-docs.ts b/docs/scripts/sdk-reference/generate-typescript.ts
similarity index 96%
rename from ts/packages/core/scripts/generate-docs.ts
rename to docs/scripts/sdk-reference/generate-typescript.ts
index d732cd063..ea6477ad3 100644
--- a/ts/packages/core/scripts/generate-docs.ts
+++ b/docs/scripts/sdk-reference/generate-typescript.ts
@@ -4,7 +4,7 @@
* Generates MDX documentation from TypeScript source code using TypeDoc.
* Output is written to the docs content directory.
*
- * Run: pnpm --filter @composio/core generate:docs
+ * Run from docs/: bun scripts/sdk-reference/generate-typescript.ts
*/
import { mkdir, writeFile, rm, readdir, readFile } from 'fs/promises';
@@ -12,15 +12,13 @@ import { join, dirname } from 'path';
import { execSync } from 'child_process';
import { fileURLToPath } from 'url';
-// Paths (relative to ts/packages/core)
+// Paths (relative to docs/scripts/sdk-reference/)
const SCRIPT_DIR = dirname(fileURLToPath(import.meta.url));
-const PACKAGE_DIR = join(SCRIPT_DIR, '..');
-const MODELS_DIR = join(PACKAGE_DIR, 'src/models');
-const OUTPUT_DIR = join(
- PACKAGE_DIR,
- '../../../docs/content/reference/sdk-reference/typescript'
-);
-const TEMP_JSON = join(PACKAGE_DIR, '.typedoc-output.json');
+const DOCS_DIR = join(SCRIPT_DIR, '../..');
+const TS_SDK_DIR = join(DOCS_DIR, '../ts/packages/core');
+const MODELS_DIR = join(TS_SDK_DIR, 'src/models');
+const OUTPUT_DIR = join(DOCS_DIR, 'content/reference/sdk-reference/typescript');
+const TEMP_JSON = join(TS_SDK_DIR, '.typedoc-output.json');
// Internal classes that should NOT be documented (accessed via other APIs)
const INTERNAL_CLASSES = new Set([
@@ -28,7 +26,6 @@ const INTERNAL_CLASSES = new Set([
'AuthScheme', // Utility class
'ConnectionRequest', // Utility
'Files', // Not yet stable API
- 'MCP', // Experimental
'ToolRouter', // Experimental
]);
@@ -543,7 +540,11 @@ function generateClassMdx(classDoc: ClassDoc): string {
lines.push(generateMethodMdx(classDoc.constructor));
} else if (!USER_INSTANTIATED_CLASSES.has(classDoc.name)) {
// Show usage hint for non-instantiated classes
- const accessorName = classDoc.name.charAt(0).toLowerCase() + classDoc.name.slice(1);
+ // Handle acronyms (e.g., "MCP" -> "mcp") vs PascalCase (e.g., "AuthConfigs" -> "authConfigs")
+ const accessorName =
+ classDoc.name === classDoc.name.toUpperCase()
+ ? classDoc.name.toLowerCase()
+ : classDoc.name.charAt(0).toLowerCase() + classDoc.name.slice(1);
lines.push('## Usage');
lines.push('');
lines.push(`Access this class through the \`composio.${accessorName}\` property:`);
@@ -722,7 +723,7 @@ async function runTypeDoc(): Promise<TypeDocProject> {
].join(' ');
try {
- execSync(cmd, { stdio: 'pipe', cwd: PACKAGE_DIR });
+ execSync(cmd, { stdio: 'pipe', cwd: TS_SDK_DIR });
} catch (error) {
console.error('TypeDoc failed:', error);
throw error;
@@ -734,7 +735,7 @@ async function runTypeDoc(): Promise<TypeDocProject> {
async function main() {
console.log('Starting TypeScript SDK documentation generation...\n');
- console.log(`Package dir: ${PACKAGE_DIR}`);
+ console.log(`Package dir: ${TS_SDK_DIR}`);
console.log(`Output dir: ${OUTPUT_DIR}\n`);
// Clean output directory
diff --git a/ts/packages/core/package.json b/ts/packages/core/package.json
index d9e4ec8b5..6f184209c 100644
--- a/ts/packages/core/package.json
+++ b/ts/packages/core/package.json
@@ -119,8 +119,7 @@
"clean": "git clean -xdf node_modules",
"build": "bun run --bun tsdown",
"test": "vitest run",
- "typecheck": "tsc --noEmit --skipLibCheck && tsc --noEmit --skipLibCheck -p tsconfig.type-tests.json",
- "generate:docs": "tsx scripts/generate-docs.ts"
+ "typecheck": "tsc --noEmit --skipLibCheck && tsc --noEmit --skipLibCheck -p tsconfig.type-tests.json"
},
"keywords": [],
"author": "",