@devries-cameron20 / composio-1 / commits / 98dec584c
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(docs): add MCP to SDK reference and move generators to docs/

- Add MCP class documentation to TypeScript and Python SDK reference - Move SDK doc generators from SDK dirs to docs/scripts/sdk-reference/ - Update CI workflow to run generators from docs/ - Fix acronym handling in TS generator (MCP -> mcp, not mCP) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Sushmithamallesh committed Jan 26, 2026 at 19:52 UTC 98dec584c468c1e766597682a1e5d64506761b20
13 files changed +588 -36
.github/workflows/generate-sdk-docs.yml
+6 -2
@@ -24,7 +24,9 @@ jobs:
24
25 - run: pnpm install --frozen-lockfile
26
27 - - run: pnpm --filter @composio/core generate:docs
27 + - name: Generate TypeScript SDK docs
28 + working-directory: docs
29 + run: bun run generate:sdk-reference:ts
30
31 - name: Create Pull Request
32 uses: peter-evans/create-pull-request@98357b18bf14b5342f975ff684046ec3b2a07725 # v8.0.0
@@ -49,7 +51,9 @@ jobs:
51 - name: Setup Python with UV
52 uses: ./.github/actions/setup-python-uv
53
52 - - run: cd python && uv run --with griffe python scripts/generate-docs.py
54 + - name: Generate Python SDK docs
55 + working-directory: docs
56 + run: uv run --with griffe python scripts/sdk-reference/generate-python.py
57
58 - name: Create Pull Request
59 uses: peter-evans/create-pull-request@98357b18bf14b5342f975ff684046ec3b2a07725 # v8.0.0
docs/CLAUDE.md
+7 -4
@@ -21,15 +21,18 @@ Auto-generated SDK documentation from source code.
21
22 ### TypeScript SDK
23 - **Source**: `ts/packages/core/src/models/*.ts` (JSDoc comments)
24 -- **Generator**: `ts/packages/core/scripts/generate-docs.ts`
24 +- **Generator**: `scripts/sdk-reference/generate-typescript.ts`
25 - **Output**: `content/reference/sdk-reference/typescript/`
26 -- **Regenerate**: `pnpm --filter @composio/core generate:docs`
26 +- **Regenerate**: `bun run generate:sdk-reference:ts`
27
28 ### Python SDK
29 - **Source**: `python/composio/**/*.py` (docstrings)
30 -- **Generator**: `python/scripts/generate-docs.py` (uses griffe)
30 +- **Generator**: `scripts/sdk-reference/generate-python.py` (uses griffe)
31 - **Output**: `content/reference/sdk-reference/python/`
32 -- **Regenerate**: `cd python && uv run --with griffe python scripts/generate-docs.py`
32 +- **Regenerate**: `bun run generate:sdk-reference:py`
33 +
34 +### Both SDKs
35 +- **Regenerate all**: `bun run generate:sdk-reference`
36
37 CI auto-generates on changes to `ts/packages/core/src/**` or `python/composio/**` via `.github/workflows/generate-sdk-docs.yml`.
38
docs/content/reference/sdk-reference/python/composio.mdx
+1
@@ -12,5 +12,6 @@ description: Composio SDK for Python.
12 | [`triggers`](/reference/sdk-reference/python/triggers) | `Triggers` |
13 | [`auth_configs`](/reference/sdk-reference/python/auth-configs) | `AuthConfigs` |
14 | [`connected_accounts`](/reference/sdk-reference/python/connected-accounts) | `ConnectedAccounts` |
15 +| [`mcp`](/reference/sdk-reference/python/mcp) | `MCP` |
16
17 [View source](https://github.com/composiohq/composio/blob/next/python/composio/sdk.py#L53)
docs/content/reference/sdk-reference/python/index.mdx
+1
@@ -29,6 +29,7 @@ uv add composio
29 | [`Triggers`](/reference/sdk-reference/python/triggers) | Triggers (instance) class |
30 | [`ConnectedAccounts`](/reference/sdk-reference/python/connected-accounts) | Manage connected accounts. This class is used to manage connected accounts in t... |
31 | [`AuthConfigs`](/reference/sdk-reference/python/auth-configs) | Manage authentication configurations. |
32 +| [`MCP`](/reference/sdk-reference/python/mcp) | MCP (Model Control Protocol) class. Provides enhanced MCP server operations Thi... |
33
34 ## Quick Start
35
docs/content/reference/sdk-reference/python/mcp.mdx new
+250
@@ -0,0 +1,250 @@
1 +---
2 +title: MCP
3 +description: MCP (Model Control Protocol) class. Provides enhanced MCP server operations This matches the TypeScript ExperimentalMCP class functionality.
4 +---
5 +
6 +## Methods
7 +
8 +### create()
9 +
10 +Create a new MCP server configuration with specified toolkits and authentication settings.
11 +
12 +```python
13 +def create(name: str, toolkits: List[Union[ConfigToolkit, str]], manually_manage_connections: bool = ..., allowed_tools: List[str | None] = ...) -> MCPCreateResponse
14 +```
15 +
16 +**Parameters**
17 +
18 +| Name | Type |
19 +|------|------|
20 +| `name` | `str` |
21 +| `toolkits` | `List[Union[ConfigToolkit, str]]` |
22 +| `manually_manage_connections?` | `bool` |
23 +| `allowed_tools?` | `List[str \| None]` |
24 +
25 +**Returns**
26 +
27 +`MCPCreateResponse` — Created server details with generate method
28 +
29 +**Example**
30 +
31 +```python
32 +>>> # Using toolkit configuration objects with auth
33 + >>> server = composio.experimental.mcp.create(
34 + ... 'personal-mcp-server',
35 + ... toolkits=[
36 + ... {
37 + ... 'toolkit': 'github',
38 + ... 'auth_config_id': 'ac_xyz',
39 + ... },
40 + ... {
41 + ... 'toolkit': 'slack',
42 + ... 'auth_config_id': 'ac_abc',
43 + ... },
44 + ... ],
45 + ... allowed_tools=['GITHUB_CREATE_ISSUE', 'GITHUB_LIST_REPOS', 'SLACK_SEND_MESSAGE'],
46 + ... manually_manage_connections=False
47 + ... )
48 + >>>
49 + >>> # Using simple toolkit names (most common usage)
50 + >>> server = composio.experimental.mcp.create(
51 + ... 'simple-mcp-server',
52 + ... toolkits=['composio_search', 'text_to_pdf'],
53 + ... allowed_tools=['COMPOSIO_SEARCH_DUCK_DUCK_GO_SEARCH', 'TEXT_TO_PDF_CONVERT_TEXT_TO_PDF']
54 + ... )
55 + >>>
56 + >>> # Using all tools from toolkits (default behavior)
57 + >>> server = composio.experimental.mcp.create(
58 + ... 'all-tools-server',
59 + ... toolkits=['composio_search', 'text_to_pdf']
60 + ... # allowed_tools=None means all tools from these toolkits
61 + ... )
62 + >>>
63 + >>> # Get server instance for a user
64 + >>> mcp = server.generate('user_12345')
65 +```
66 +
67 +---
68 +
69 +### list()
70 +
71 +List MCP servers with optional filtering and pagination.
72 +
73 +```python
74 +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
75 +```
76 +
77 +**Parameters**
78 +
79 +| Name | Type |
80 +|------|------|
81 +| `page_no?` | `int \| None` |
82 +| `limit?` | `int \| None` |
83 +| `toolkits?` | `str \| None` |
84 +| `auth_config_ids?` | `str \| None` |
85 +| `name?` | `str \| None` |
86 +| `order_by?` | `Literal['created_at', 'updated_at' \| None]` |
87 +| `order_direction?` | `Literal['asc', 'desc' \| None]` |
88 +
89 +**Returns**
90 +
91 +`MCPListResponse` — Paginated list of MCP servers
92 +
93 +**Example**
94 +
95 +```python
96 +>>> # List all servers
97 + >>> all_servers = composio.experimental.mcp.list()
98 + >>>
99 + >>> # List with pagination
100 + >>> paged_servers = composio.experimental.mcp.list(page_no=2, limit=5)
101 + >>>
102 + >>> # Filter by toolkit
103 + >>> github_servers = composio.experimental.mcp.list(toolkits='github', name='personal')
104 +```
105 +
106 +---
107 +
108 +### get()
109 +
110 +Retrieve detailed information about a specific MCP server/config.
111 +
112 +```python
113 +def get(server_id: str)
114 +```
115 +
116 +**Parameters**
117 +
118 +| Name | Type |
119 +|------|------|
120 +| `server_id` | `str` |
121 +
122 +**Example**
123 +
124 +```python
125 +>>> server = composio.experimental.mcp.get('mcp_12345')
126 + >>>
127 + >>> print(server['name']) # "My Personal MCP Server"
128 + >>> print(server['allowed_tools']) # ["GITHUB_CREATE_ISSUE", "SLACK_SEND_MESSAGE"]
129 + >>> print(server['toolkits']) # ["github", "slack"]
130 + >>> print(server['server_instance_count']) # 3
131 +```
132 +
133 +---
134 +
135 +### update()
136 +
137 +Update an existing MCP server configuration.
138 +
139 +```python
140 +def update(server_id: str, name: str | None = ..., toolkits: List[Union[ConfigToolkit, str | None]] = ..., manually_manage_connections: bool | None = ..., allowed_tools: List[str | None] = ...)
141 +```
142 +
143 +**Parameters**
144 +
145 +| Name | Type |
146 +|------|------|
147 +| `server_id` | `str` |
148 +| `name?` | `str \| None` |
149 +| `toolkits?` | `List[Union[ConfigToolkit, str \| None]]` |
150 +| `manually_manage_connections?` | `bool \| None` |
151 +| `allowed_tools?` | `List[str \| None]` |
152 +
153 +**Example**
154 +
155 +```python
156 +>>> # Update server name only
157 + >>> updated_server = composio.experimental.mcp.update(
158 + ... 'mcp_12345',
159 + ... name='My Updated MCP Server'
160 + ... )
161 + >>>
162 + >>> # Update toolkits and tools
163 + >>> server_with_new_tools = composio.experimental.mcp.update(
164 + ... 'mcp_12345',
165 + ... toolkits=['github', 'slack'],
166 + ... allowed_tools=['GITHUB_CREATE_ISSUE', 'SLACK_SEND_MESSAGE']
167 + ... )
168 + >>>
169 + >>> # Update with auth configs
170 + >>> server_with_auth = composio.experimental.mcp.update(
171 + ... 'mcp_12345',
172 + ... toolkits=[
173 + ... {'toolkit': 'github', 'auth_config_id': 'auth_abc123'},
174 + ... {'toolkit': 'slack', 'auth_config_id': 'auth_def456'}
175 + ... ],
176 + ... allowed_tools=['GITHUB_CREATE_ISSUE', 'SLACK_SEND_MESSAGE'],
177 + ... manually_manage_connections=False
178 + ... )
179 +```
180 +
181 +---
182 +
183 +### delete()
184 +
185 +Permanently delete an MCP server configuration.
186 +
187 +```python
188 +def delete(server_id: str) -> Dict[str, Any]
189 +```
190 +
191 +**Parameters**
192 +
193 +| Name | Type |
194 +|------|------|
195 +| `server_id` | `str` |
196 +
197 +**Returns**
198 +
199 +`Dict[str, Any]` — Deletion result
200 +
201 +**Example**
202 +
203 +```python
204 +>>> # Delete a server
205 + >>> result = composio.experimental.mcp.delete('mcp_12345')
206 + >>>
207 + >>> if result['deleted']:
208 + ... print(f"Server {result['id']} has been successfully deleted")
209 + >>> else:
210 + ... print(f"Failed to delete server {result['id']}")
211 +```
212 +
213 +---
214 +
215 +### generate()
216 +
217 +Get server URLs for an existing MCP server. This matches the TypeScript implementation exactly.
218 +
219 +```python
220 +def generate(user_id: str, mcp_config_id: str, manually_manage_connections: bool | None = ...) -> MCPServerInstance
221 +```
222 +
223 +**Parameters**
224 +
225 +| Name | Type |
226 +|------|------|
227 +| `user_id` | `str` |
228 +| `mcp_config_id` | `str` |
229 +| `manually_manage_connections?` | `bool \| None` |
230 +
231 +**Returns**
232 +
233 +`MCPServerInstance` — MCP server instance
234 +
235 +**Example**
236 +
237 +```python
238 +>>> mcp = composio.experimental.mcp.generate(
239 + ... 'user_12345',
240 + ... 'mcp_67890',
241 + ... manually_manage_connections=False
242 + ... )
243 + >>>
244 + >>> print(mcp['url']) # Server URL for the user
245 + >>> print(mcp['allowed_tools']) # Available tools
246 +```
247 +
248 +---
249 +
250 +[View source](https://github.com/composiohq/composio/blob/next/python/composio/core/models/mcp.py#L88)
docs/content/reference/sdk-reference/python/meta.json
+2 -1
@@ -6,6 +6,7 @@
6 "toolkits",
7 "triggers",
8 "connected-accounts",
9 - "auth-configs"
9 + "auth-configs",
10 + "mcp"
11 ]
12 }
\ No newline at end of file
docs/content/reference/sdk-reference/typescript/index.mdx
+1
@@ -35,6 +35,7 @@ bun add @composio/core
35 | [`Composio`](/reference/sdk-reference/typescript/composio) | This is the core class for Composio. |
36 | [`AuthConfigs`](/reference/sdk-reference/typescript/auth-configs) | AuthConfigs class |
37 | [`ConnectedAccounts`](/reference/sdk-reference/typescript/connected-accounts) | ConnectedAccounts class |
38 +| [`MCP`](/reference/sdk-reference/typescript/mcp) | MCP (Model Control Protocol) class |
39 | [`Toolkits`](/reference/sdk-reference/typescript/toolkits) | Toolkits class |
40 | [`Tools`](/reference/sdk-reference/typescript/tools) | This class is used to manage tools in the Composio SDK. |
41 | [`Triggers`](/reference/sdk-reference/typescript/triggers) | Trigger (Instance) class |
docs/content/reference/sdk-reference/typescript/mcp.mdx new
+290
@@ -0,0 +1,290 @@
1 +---
2 +title: MCP
3 +description: MCP (Model Control Protocol) class Handles MCP server operations. When `config.experimental.mcp` is enabled, this class augments the features of `composio.mcp`.
4 +---
5 +
6 +## Usage
7 +
8 +Access this class through the `composio.mcp` property:
9 +
10 +```typescript
11 +const composio = new Composio({ apiKey: 'your-api-key' });
12 +const result = await composio.mcp.list();
13 +```
14 +
15 +## Properties
16 +
17 +| Name | Type |
18 +|------|------|
19 +| `client` | `Composio` |
20 +
21 +## Methods
22 +
23 +### create()
24 +
25 +Create a new MCP configuration.
26 +
27 +```typescript
28 +async create(name: string, mcpConfig: object): Promise<MCPConfigCreateResponse>
29 +```
30 +
31 +**Parameters**
32 +
33 +| Name | Type |
34 +|------|------|
35 +| `name` | `string` |
36 +| `mcpConfig` | `object` |
37 +
38 +**Returns**
39 +
40 +`Promise<MCPConfigCreateResponse>` — Created server details with instance getter
41 +
42 +**Example**
43 +
44 +```typescript
45 +const server = await composio.mcpConfig.create("personal-mcp-server", {
46 + toolkits: ["github", "slack"],
47 + allowedTools: ["GMAIL_FETCH_EMAILS", "SLACK_SEND_MESSAGE"],
48 + manuallyManageConnections: false
49 + }
50 +});
51 +
52 +const server = await composio.mcpConfig.create("personal-mcp-server", {
53 + toolkits: [{ toolkit: "gmail", authConfigId: "ac_243434343" }],
54 + allowedTools: ["GMAIL_FETCH_EMAILS"],
55 + manuallyManageConnections: false
56 + }
57 +});
58 +```
59 +
60 +---
61 +
62 +### delete()
63 +
64 +Delete an MCP server configuration permanently
65 +
66 +```typescript
67 +async delete(serverId: string): Promise<{ deleted: boolean; id: string }>
68 +```
69 +
70 +**Parameters**
71 +
72 +| Name | Type | Description |
73 +|------|------|-------------|
74 +| `serverId` | `string` | The unique identifier of the MCP server to delete |
75 +
76 +**Returns**
77 +
78 +`Promise<...>` — Confirmation object with server ID and deletion status
79 +
80 +**Example**
81 +
82 +```typescript
83 +// Delete an MCP server by ID
84 +const result = await composio.experimental.mcp.delete("mcp_12345");
85 +
86 +if (result.deleted) {
87 + console.log(`Server ${result.id} has been successfully deleted`);
88 +} else {
89 + console.log(`Failed to delete server ${result.id}`);
90 +}
91 +
92 +// Example with error handling
93 +try {
94 + const result = await composio.experimental.mcp.delete("mcp_12345");
95 + console.log("Deletion successful:", result);
96 +} catch (error) {
97 + console.error("Failed to delete MCP server:", error.message);
98 +}
99 +
100 +// Delete and verify from list
101 +await composio.experimental.mcp.delete("mcp_12345");
102 +const servers = await composio.experimental.mcp.list({});
103 +const serverExists = servers.items.some(server => server.id === "mcp_12345");
104 +console.log("Server still exists:", serverExists); // Should be false
105 +```
106 +
107 +---
108 +
109 +### generate()
110 +
111 +Get server URLs for an existing MCP server.
112 +The response is wrapped according to the provider's specifications.
113 +
114 +```typescript
115 +async generate(userId: string, mcpConfigId: string, options?: { manuallyManageConnections?: boolean }): Promise<...>
116 +```
117 +
118 +**Parameters**
119 +
120 +| Name | Type | Description |
121 +|------|------|-------------|
122 +| `userId` | `string` | \{string\} external user id from your database for whom you want the server for |
123 +| `mcpConfigId` | `string` | \{string\} config id of the MCPConfig for which you want to create a server for |
124 +| `options?` | `object` | \{object\} additional options |
125 +
126 +**Returns**
127 +
128 +`Promise<...>`
129 +
130 +**Example**
131 +
132 +```typescript
133 +import { Composio } from "@composio/code";
134 +
135 +const composio = new Composio();
136 +const mcp = await composio.experimental.mcp.generate("default", "<mcp_config_id>");
137 +```
138 +
139 +---
140 +
141 +### get()
142 +
143 +Retrieve detailed information about a specific MCP server by its ID
144 +
145 +```typescript
146 +async get(serverId: string): Promise<...>
147 +```
148 +
149 +**Parameters**
150 +
151 +| Name | Type | Description |
152 +|------|------|-------------|
153 +| `serverId` | `string` | The unique identifier of the MCP server to retrieve |
154 +
155 +**Returns**
156 +
157 +`Promise<...>` — Complete MCP server details including configuration, tools, and metadata
158 +
159 +**Example**
160 +
161 +```typescript
162 +// Get a specific MCP server by ID
163 +const server = await composio.experimental.mcp.get("mcp_12345");
164 +
165 +console.log(server.name); // "My Personal MCP Server"
166 +console.log(server.allowedTools); // ["GITHUB_CREATE_ISSUE", "SLACK_SEND_MESSAGE"]
167 +console.log(server.toolkits); // ["github", "slack"]
168 +console.log(server.serverInstanceCount); // 3
169 +
170 +// Access setup commands for different clients
171 +console.log(server.commands.claude); // Claude setup command
172 +console.log(server.commands.cursor); // Cursor setup command
173 +console.log(server.commands.windsurf); // Windsurf setup command
174 +
175 +// Use the MCP URL for direct connections
176 +const mcpUrl = server.MCPUrl;
177 +```
178 +
179 +---
180 +
181 +### list()
182 +
183 +List the MCP servers with optional filtering and pagination
184 +
185 +```typescript
186 +async list(options: { authConfigs: string[]; limit: number; name?: string; page: number; toolkits: string[] }): Promise<...>
187 +```
188 +
189 +**Parameters**
190 +
191 +| Name | Type | Description |
192 +|------|------|-------------|
193 +| `options` | `object` | Filtering and pagination options |
194 +
195 +**Returns**
196 +
197 +`Promise<...>` — Paginated list of MCP servers with metadata
198 +
199 +**Example**
200 +
201 +```typescript
202 +// List all MCP servers
203 +const allServers = await composio.experimental.mcp.list({});
204 +
205 +// List with pagination
206 +const pagedServers = await composio.experimental.mcp.list({
207 + page: 2,
208 + limit: 5
209 +});
210 +
211 +// Filter by toolkit
212 +const githubServers = await composio.experimental.mcp.list({
213 + toolkits: ['github', 'slack']
214 +});
215 +
216 +// Filter by name
217 +const namedServers = await composio.experimental.mcp.list({
218 + name: 'personal'
219 +});
220 +```
221 +
222 +---
223 +
224 +### update()
225 +
226 +Update an existing MCP server configuration with new settings
227 +
228 +```typescript
229 +async update(serverId: string, config: object): Promise<...>
230 +```
231 +
232 +**Parameters**
233 +
234 +| Name | Type | Description |
235 +|------|------|-------------|
236 +| `serverId` | `string` | The unique identifier of the MCP server to update |
237 +| `config` | `object` | Update configuration parameters |
238 +
239 +**Returns**
240 +
241 +`Promise<...>` — Updated MCP server configuration with all details
242 +
243 +**Example**
244 +
245 +```typescript
246 +// Update server name only
247 +const updatedServer = await composio.experimental.mcp.update("mcp_12345", {
248 + name: "My Updated MCP Server"
249 +});
250 +
251 +// Update toolkits and tools
252 +const serverWithNewTools = await composio.experimental.mcp.update("mcp_12345", {
253 + toolkits: [
254 + {
255 + toolkit: "github",
256 + authConfigId: "auth_abc123",
257 + allowedTools: ["GITHUB_CREATE_ISSUE", "GITHUB_LIST_REPOS"]
258 + },
259 + {
260 + toolkit: "slack",
261 + authConfigId: "auth_xyz789",
262 + allowedTools: ["SLACK_SEND_MESSAGE", "SLACK_LIST_CHANNELS"]
263 + }
264 + ]
265 +});
266 +
267 +// Update connection management setting
268 +const serverWithManualAuth = await composio.experimental.mcp.update("mcp_12345", {
269 + name: "Manual Auth Server",
270 + manuallyManageConnections: true
271 +});
272 +
273 +// Complete update example
274 +const fullyUpdatedServer = await composio.experimental.mcp.update("mcp_12345", {
275 + name: "Production MCP Server",
276 + toolkits: [
277 + {
278 + toolkit: "gmail",
279 + authConfigId: "auth_gmail_prod",
280 + }
281 + ],
282 + allowedTools: ["GMAIL_SEND_EMAIL", "GMAIL_FETCH_EMAILS"]
283 + manuallyManageConnections: false
284 +});
285 +
286 +console.log("Updated server:", fullyUpdatedServer.name);
287 +console.log("New tools:", fullyUpdatedServer.allowedTools);
288 +```
289 +
290 +---
docs/content/reference/sdk-reference/typescript/meta.json
+1
@@ -4,6 +4,7 @@
4 "composio",
5 "auth-configs",
6 "connected-accounts",
7 + "mcp",
8 "toolkits",
9 "tools",
10 "triggers"
docs/package.json
+5 -1
@@ -10,7 +10,10 @@
10 "postinstall": "fumadocs-mdx",
11 "lint": "eslint",
12 "lint:links": "bun scripts/validate-links.ts",
13 - "generate:toolkits": "bun scripts/generate-toolkits.ts"
13 + "generate:toolkits": "bun scripts/generate-toolkits.ts",
14 + "generate:sdk-reference:ts": "bun scripts/sdk-reference/generate-typescript.ts",
15 + "generate:sdk-reference:py": "uv run --with griffe python scripts/sdk-reference/generate-python.py",
16 + "generate:sdk-reference": "bun run generate:sdk-reference:ts && bun run generate:sdk-reference:py"
17 },
18 "dependencies": {
19 "@radix-ui/react-tabs": "^1.1.13",
@@ -30,6 +33,7 @@
33 "tailwind-merge": "^3.4.0"
34 },
35 "devDependencies": {
36 + "typedoc": "^0.28.5",
37 "@ai-sdk/anthropic": "^3.0.11",
38 "@ai-sdk/mcp": "^1.0.6",
39 "@ai-sdk/openai": "^3.0.9",
docs/scripts/sdk-reference/generate-python.py renamed
+9 -13
@@ -5,7 +5,7 @@ Python SDK Documentation Generator
5 Generates MDX documentation from Python source code using griffe.
6 Output is written to the docs content directory.
7
8 -Run: cd python && uv run --with griffe python scripts/generate-docs.py
8 +Run from docs/: uv run --with griffe python scripts/sdk-reference/generate-python.py
9 """
10
11 from __future__ import annotations
@@ -22,17 +22,11 @@ except ImportError:
22 print("Error: griffe not installed. Run: pip install griffe")
23 raise SystemExit(1)
24
25 -# Paths
25 +# Paths (relative to docs/scripts/sdk-reference/)
26 SCRIPT_DIR = Path(__file__).parent
27 -PACKAGE_DIR = SCRIPT_DIR.parent
28 -OUTPUT_DIR = (
29 - PACKAGE_DIR.parent
30 - / "docs"
31 - / "content"
32 - / "reference"
33 - / "sdk-reference"
34 - / "python"
35 -)
27 +DOCS_DIR = SCRIPT_DIR.parent.parent
28 +PY_SDK_DIR = DOCS_DIR.parent / "python"
29 +OUTPUT_DIR = DOCS_DIR / "content" / "reference" / "sdk-reference" / "python"
30
31 # GitHub base URL for source links
32 GITHUB_BASE = "https://github.com/composiohq/composio/blob/next/python"
@@ -54,6 +48,7 @@ EXPECTED_CLASSES = {
48 "Triggers": "triggers",
49 "ConnectedAccounts": "connected_accounts",
50 "AuthConfigs": "auth_configs",
51 + "MCP": "mcp",
52 }
53
54 # Modules to search for classes
@@ -63,6 +58,7 @@ CLASS_MODULES = [
58 "core.models.triggers",
59 "core.models.connected_accounts",
60 "core.models.auth_configs",
61 + "core.models.mcp",
62 ]
63
64
@@ -92,7 +88,7 @@ def get_source_link(obj: griffe.Object) -> str | None:
88 resolved_path = raw_filepath
89 if not resolved_path:
90 return None
95 - rel_path = resolved_path.relative_to(PACKAGE_DIR)
91 + rel_path = resolved_path.relative_to(PY_SDK_DIR)
92 except ValueError:
93 return None
94 line = obj.lineno if hasattr(obj, "lineno") and obj.lineno else 1
@@ -459,7 +455,7 @@ def main():
455 # Load package
456 print("Loading composio package...")
457 try:
462 - package = griffe.load("composio", search_paths=[str(PACKAGE_DIR)])
458 + package = griffe.load("composio", search_paths=[str(PY_SDK_DIR)])
459 except Exception as e:
460 print(f"Error: {e}")
461 raise SystemExit(1)
docs/scripts/sdk-reference/generate-typescript.ts renamed
+14 -13
@@ -4,7 +4,7 @@
4 * Generates MDX documentation from TypeScript source code using TypeDoc.
5 * Output is written to the docs content directory.
6 *
7 - * Run: pnpm --filter @composio/core generate:docs
7 + * Run from docs/: bun scripts/sdk-reference/generate-typescript.ts
8 */
9
10 import { mkdir, writeFile, rm, readdir, readFile } from 'fs/promises';
@@ -12,15 +12,13 @@ import { join, dirname } from 'path';
12 import { execSync } from 'child_process';
13 import { fileURLToPath } from 'url';
14
15 -// Paths (relative to ts/packages/core)
15 +// Paths (relative to docs/scripts/sdk-reference/)
16 const SCRIPT_DIR = dirname(fileURLToPath(import.meta.url));
17 -const PACKAGE_DIR = join(SCRIPT_DIR, '..');
18 -const MODELS_DIR = join(PACKAGE_DIR, 'src/models');
19 -const OUTPUT_DIR = join(
20 - PACKAGE_DIR,
21 - '../../../docs/content/reference/sdk-reference/typescript'
22 -);
23 -const TEMP_JSON = join(PACKAGE_DIR, '.typedoc-output.json');
17 +const DOCS_DIR = join(SCRIPT_DIR, '../..');
18 +const TS_SDK_DIR = join(DOCS_DIR, '../ts/packages/core');
19 +const MODELS_DIR = join(TS_SDK_DIR, 'src/models');
20 +const OUTPUT_DIR = join(DOCS_DIR, 'content/reference/sdk-reference/typescript');
21 +const TEMP_JSON = join(TS_SDK_DIR, '.typedoc-output.json');
22
23 // Internal classes that should NOT be documented (accessed via other APIs)
24 const INTERNAL_CLASSES = new Set([
@@ -28,7 +26,6 @@ const INTERNAL_CLASSES = new Set([
26 'AuthScheme', // Utility class
27 'ConnectionRequest', // Utility
28 'Files', // Not yet stable API
31 - 'MCP', // Experimental
29 'ToolRouter', // Experimental
30 ]);
31
@@ -543,7 +540,11 @@ function generateClassMdx(classDoc: ClassDoc): string {
540 lines.push(generateMethodMdx(classDoc.constructor));
541 } else if (!USER_INSTANTIATED_CLASSES.has(classDoc.name)) {
542 // Show usage hint for non-instantiated classes
546 - const accessorName = classDoc.name.charAt(0).toLowerCase() + classDoc.name.slice(1);
543 + // Handle acronyms (e.g., "MCP" -> "mcp") vs PascalCase (e.g., "AuthConfigs" -> "authConfigs")
544 + const accessorName =
545 + classDoc.name === classDoc.name.toUpperCase()
546 + ? classDoc.name.toLowerCase()
547 + : classDoc.name.charAt(0).toLowerCase() + classDoc.name.slice(1);
548 lines.push('## Usage');
549 lines.push('');
550 lines.push(`Access this class through the \`composio.${accessorName}\` property:`);
@@ -722,7 +723,7 @@ async function runTypeDoc(): Promise<TypeDocProject> {
723 ].join(' ');
724
725 try {
725 - execSync(cmd, { stdio: 'pipe', cwd: PACKAGE_DIR });
726 + execSync(cmd, { stdio: 'pipe', cwd: TS_SDK_DIR });
727 } catch (error) {
728 console.error('TypeDoc failed:', error);
729 throw error;
@@ -734,7 +735,7 @@ async function runTypeDoc(): Promise<TypeDocProject> {
735
736 async function main() {
737 console.log('Starting TypeScript SDK documentation generation...\n');
737 - console.log(`Package dir: ${PACKAGE_DIR}`);
738 + console.log(`Package dir: ${TS_SDK_DIR}`);
739 console.log(`Output dir: ${OUTPUT_DIR}\n`);
740
741 // Clean output directory
ts/packages/core/package.json
+1 -2
@@ -119,8 +119,7 @@
119 "clean": "git clean -xdf node_modules",
120 "build": "bun run --bun tsdown",
121 "test": "vitest run",
122 - "typecheck": "tsc --noEmit --skipLibCheck && tsc --noEmit --skipLibCheck -p tsconfig.type-tests.json",
123 - "generate:docs": "tsx scripts/generate-docs.ts"
122 + "typecheck": "tsc --noEmit --skipLibCheck && tsc --noEmit --skipLibCheck -p tsconfig.type-tests.json"
123 },
124 "keywords": [],
125 "author": "",