@xano/developer-mcp 1.0.26 → 1.0.27

package/dist/api_docs/topics/function.js

@@ -1,164 +0,0 @@
-export const functionDoc = {
-    topic: "function",
-    title: "Reusable Function Management",
-    description: `Functions are reusable pieces of logic that can be called from APIs, tasks, other functions, or anywhere in your Xano workspace.
-
-## Key Concepts
-- Functions encapsulate reusable business logic
-- Can be called from APIs, tasks, other functions, agents, tools
-- Support input parameters and return values
-- Can be cached for performance
-- Support draft/publish workflow
-
-## Caching Options
-Functions can cache results based on:
-- TTL (time-to-live)
-- Input parameters
-- Authenticated user
-- Datasource
-- IP address
-- Headers
-- Environment variables`,
-    ai_hints: `- Functions are reusable across APIs and tasks
-- Use \`include_xanoscript=true\` to see implementation
-- Draft changes won't affect production until published
-- Caching can significantly improve performance for expensive operations
-- Check existing functions before creating duplicates`,
-    endpoints: [
-        {
-            method: "GET",
-            path: "/workspace/{workspace_id}/function",
-            tool_name: "listFunctions",
-            description: "List all functions in a workspace.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "page", type: "integer", default: 1, description: "Page number" },
-                { name: "per_page", type: "integer", default: 50, description: "Items per page" },
-                { name: "search", type: "string", description: "Search by function name" },
-                { name: "sort", type: "string", enum: ["id", "name", "created_at"], default: "created_at", description: "Sort field" },
-                { name: "order", type: "string", enum: ["asc", "desc"], default: "desc", description: "Sort direction" },
-                { name: "include_xanoscript", type: "boolean", default: false, description: "Include XanoScript code" },
-                { name: "include_draft", type: "boolean", default: false, description: "Include draft versions" },
-                { name: "branch", type: "string", description: "Filter by branch name" }
-            ]
-        },
-        {
-            method: "GET",
-            path: "/workspace/{workspace_id}/function/{function_id}",
-            tool_name: "getFunction",
-            description: "Get details of a specific function.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "function_id", type: "integer", required: true, in: "path", description: "Function ID" },
-                { name: "include_xanoscript", type: "boolean", default: false, description: "Include XanoScript code" },
-                { name: "include_draft", type: "boolean", default: false, description: "Include draft version" }
-            ]
-        },
-        {
-            method: "POST",
-            path: "/workspace/{workspace_id}/function",
-            tool_name: "createFunction",
-            description: "Create a new reusable function.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
-            ],
-            request_body: {
-                type: "application/json",
-                properties: {
-                    name: { type: "string", description: "Function name", required: true },
-                    description: { type: "string", description: "Function description" },
-                    xanoscript: { type: "string", description: "XanoScript function definition", required: true }
-                }
-            },
-            example: {
-                method: "POST",
-                path: "/workspace/1/function",
-                body: {
-                    name: "calculate_total",
-                    description: "Calculate order total with tax",
-                    xanoscript: `function calculate_total {
-  input {
-    decimal subtotal
-    decimal tax_rate = 0.08
-  }
-  stack {
-    var $tax {
-      value = $input.subtotal * $input.tax_rate
-    }
-    var $total {
-      value = $input.subtotal + $tax
-    }
-  }
-  response = $total
-}`
-                }
-            }
-        },
-        {
-            method: "PUT",
-            path: "/workspace/{workspace_id}/function/{function_id}",
-            tool_name: "updateFunction",
-            description: "Update an existing function.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "function_id", type: "integer", required: true, in: "path", description: "Function ID" },
-                { name: "publish", type: "boolean", default: true, description: "Publish changes immediately (false saves as draft)" }
-            ],
-            request_body: {
-                type: "application/json",
-                properties: {
-                    name: { type: "string", description: "Function name" },
-                    description: { type: "string", description: "Function description" },
-                    xanoscript: { type: "string", description: "XanoScript function definition" }
-                }
-            }
-        },
-        {
-            method: "DELETE",
-            path: "/workspace/{workspace_id}/function/{function_id}",
-            tool_name: "deleteFunction",
-            description: "Delete a function. Ensure no other resources depend on it.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "function_id", type: "integer", required: true, in: "path", description: "Function ID" }
-            ]
-        },
-        {
-            method: "PUT",
-            path: "/workspace/{workspace_id}/function/{function_id}/security",
-            tool_name: "updateFunctionSecurity",
-            description: "Update security settings for the function.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "function_id", type: "integer", required: true, in: "path", description: "Function ID" }
-            ],
-            request_body: {
-                type: "application/json",
-                properties: {
-                    guid: { type: "string", description: "Security group GUID" }
-                }
-            }
-        }
-    ],
-    schemas: {
-        Function: {
-            type: "object",
-            properties: {
-                id: { type: "integer" },
-                name: { type: "string" },
-                description: { type: "string" },
-                xanoscript: { type: "string", description: "Only included if include_xanoscript=true" },
-                cache: {
-                    type: "object",
-                    properties: {
-                        enabled: { type: "boolean" },
-                        ttl: { type: "integer", description: "Cache TTL in seconds" }
-                    }
-                },
-                created_at: { type: "string", format: "date-time" },
-                updated_at: { type: "string", format: "date-time" }
-            }
-        }
-    },
-    related_topics: ["api", "task", "tool"]
-};

package/dist/api_docs/topics/history.d.ts

@@ -1,2 +0,0 @@
-import type { TopicDoc } from "../types.js";
-export declare const historyDoc: TopicDoc;

package/dist/api_docs/topics/history.js

@@ -1,149 +0,0 @@
-export const historyDoc = {
-    topic: "history",
-    title: "Request & Execution History",
-    description: `History endpoints provide audit logs for API requests and background executions. Use for debugging, monitoring, and compliance.
-
-## Available History Types
-- **Request History**: All API requests with timing and responses
-- **Function History**: Function execution logs
-- **Task History**: Scheduled task execution logs
-- **Middleware History**: Middleware execution logs
-- **Tool History**: Agent tool execution logs
-- **Trigger History**: Event trigger execution logs
-
-## Common Use Cases
-- Debugging failed requests
-- Performance monitoring
-- Audit compliance
-- Error tracking
-- Usage analytics`,
-    ai_hints: `- Use request history to debug API issues
-- Filter by status to find errors (4xx, 5xx)
-- Use branch filter to separate dev/prod logs
-- Include payload for full request/response data
-- History is limited to recent requests (not permanent storage)`,
-    endpoints: [
-        {
-            method: "GET",
-            path: "/workspace/{workspace_id}/request_history",
-            tool_name: "getRequestHistory",
-            description: "Get API request history with pagination.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "page", type: "integer", default: 1, description: "Page number" },
-                { name: "per_page", type: "integer", default: 50, description: "Items per page (max 500)" },
-                { name: "branch", type: "string", description: "Filter by branch name" },
-                { name: "api_id", type: "integer", description: "Filter by API endpoint ID" },
-                { name: "include_payload", type: "boolean", default: false, description: "Include request/response payloads" }
-            ]
-        },
-        {
-            method: "POST",
-            path: "/workspace/{workspace_id}/request_history/search",
-            tool_name: "searchRequestHistory",
-            description: "Search request history with advanced filters.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
-            ],
-            request_body: {
-                type: "application/json",
-                properties: {
-                    branch: { type: "string", description: "Filter by branch" },
-                    api_id: { type: "integer", description: "Filter by API ID" },
-                    status: { type: "array", description: "Filter by status codes (e.g., [200, 201])" },
-                    verb: { type: "array", description: "Filter by HTTP methods (e.g., ['GET', 'POST'])" },
-                    from_date: { type: "string", description: "Start date (ISO format)" },
-                    to_date: { type: "string", description: "End date (ISO format)" }
-                }
-            }
-        },
-        {
-            method: "GET",
-            path: "/workspace/{workspace_id}/function_history",
-            tool_name: "getFunctionHistory",
-            description: "Get function execution history.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "function_id", type: "integer", description: "Filter by function ID" },
-                { name: "page", type: "integer", default: 1, description: "Page number" },
-                { name: "per_page", type: "integer", default: 50, description: "Items per page" }
-            ]
-        },
-        {
-            method: "GET",
-            path: "/workspace/{workspace_id}/task_history",
-            tool_name: "getTaskHistory",
-            description: "Get scheduled task execution history.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "task_id", type: "integer", description: "Filter by task ID" },
-                { name: "page", type: "integer", default: 1, description: "Page number" },
-                { name: "per_page", type: "integer", default: 50, description: "Items per page" }
-            ]
-        },
-        {
-            method: "GET",
-            path: "/workspace/{workspace_id}/middleware_history",
-            tool_name: "getMiddlewareHistory",
-            description: "Get middleware execution history.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "middleware_id", type: "integer", description: "Filter by middleware ID" },
-                { name: "page", type: "integer", default: 1, description: "Page number" },
-                { name: "per_page", type: "integer", default: 50, description: "Items per page" }
-            ]
-        },
-        {
-            method: "GET",
-            path: "/workspace/{workspace_id}/tool_history",
-            tool_name: "getToolHistory",
-            description: "Get agent tool execution history.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "tool_id", type: "integer", description: "Filter by tool ID" },
-                { name: "page", type: "integer", default: 1, description: "Page number" },
-                { name: "per_page", type: "integer", default: 50, description: "Items per page" }
-            ]
-        },
-        {
-            method: "GET",
-            path: "/workspace/{workspace_id}/trigger_history",
-            tool_name: "getTriggerHistory",
-            description: "Get trigger execution history.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "page", type: "integer", default: 1, description: "Page number" },
-                { name: "per_page", type: "integer", default: 50, description: "Items per page" }
-            ]
-        }
-    ],
-    schemas: {
-        RequestHistoryItem: {
-            type: "object",
-            properties: {
-                id: { type: "integer" },
-                api_id: { type: "integer" },
-                verb: { type: "string" },
-                path: { type: "string" },
-                status: { type: "integer" },
-                duration_ms: { type: "integer" },
-                branch: { type: "string" },
-                request_payload: { type: "object", description: "Only if include_payload=true" },
-                response_payload: { type: "object", description: "Only if include_payload=true" },
-                created_at: { type: "string", format: "date-time" }
-            }
-        },
-        ExecutionHistoryItem: {
-            type: "object",
-            properties: {
-                id: { type: "integer" },
-                resource_id: { type: "integer" },
-                status: { type: "string", enum: ["success", "error"] },
-                duration_ms: { type: "integer" },
-                error: { type: "string" },
-                created_at: { type: "string", format: "date-time" }
-            }
-        }
-    },
-    related_topics: ["api", "function", "task"]
-};

package/dist/api_docs/topics/mcp_server.d.ts

@@ -1,2 +0,0 @@
-import type { TopicDoc } from "../types.js";
-export declare const mcpServerDoc: TopicDoc;

package/dist/api_docs/topics/mcp_server.js

@@ -1,139 +0,0 @@
-export const mcpServerDoc = {
-    topic: "mcp_server",
-    title: "MCP Server Management",
-    description: `MCP (Model Context Protocol) Servers expose tools to external AI clients like Claude Desktop, Cursor, or other MCP-compatible applications.
-
-## Key Concepts
-- MCP Servers expose Xano tools via the MCP protocol
-- External AI clients can discover and call these tools
-- Supports authentication for secure access
-- Can have triggers for event-driven invocation
-- Standardized interface for AI tool discovery
-
-## Use Cases
-- Expose Xano functionality to Claude Desktop
-- Integrate with AI IDEs like Cursor
-- Build custom AI assistants with Xano backend
-- Provide tools to any MCP-compatible client`,
-    ai_hints: `- MCP Servers expose existing tools to external clients
-- Create tools first, then create MCP server to expose them
-- Authentication settings control who can access the server
-- Use triggers to invoke actions when MCP events occur
-- Check documentation endpoint for client setup instructions`,
-    endpoints: [
-        {
-            method: "GET",
-            path: "/workspace/{workspace_id}/mcp_server",
-            tool_name: "listMcpServers",
-            description: "List all MCP servers in a workspace.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "page", type: "integer", default: 1, description: "Page number" },
-                { name: "per_page", type: "integer", default: 50, description: "Items per page" },
-                { name: "search", type: "string", description: "Search by name" },
-                { name: "include_xanoscript", type: "boolean", default: false, description: "Include XanoScript definition" }
-            ]
-        },
-        {
-            method: "GET",
-            path: "/workspace/{workspace_id}/mcp_server/{mcp_server_id}",
-            tool_name: "getMcpServer",
-            description: "Get details of a specific MCP server.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "mcp_server_id", type: "integer", required: true, in: "path", description: "MCP Server ID" },
-                { name: "include_xanoscript", type: "boolean", default: false, description: "Include XanoScript definition" }
-            ]
-        },
-        {
-            method: "POST",
-            path: "/workspace/{workspace_id}/mcp_server",
-            tool_name: "createMcpServer",
-            description: "Create a new MCP server to expose tools.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
-            ],
-            request_body: {
-                type: "application/json",
-                properties: {
-                    name: { type: "string", description: "MCP server name", required: true },
-                    description: { type: "string", description: "MCP server description" },
-                    xanoscript: { type: "string", description: "XanoScript MCP server definition", required: true }
-                }
-            },
-            example: {
-                method: "POST",
-                path: "/workspace/1/mcp_server",
-                body: {
-                    name: "my_tools",
-                    description: "MCP server exposing customer support tools",
-                    xanoscript: `mcp_server my_tools {
-  tools = [lookup_order, update_ticket, send_notification]
-  authentication {
-    type = "bearer"
-    token = env.MCP_TOKEN
-  }
-}`
-                }
-            }
-        },
-        {
-            method: "PUT",
-            path: "/workspace/{workspace_id}/mcp_server/{mcp_server_id}",
-            tool_name: "updateMcpServer",
-            description: "Update an existing MCP server.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "mcp_server_id", type: "integer", required: true, in: "path", description: "MCP Server ID" }
-            ],
-            request_body: {
-                type: "application/json",
-                properties: {
-                    name: { type: "string", description: "MCP server name" },
-                    description: { type: "string", description: "MCP server description" },
-                    xanoscript: { type: "string", description: "XanoScript MCP server definition" }
-                }
-            }
-        },
-        {
-            method: "DELETE",
-            path: "/workspace/{workspace_id}/mcp_server/{mcp_server_id}",
-            tool_name: "deleteMcpServer",
-            description: "Delete an MCP server.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "mcp_server_id", type: "integer", required: true, in: "path", description: "MCP Server ID" }
-            ]
-        },
-        {
-            method: "GET",
-            path: "/mcp_server/documentation",
-            tool_name: "getMcpDocumentation",
-            description: "Get MCP documentation for setup and syntax reference.",
-            parameters: [
-                { name: "type", type: "string", enum: ["start", "api", "function", "task", "mcp", "agent", "tool", "fs-syntax", "table", "database"], description: "Documentation type to retrieve" }
-            ]
-        }
-    ],
-    schemas: {
-        McpServer: {
-            type: "object",
-            properties: {
-                id: { type: "integer" },
-                name: { type: "string" },
-                description: { type: "string" },
-                tools: { type: "array", items: { type: "string" } },
-                authentication: {
-                    type: "object",
-                    properties: {
-                        type: { type: "string", enum: ["none", "bearer", "basic"] },
-                        token: { type: "string" }
-                    }
-                },
-                created_at: { type: "string", format: "date-time" },
-                updated_at: { type: "string", format: "date-time" }
-            }
-        }
-    },
-    related_topics: ["tool", "agent", "authentication"]
-};

package/dist/api_docs/topics/middleware.d.ts

@@ -1,2 +0,0 @@
-import type { TopicDoc } from "../types.js";
-export declare const middlewareDoc: TopicDoc;

package/dist/api_docs/topics/middleware.js

@@ -1,156 +0,0 @@
-export const middlewareDoc = {
-    topic: "middleware",
-    title: "Middleware Management",
-    description: `Middleware are request/response interceptors that run before or after API endpoints. They handle cross-cutting concerns like authentication, logging, rate limiting, and request transformation.
-
-## Key Concepts
-- Middleware runs before (pre) or after (post) API endpoints
-- Can modify requests, responses, or halt execution
-- Used for: auth validation, logging, rate limiting, CORS, etc.
-- Can be applied to specific endpoints or entire API groups
-- Support draft/publish workflow
-
-## Common Middleware Patterns
-- Authentication/authorization checks
-- Request logging and timing
-- Rate limiting
-- Request/response transformation
-- CORS handling
-- Input validation`,
-    ai_hints: `- Middleware runs on every matching request - keep it fast
-- Pre-middleware can halt execution (auth checks)
-- Post-middleware can transform responses
-- Check existing middleware before creating duplicates
-- Security settings control which endpoints use the middleware`,
-    endpoints: [
-        {
-            method: "GET",
-            path: "/workspace/{workspace_id}/middleware",
-            tool_name: "listMiddlewares",
-            description: "List all middleware in a workspace.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "page", type: "integer", default: 1, description: "Page number" },
-                { name: "per_page", type: "integer", default: 50, description: "Items per page" },
-                { name: "search", type: "string", description: "Search by name" },
-                { name: "include_xanoscript", type: "boolean", default: false, description: "Include XanoScript code" },
-                { name: "include_draft", type: "boolean", default: false, description: "Include draft versions" }
-            ]
-        },
-        {
-            method: "GET",
-            path: "/workspace/{workspace_id}/middleware/{middleware_id}",
-            tool_name: "getMiddleware",
-            description: "Get details of a specific middleware.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "middleware_id", type: "integer", required: true, in: "path", description: "Middleware ID" },
-                { name: "include_xanoscript", type: "boolean", default: false, description: "Include XanoScript code" },
-                { name: "include_draft", type: "boolean", default: false, description: "Include draft version" }
-            ]
-        },
-        {
-            method: "POST",
-            path: "/workspace/{workspace_id}/middleware",
-            tool_name: "createMiddleware",
-            description: "Create a new middleware.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
-            ],
-            request_body: {
-                type: "application/json",
-                properties: {
-                    name: { type: "string", description: "Middleware name", required: true },
-                    description: { type: "string", description: "Middleware description" },
-                    type: { type: "string", description: "pre or post", required: true },
-                    xanoscript: { type: "string", description: "XanoScript middleware definition", required: true }
-                }
-            },
-            example: {
-                method: "POST",
-                path: "/workspace/1/middleware",
-                body: {
-                    name: "rate_limiter",
-                    description: "Limit requests to 100 per minute per IP",
-                    type: "pre",
-                    xanoscript: `middleware rate_limiter {
-  stack {
-    var $key {
-      value = "ratelimit:" + $request.ip
-    }
-    var $count {
-      value = redis.incr($key)
-    }
-    if ($count == 1) {
-      redis.expire($key, 60)
-    }
-    if ($count > 100) {
-      throw(429, "Rate limit exceeded")
-    }
-  }
-}`
-                }
-            }
-        },
-        {
-            method: "PUT",
-            path: "/workspace/{workspace_id}/middleware/{middleware_id}",
-            tool_name: "updateMiddleware",
-            description: "Update an existing middleware.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "middleware_id", type: "integer", required: true, in: "path", description: "Middleware ID" },
-                { name: "publish", type: "boolean", default: true, description: "Publish changes immediately" }
-            ],
-            request_body: {
-                type: "application/json",
-                properties: {
-                    name: { type: "string", description: "Middleware name" },
-                    description: { type: "string", description: "Middleware description" },
-                    xanoscript: { type: "string", description: "XanoScript middleware definition" }
-                }
-            }
-        },
-        {
-            method: "DELETE",
-            path: "/workspace/{workspace_id}/middleware/{middleware_id}",
-            tool_name: "deleteMiddleware",
-            description: "Delete a middleware.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "middleware_id", type: "integer", required: true, in: "path", description: "Middleware ID" }
-            ]
-        },
-        {
-            method: "PUT",
-            path: "/workspace/{workspace_id}/middleware/{middleware_id}/security",
-            tool_name: "updateMiddlewareSecurity",
-            description: "Update security settings for the middleware.",
-            parameters: [
-                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
-                { name: "middleware_id", type: "integer", required: true, in: "path", description: "Middleware ID" }
-            ],
-            request_body: {
-                type: "application/json",
-                properties: {
-                    guid: { type: "string", description: "Security group GUID" }
-                }
-            }
-        }
-    ],
-    schemas: {
-        Middleware: {
-            type: "object",
-            properties: {
-                id: { type: "integer" },
-                name: { type: "string" },
-                description: { type: "string" },
-                type: { type: "string", enum: ["pre", "post"] },
-                xanoscript: { type: "string" },
-                created_at: { type: "string", format: "date-time" },
-                updated_at: { type: "string", format: "date-time" }
-            }
-        }
-    },
-    related_topics: ["api", "apigroup", "authentication"]
-};

package/dist/api_docs/topics/realtime.d.ts

@@ -1,2 +0,0 @@
-import type { TopicDoc } from "../types.js";
-export declare const realtimeDoc: TopicDoc;