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.

refactor(docs): extract shared toolkit schema processing into lib/toolkit-schema

Sushmithamalleshb890e2d9583f
diff --git a/docs/app/(home)/toolkits/[[...slug]]/page.tsx b/docs/app/(home)/toolkits/[[...slug]]/page.tsx
index 550f46f8c..9a5bb6aa6 100644
--- a/docs/app/(home)/toolkits/[[...slug]]/page.tsx
+++ b/docs/app/(home)/toolkits/[[...slug]]/page.tsx
@@ -8,55 +8,11 @@ import { readFile } from 'fs/promises';
import { join } from 'path';
import type { Metadata } from 'next';
import type { Toolkit, Tool, Trigger } from '@/types/toolkit';
+import { processParams, toolFromApi } from '@/lib/toolkit-schema';
const API_BASE = process.env.COMPOSIO_API_BASE || 'https://backend.composio.dev/api/v3';
const API_KEY = process.env.COMPOSIO_API_KEY;
-// Add required flag to each property based on the required array
-// Preserves nested properties/items for object and array types
-function processParams(props: any, requiredList: string[]): Record<string, any> | undefined {
- if (!props || typeof props !== 'object') return undefined;
- const result: Record<string, any> = {};
- for (const [key, value] of Object.entries(props)) {
- if (typeof value === 'object' && value !== null) {
- const param = value as any;
- result[key] = {
- type: param.type,
- description: param.description,
- default: param.default,
- example: param.example,
- enum: param.enum,
- required: requiredList.includes(key),
- ...(param.properties ? { properties: param.properties } : {}),
- ...(param.required ? { requiredFields: param.required } : {}),
- ...(param.items ? { items: param.items } : {}),
- };
- }
- }
- return Object.keys(result).length > 0 ? result : undefined;
-}
-
-function toolFromApi(tool: any): Tool {
- const inputSchema = tool.input_parameters || tool.parameters;
- const outputSchema = tool.output_parameters || tool.response;
-
- const inputProps = inputSchema?.properties || inputSchema;
- const inputRequired = inputSchema?.required || [];
- const outputProps = outputSchema?.properties || outputSchema;
- const outputRequired = outputSchema?.required || [];
-
- return {
- slug: tool.slug || '',
- name: tool.name || tool.display_name || tool.slug || '',
- description: tool.description || '',
- input_parameters: processParams(inputProps, inputRequired),
- output_parameters: processParams(outputProps, outputRequired),
- scopes: tool.scopes || undefined,
- tags: tool.tags || undefined,
- is_deprecated: tool.is_deprecated || false,
- };
-}
-
// Fetch detailed tool info from Composio API (server-side only)
// Returns null on failure, empty array if toolkit has no tools
async function fetchDetailedTools(toolkitSlug: string, version?: string | null): Promise<Tool[] | null> {
diff --git a/docs/components/toolkits/toolkit-detail.tsx b/docs/components/toolkits/toolkit-detail.tsx
index 490b49a60..685f91a2a 100644
--- a/docs/components/toolkits/toolkit-detail.tsx
+++ b/docs/components/toolkits/toolkit-detail.tsx
@@ -5,6 +5,7 @@ import Link from 'next/link';
import { ExternalLink, Search, Copy, Check, ChevronDown, ChevronRight, ArrowLeft } from 'lucide-react';
import { TypeTable } from 'fumadocs-ui/components/type-table';
import type { Toolkit, Tool, Trigger, ParameterSchema } from '@/types/toolkit';
+import { processSchema } from '@/lib/toolkit-schema';
import { PageActions } from '@/components/page-actions';
import { AuthDetailsSection } from '@/components/toolkits/auth-details-section';
@@ -105,32 +106,6 @@ function paramsToTypeTable(params: Record<string, ParameterSchema>): Record<stri
return result;
}
-// Process raw API schema into ParameterSchema records
-function processApiSchema(schema: any): Record<string, ParameterSchema> | undefined {
- if (!schema) return undefined;
- const props = schema.properties || schema;
- const required = schema.required || [];
- if (!props || typeof props !== 'object') return undefined;
-
- const result: Record<string, ParameterSchema> = {};
- for (const [key, value] of Object.entries(props)) {
- if (typeof value === 'object' && value !== null) {
- const param = value as any;
- result[key] = {
- type: param.type,
- description: param.description,
- default: param.default,
- example: param.example,
- enum: param.enum,
- required: required.includes(key),
- ...(param.properties ? { properties: param.properties } : {}),
- ...(param.required ? { requiredFields: param.required } : {}),
- ...(param.items ? { items: param.items } : {}),
- };
- }
- }
- return Object.keys(result).length > 0 ? result : undefined;
-}
// Check if item is a Tool with parameters
function isTool(item: Tool | Trigger): item is Tool {
@@ -171,8 +146,8 @@ function ToolItem({ item, toolkitVersion }: { item: Tool | Trigger; toolkitVersi
if (res.ok) {
const data = await res.json();
setDetailedParams({
- input: processApiSchema(data.input_parameters),
- output: processApiSchema(data.output_parameters),
+ input: processSchema(data.input_parameters),
+ output: processSchema(data.output_parameters),
});
}
} catch {
diff --git a/docs/lib/toolkit-schema.ts b/docs/lib/toolkit-schema.ts
new file mode 100644
index 000000000..b531f787d
--- /dev/null
+++ b/docs/lib/toolkit-schema.ts
@@ -0,0 +1,51 @@
+import type { ParameterSchema, Tool } from '@/types/toolkit';
+
+// Add required flag to each property based on the required array
+// Preserves nested properties/items for object and array types
+export function processParams(props: any, requiredList: string[]): Record<string, ParameterSchema> | undefined {
+ if (!props || typeof props !== 'object') return undefined;
+ const result: Record<string, ParameterSchema> = {};
+ for (const [key, value] of Object.entries(props)) {
+ if (typeof value === 'object' && value !== null) {
+ const param = value as any;
+ result[key] = {
+ type: param.type,
+ description: param.description,
+ default: param.default,
+ example: param.example,
+ enum: param.enum,
+ required: requiredList.includes(key),
+ ...(param.properties ? { properties: param.properties } : {}),
+ ...(param.required ? { requiredFields: param.required } : {}),
+ ...(param.items ? { items: param.items } : {}),
+ };
+ }
+ }
+ return Object.keys(result).length > 0 ? result : undefined;
+}
+
+// Process a raw JSON Schema (with top-level properties + required) into ParameterSchema records
+export function processSchema(schema: any): Record<string, ParameterSchema> | undefined {
+ if (!schema) return undefined;
+ const props = schema.properties || schema;
+ const required = schema.required || [];
+ if (!props || typeof props !== 'object') return undefined;
+ return processParams(props, required);
+}
+
+// Convert a raw API tool object into our Tool type
+export function toolFromApi(tool: any): Tool {
+ const inputSchema = tool.input_parameters || tool.parameters;
+ const outputSchema = tool.output_parameters || tool.response;
+
+ return {
+ slug: tool.slug || '',
+ name: tool.name || tool.display_name || tool.slug || '',
+ description: tool.description || '',
+ input_parameters: processSchema(inputSchema),
+ output_parameters: processSchema(outputSchema),
+ scopes: tool.scopes || undefined,
+ tags: tool.tags || undefined,
+ is_deprecated: tool.is_deprecated || false,
+ };
+}