@devries-cameron20 / composio-1 / commits / edd26a9a8
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: Add dynamic API index pages for LLM navigation

- Create generate-api-index.ts script that reads OpenAPI spec - Generate simple markdown index pages for each API tag - Pages include tag description and links to all endpoints - Run automatically as prebuild step - Update overview page with links to index pages Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Sushmithamallesh committed Jan 30, 2026 at 15:37 UTC edd26a9a8524340c1e2f08c6c1c4372de6a6b293
14 files changed +286 -8
docs/content/reference/api-reference/auth-configs.mdx new
+17
@@ -0,0 +1,17 @@
1 +---
2 +title: Auth Configs
3 +description: "Authentication configuration management"
4 +---
5 +
6 +{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 +
8 +Authentication configuration management
9 +
10 +## Endpoints
11 +
12 +- [Create new authentication configuration](/reference/api-reference/auth-configs/create-new-authentication-configuration)
13 +- [List authentication configurations with optional filters](/reference/api-reference/auth-configs/list-authentication-configurations-with-optional-filters)
14 +- [Get single authentication configuration by ID](/reference/api-reference/auth-configs/get-single-authentication-configuration-by-id)
15 +- [Update an authentication configuration](/reference/api-reference/auth-configs/update-an-authentication-configuration)
16 +- [Delete an authentication configuration](/reference/api-reference/auth-configs/delete-an-authentication-configuration)
17 +- [Enable or disable an authentication configuration](/reference/api-reference/auth-configs/enable-or-disable-an-authentication-configuration)
docs/content/reference/api-reference/authentication.mdx new
+12
@@ -0,0 +1,12 @@
1 +---
2 +title: Authentication
3 +description: "Authentication related endpoints"
4 +---
5 +
6 +{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 +
8 +Authentication related endpoints
9 +
10 +## Endpoints
11 +
12 +- [Get current user session information](/reference/api-reference/authentication/get-current-user-session-information)
docs/content/reference/api-reference/connected-accounts.mdx new
+18
@@ -0,0 +1,18 @@
1 +---
2 +title: Connected Accounts
3 +description: "Connected account management"
4 +---
5 +
6 +{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 +
8 +Connected account management
9 +
10 +## Endpoints
11 +
12 +- [List connected accounts with optional filters](/reference/api-reference/connected-accounts/list-connected-accounts-with-optional-filters)
13 +- [Create a new connected account](/reference/api-reference/connected-accounts/create-a-new-connected-account)
14 +- [Get connected account details by ID](/reference/api-reference/connected-accounts/get-connected-account-details-by-id)
15 +- [Delete a connected account](/reference/api-reference/connected-accounts/delete-a-connected-account)
16 +- [Enable or disable a connected account](/reference/api-reference/connected-accounts/enable-or-disable-a-connected-account)
17 +- [Refresh authentication for a connected account](/reference/api-reference/connected-accounts/refresh-authentication-for-a-connected-account)
18 +- [Create a new auth link session](/reference/api-reference/connected-accounts/create-a-new-auth-link-session)
docs/content/reference/api-reference/files.mdx new
+13
@@ -0,0 +1,13 @@
1 +---
2 +title: Files
3 +description: "File management"
4 +---
5 +
6 +{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 +
8 +File management
9 +
10 +## Endpoints
11 +
12 +- [List files with optional app and action filters](/reference/api-reference/files/list-files-with-optional-app-and-action-filters)
13 +- [Create presigned URL for request file upload to S3](/reference/api-reference/files/create-presigned-url-for-request-file-upload-to-s3)
docs/content/reference/api-reference/mcp.mdx new
+22
@@ -0,0 +1,22 @@
1 +---
2 +title: MCP
3 +description: "MCP server management"
4 +---
5 +
6 +{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 +
8 +MCP server management
9 +
10 +## Endpoints
11 +
12 +- [List MCP servers with optional filters and pagination](/reference/api-reference/mcp/list-mcp-servers-with-optional-filters-and-pagination)
13 +- [Create a new MCP server](/reference/api-reference/mcp/create-a-new-mcp-server)
14 +- [Create a new custom MCP server with multiple apps](/reference/api-reference/mcp/create-a-new-custom-mcp-server-with-multiple-apps)
15 +- [Generate MCP URL with custom parameters](/reference/api-reference/mcp/generate-mcp-url-with-custom-parameters)
16 +- [Get MCP server details by ID](/reference/api-reference/mcp/get-mcp-server-details-by-id)
17 +- [Update MCP server configuration](/reference/api-reference/mcp/update-mcp-server-configuration)
18 +- [Delete an MCP server](/reference/api-reference/mcp/delete-an-mcp-server)
19 +- [List MCP servers for a specific app](/reference/api-reference/mcp/list-mcp-servers-for-a-specific-app)
20 +- [List all instances for an MCP server](/reference/api-reference/mcp/list-all-instances-for-an-mcp-server)
21 +- [Create a new MCP server instance](/reference/api-reference/mcp/create-a-new-mcp-server-instance)
22 +- [Delete an MCP server instance and associated connected accounts](/reference/api-reference/mcp/delete-an-mcp-server-instance-and-associated-connected-accounts)
docs/content/reference/api-reference/migration.mdx new
+12
@@ -0,0 +1,12 @@
1 +---
2 +title: Migration
3 +description: "Endpoints to help with migration from v1 to v3"
4 +---
5 +
6 +{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 +
8 +Endpoints to help with migration from v1 to v3
9 +
10 +## Endpoints
11 +
12 +- [Get NanoId from UUID](/reference/api-reference/migration/get-nanoid-from-uuid)
docs/content/reference/api-reference/projects.mdx new
+18
@@ -0,0 +1,18 @@
1 +---
2 +title: Projects
3 +description: "Projects API endpoints"
4 +---
5 +
6 +{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 +
8 +Projects API endpoints
9 +
10 +## Endpoints
11 +
12 +- [Get project configuration](/reference/api-reference/projects/get-project-configuration)
13 +- [Update project configuration](/reference/api-reference/projects/update-project-configuration)
14 +- [Create a new project](/reference/api-reference/projects/create-a-new-project)
15 +- [List all projects](/reference/api-reference/projects/list-all-projects)
16 +- [Get project details by ID With Org Api key](/reference/api-reference/projects/get-project-details-by-id-with-org-api-key)
17 +- [Delete a project](/reference/api-reference/projects/delete-a-project)
18 +- [Delete and generate new API key for project](/reference/api-reference/projects/delete-and-generate-new-api-key-for-project)
docs/content/reference/api-reference/tool-router.mdx new
+18
@@ -0,0 +1,18 @@
1 +---
2 +title: Tool Router
3 +description: "(Labs) Tool router endpoints"
4 +---
5 +
6 +{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 +
8 +(Labs) Tool router endpoints
9 +
10 +## Endpoints
11 +
12 +- [Create a new tool router session](/reference/api-reference/tool-router/create-a-new-tool-router-session)
13 +- [Execute a tool within a tool router session](/reference/api-reference/tool-router/execute-a-tool-within-a-tool-router-session)
14 +- [Execute a meta tool within a tool router session](/reference/api-reference/tool-router/execute-a-meta-tool-within-a-tool-router-session)
15 +- [Get a tool router session by ID](/reference/api-reference/tool-router/get-a-tool-router-session-by-id)
16 +- [Create a link session for a toolkit in a tool router session](/reference/api-reference/tool-router/create-a-link-session-for-a-toolkit-in-a-tool-router-session)
17 +- [Get toolkits for a tool router session](/reference/api-reference/tool-router/get-toolkits-for-a-tool-router-session)
18 +- [List meta tools with schemas for a tool router session](/reference/api-reference/tool-router/list-meta-tools-with-schemas-for-a-tool-router-session)
docs/content/reference/api-reference/toolkits.mdx new
+16
@@ -0,0 +1,16 @@
1 +---
2 +title: Toolkits
3 +description: "Toolkit and tool management"
4 +---
5 +
6 +{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 +
8 +Toolkit and tool management
9 +
10 +## Endpoints
11 +
12 +- [List available toolkits](/reference/api-reference/toolkits/list-available-toolkits)
13 +- [List toolkit categories](/reference/api-reference/toolkits/list-toolkit-categories)
14 +- [Get toolkit by slug](/reference/api-reference/toolkits/get-toolkit-by-slug)
15 +- [Fetch multiple toolkits](/reference/api-reference/toolkits/fetch-multiple-toolkits)
16 +- [Get toolkits changelog](/reference/api-reference/toolkits/get-toolkits-changelog)
docs/content/reference/api-reference/tools.mdx new
+17
@@ -0,0 +1,17 @@
1 +---
2 +title: Tools
3 +description: "Tool execution endpoints"
4 +---
5 +
6 +{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 +
8 +Tool execution endpoints
9 +
10 +## Endpoints
11 +
12 +- [List available tools](/reference/api-reference/tools/list-available-tools)
13 +- [Get tool enum list](/reference/api-reference/tools/get-tool-enum-list)
14 +- [Get tool by slug](/reference/api-reference/tools/get-tool-by-slug)
15 +- [Execute tool](/reference/api-reference/tools/execute-tool)
16 +- [Generate tool inputs from natural language](/reference/api-reference/tools/generate-tool-inputs-from-natural-language)
17 +- [Execute proxy request](/reference/api-reference/tools/execute-proxy-request)
docs/content/reference/api-reference/triggers.mdx new
+18
@@ -0,0 +1,18 @@
1 +---
2 +title: Triggers
3 +description: "Trigger management and execution"
4 +---
5 +
6 +{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 +
8 +Trigger management and execution
9 +
10 +## Endpoints
11 +
12 +- [Create or update a trigger](/reference/api-reference/triggers/create-or-update-a-trigger)
13 +- [List active triggers](/reference/api-reference/triggers/list-active-triggers)
14 +- [Delete a trigger](/reference/api-reference/triggers/delete-a-trigger)
15 +- [Enable or disable a trigger](/reference/api-reference/triggers/enable-or-disable-a-trigger)
16 +- [List trigger type enums](/reference/api-reference/triggers/list-trigger-type-enums)
17 +- [Get trigger type by slug](/reference/api-reference/triggers/get-trigger-type-by-slug)
18 +- [List trigger types](/reference/api-reference/triggers/list-trigger-types)
docs/content/reference/index.mdx
+6 -8
@@ -14,16 +14,14 @@ Composio powers tool discovery, execution, authentication, and context managemen
14
15 ## REST API
16
17 -Browse endpoints in the sidebar. Key APIs include:
18 -
17 | API | Description |
18 |-----|-------------|
21 -| Tool Router | Session-based API for AI agents to discover and execute tools |
22 -| Tools | List, search, and execute individual actions |
23 -| Connected Accounts | Manage user OAuth connections to apps |
24 -| Auth Configs | Configure how users authenticate to toolkits |
25 -| Triggers | Subscribe to webhooks from connected apps |
26 -| Toolkits | Browse available apps and their tools |
19 +| [Tool Router](/reference/api-reference/tool-router) | Session-based API for AI agents to discover and execute tools |
20 +| [Tools](/reference/api-reference/tools) | List, search, and execute individual actions |
21 +| [Connected Accounts](/reference/api-reference/connected-accounts) | Manage user OAuth connections to apps |
22 +| [Auth Configs](/reference/api-reference/auth-configs) | Configure how users authenticate to toolkits |
23 +| [Triggers](/reference/api-reference/triggers) | Subscribe to webhooks from connected apps |
24 +| [Toolkits](/reference/api-reference/toolkits) | Browse available apps and their tools |
25
26 ## SDK Reference
27
docs/package.json
+1
@@ -3,6 +3,7 @@
3 "version": "0.0.0",
4 "private": true,
5 "scripts": {
6 + "prebuild": "bun scripts/generate-api-index.ts",
7 "build": "next build",
8 "dev": "next dev",
9 "start": "next start",
docs/scripts/generate-api-index.ts new
+98
@@ -0,0 +1,98 @@
1 +/**
2 + * Generates simple markdown index pages for each OpenAPI tag.
3 + * These pages provide:
4 + * - Tag description from OpenAPI spec
5 + * - Links to all endpoints in that tag
6 + *
7 + * Run: bun scripts/generate-api-index.ts
8 + */
9 +
10 +import { readFileSync, writeFileSync, mkdirSync } from 'fs';
11 +import { join } from 'path';
12 +
13 +interface OpenAPISpec {
14 + tags: Array<{ name: string; description?: string }>;
15 + paths: Record<string, Record<string, { summary?: string; tags?: string[]; description?: string }>>;
16 +}
17 +
18 +function slugify(text: string): string {
19 + return text
20 + .toLowerCase()
21 + .replace(/[^a-z0-9]+/g, '-')
22 + .replace(/^-|-$/g, '');
23 +}
24 +
25 +function generateIndexPages() {
26 + // Read OpenAPI spec
27 + const specPath = join(process.cwd(), 'public/openapi.json');
28 + const spec: OpenAPISpec = JSON.parse(readFileSync(specPath, 'utf-8'));
29 +
30 + // Build tag -> operations map
31 + const tagOperations: Record<string, Array<{ summary: string; description?: string; method: string; path: string }>> = {};
32 + const tagDescriptions: Record<string, string> = {};
33 +
34 + // Get tag descriptions
35 + for (const tag of spec.tags) {
36 + tagDescriptions[tag.name] = tag.description || '';
37 + tagOperations[tag.name] = [];
38 + }
39 +
40 + // Group operations by tag
41 + for (const [path, methods] of Object.entries(spec.paths)) {
42 + for (const [method, operation] of Object.entries(methods)) {
43 + if (operation.tags) {
44 + for (const tag of operation.tags) {
45 + if (!tagOperations[tag]) {
46 + tagOperations[tag] = [];
47 + }
48 + tagOperations[tag].push({
49 + summary: operation.summary || `${method.toUpperCase()} ${path}`,
50 + description: operation.description,
51 + method: method.toUpperCase(),
52 + path,
53 + });
54 + }
55 + }
56 + }
57 + }
58 +
59 + // Generate MDX files for each tag
60 + const outputDir = join(process.cwd(), 'content/reference/api-reference');
61 + mkdirSync(outputDir, { recursive: true });
62 +
63 + for (const [tagName, operations] of Object.entries(tagOperations)) {
64 + if (operations.length === 0) continue;
65 +
66 + const tagSlug = slugify(tagName);
67 + const tagDescription = tagDescriptions[tagName] || `${tagName} API endpoints`;
68 +
69 + // Generate endpoint links
70 + const endpointLinks = operations.map(op => {
71 + const endpointSlug = slugify(op.summary);
72 + const url = `/reference/api-reference/${tagSlug}/${endpointSlug}`;
73 + return `- [${op.summary}](${url})`;
74 + }).join('\n');
75 +
76 + const content = `---
77 +title: ${tagName}
78 +description: "${tagDescription}"
79 +---
80 +
81 +{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
82 +
83 +${tagDescription}
84 +
85 +## Endpoints
86 +
87 +${endpointLinks}
88 +`;
89 +
90 + const filePath = join(outputDir, `${tagSlug}.mdx`);
91 + writeFileSync(filePath, content);
92 + console.log(`Generated: ${tagSlug}.mdx`);
93 + }
94 +
95 + console.log('Done generating API index pages');
96 +}
97 +
98 +generateIndexPages();