@xano/developer-mcp 1.0.11 → 1.0.13

package/dist/api_docs/topics/api.js

@@ -0,0 +1,176 @@
+export const apiDoc = {
+    topic: "api",
+    title: "API Endpoint Management",
+    description: `API endpoints define individual HTTP routes within an API group. Each endpoint has a path, HTTP method, inputs, and XanoScript logic.
+
+## Key Concepts
+- Endpoints belong to API groups
+- Each endpoint has: method (GET/POST/PUT/DELETE), path, inputs, and stack (logic)
+- Supports path parameters like \`/users/{id}\`
+- XanoScript defines the endpoint logic`,
+    ai_hints: `- Use \`include_xanoscript=true\` to see the endpoint's implementation
+- Check existing endpoints before creating to avoid duplicates
+- Path parameters use \`{param_name}\` syntax
+- Common patterns: CRUD operations, search, authentication
+- Security settings can override group-level settings`,
+    endpoints: [
+        {
+            method: "GET",
+            path: "/workspace/{workspace_id}/apigroup/{apigroup_id}/api",
+            tool_name: "listApis",
+            description: "List all API endpoints in an API group.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "apigroup_id", type: "integer", required: true, in: "path", description: "API Group 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 or path" },
+                { name: "include_xanoscript", type: "boolean", default: false, description: "Include XanoScript code in response" },
+                { 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}/apigroup/{apigroup_id}/api/{api_id}",
+            tool_name: "getApi",
+            description: "Get details of a specific API endpoint.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "apigroup_id", type: "integer", required: true, in: "path", description: "API Group ID" },
+                { name: "api_id", type: "integer", required: true, in: "path", description: "API 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}/apigroup/{apigroup_id}/api",
+            tool_name: "createApi",
+            description: "Create a new API endpoint with XanoScript logic.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "apigroup_id", type: "integer", required: true, in: "path", description: "API Group ID" }
+            ],
+            request_body: {
+                type: "application/json",
+                properties: {
+                    name: { type: "string", description: "Endpoint name", required: true },
+                    path: { type: "string", description: "URL path (e.g., /users/{id})", required: true },
+                    verb: { type: "string", description: "HTTP method: GET, POST, PUT, DELETE", required: true },
+                    description: { type: "string", description: "Endpoint description" },
+                    xanoscript: { type: "string", description: "XanoScript code defining the endpoint logic" }
+                }
+            },
+            example: {
+                method: "POST",
+                path: "/workspace/1/apigroup/2/api",
+                body: {
+                    name: "getUsers",
+                    path: "/users",
+                    verb: "GET",
+                    xanoscript: "query getUsers {\n  response = db.users.query().all()\n}"
+                }
+            }
+        },
+        {
+            method: "PUT",
+            path: "/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}",
+            tool_name: "updateApi",
+            description: "Update an existing API endpoint.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "apigroup_id", type: "integer", required: true, in: "path", description: "API Group ID" },
+                { name: "api_id", type: "integer", required: true, in: "path", description: "API ID" },
+                { name: "publish", type: "boolean", default: true, description: "Publish changes immediately" }
+            ],
+            request_body: {
+                type: "application/json",
+                properties: {
+                    name: { type: "string", description: "Endpoint name" },
+                    path: { type: "string", description: "URL path" },
+                    verb: { type: "string", description: "HTTP method" },
+                    description: { type: "string", description: "Endpoint description" },
+                    xanoscript: { type: "string", description: "XanoScript code" }
+                }
+            }
+        },
+        {
+            method: "DELETE",
+            path: "/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}",
+            tool_name: "deleteApi",
+            description: "Delete an API endpoint.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "apigroup_id", type: "integer", required: true, in: "path", description: "API Group ID" },
+                { name: "api_id", type: "integer", required: true, in: "path", description: "API ID" }
+            ]
+        },
+        {
+            method: "PUT",
+            path: "/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}/security",
+            tool_name: "updateApiSecurity",
+            description: "Update security settings for a specific endpoint (overrides group settings).",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "apigroup_id", type: "integer", required: true, in: "path", description: "API Group ID" },
+                { name: "api_id", type: "integer", required: true, in: "path", description: "API ID" }
+            ],
+            request_body: {
+                type: "application/json",
+                properties: {
+                    guid: { type: "string", description: "Security group GUID" }
+                }
+            }
+        }
+    ],
+    schemas: {
+        Api: {
+            type: "object",
+            properties: {
+                id: { type: "integer" },
+                name: { type: "string" },
+                path: { type: "string" },
+                verb: { type: "string", enum: ["GET", "POST", "PUT", "DELETE"] },
+                description: { type: "string" },
+                xanoscript: { type: "string", description: "Only included if include_xanoscript=true" },
+                created_at: { type: "string", format: "date-time" },
+                updated_at: { type: "string", format: "date-time" }
+            }
+        }
+    },
+    examples: [
+        {
+            title: "Create a GET endpoint",
+            description: "Create a simple endpoint to list all users",
+            request: {
+                method: "POST",
+                path: "/workspace/1/apigroup/2/api",
+                body: {
+                    name: "listUsers",
+                    path: "/users",
+                    verb: "GET",
+                    xanoscript: `query listUsers {
+  input {
+    int page = 1
+    int per_page = 20
+  }
+  stack {
+    var $users {
+      value = db.users.query().paginate($input.page, $input.per_page)
+    }
+  }
+  response = $users
+}`
+                }
+            },
+            response: {
+                id: 123,
+                name: "listUsers",
+                path: "/users",
+                verb: "GET"
+            }
+        }
+    ],
+    related_topics: ["apigroup", "function", "table"]
+};

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

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

package/dist/api_docs/topics/apigroup.js

@@ -0,0 +1,124 @@
+export const apigroupDoc = {
+    topic: "apigroup",
+    title: "API Group Management",
+    description: `API Groups are collections of related REST endpoints. They provide logical grouping, shared authentication, and generate Swagger/OpenAPI documentation.
+
+## Key Concepts
+- Each workspace has one or more API groups
+- API groups contain individual API endpoints
+- Groups can have shared authentication settings
+- Each group generates its own OpenAPI/Swagger spec`,
+    ai_hints: `- List existing API groups before creating new ones
+- Use meaningful names (e.g., "public", "admin", "webhooks")
+- Security settings apply to all endpoints in the group
+- Get OpenAPI spec to understand available endpoints in a group`,
+    endpoints: [
+        {
+            method: "GET",
+            path: "/workspace/{workspace_id}/apigroup",
+            tool_name: "listApiGroups",
+            description: "List all API groups in a workspace with filtering and sorting.",
+            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: "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" }
+            ]
+        },
+        {
+            method: "GET",
+            path: "/workspace/{workspace_id}/apigroup/{apigroup_id}",
+            tool_name: "getApiGroup",
+            description: "Get details of a specific API group.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "apigroup_id", type: "integer", required: true, in: "path", description: "API Group ID" }
+            ]
+        },
+        {
+            method: "POST",
+            path: "/workspace/{workspace_id}/apigroup",
+            tool_name: "createApiGroup",
+            description: "Create a new API group in the workspace.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
+            ],
+            request_body: {
+                type: "application/json",
+                properties: {
+                    name: { type: "string", description: "API group name", required: true },
+                    description: { type: "string", description: "API group description" }
+                }
+            }
+        },
+        {
+            method: "PUT",
+            path: "/workspace/{workspace_id}/apigroup/{apigroup_id}",
+            tool_name: "updateApiGroup",
+            description: "Update an existing API group.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "apigroup_id", type: "integer", required: true, in: "path", description: "API Group ID" }
+            ],
+            request_body: {
+                type: "application/json",
+                properties: {
+                    name: { type: "string", description: "API group name" },
+                    description: { type: "string", description: "API group description" }
+                }
+            }
+        },
+        {
+            method: "DELETE",
+            path: "/workspace/{workspace_id}/apigroup/{apigroup_id}",
+            tool_name: "deleteApiGroup",
+            description: "Delete an API group and all its endpoints.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "apigroup_id", type: "integer", required: true, in: "path", description: "API Group ID" }
+            ]
+        },
+        {
+            method: "GET",
+            path: "/workspace/{workspace_id}/apigroup/{apigroup_id}/openapi",
+            tool_name: "getApiGroupOpenAPI",
+            description: "Get OpenAPI v3 specification for this API group's endpoints.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "apigroup_id", type: "integer", required: true, in: "path", description: "API Group ID" }
+            ]
+        },
+        {
+            method: "PUT",
+            path: "/workspace/{workspace_id}/apigroup/{apigroup_id}/security",
+            tool_name: "updateApiGroupSecurity",
+            description: "Update security/authentication settings for the API group.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "apigroup_id", type: "integer", required: true, in: "path", description: "API Group ID" }
+            ],
+            request_body: {
+                type: "application/json",
+                properties: {
+                    guid: { type: "string", description: "Security group GUID" }
+                }
+            }
+        }
+    ],
+    schemas: {
+        ApiGroup: {
+            type: "object",
+            properties: {
+                id: { type: "integer" },
+                name: { type: "string" },
+                description: { type: "string" },
+                swagger: { type: "boolean", description: "Whether Swagger docs are enabled" },
+                created_at: { type: "string", format: "date-time" },
+                updated_at: { type: "string", format: "date-time" }
+            }
+        }
+    },
+    related_topics: ["api", "workspace", "authentication"]
+};

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

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

package/dist/api_docs/topics/authentication.js

@@ -0,0 +1,61 @@
+export const authenticationDoc = {
+    topic: "authentication",
+    title: "Authentication & Authorization",
+    description: `The Xano Meta API uses Access Tokens for authentication and a scope-based system for authorization.
+
+## Access Tokens
+Create access tokens in the Xano dashboard under Settings > Access Tokens.
+
+Include the token in all requests:
+\`\`\`
+Authorization: Bearer <your-access-token>
+\`\`\`
+
+## Scope System
+Access is controlled through hierarchical scopes:
+
+| Scope | Values | Description |
+|-------|--------|-------------|
+| \`instance:workspace\` | read, update, create | Workspace-level permissions |
+| \`workspace:api\` | read, create, update | API management |
+| \`workspace:requesthistory\` | read | Audit/history access |
+| \`workspace:file\` | read, create | File management |
+| \`workspace:action:export\` | enabled | Export functionality |
+
+## Role Types
+- **explore**: Limited free/explore tier role
+- **paid**: Full access to all features
+
+## Current User
+Get the authenticated user's info:
+\`\`\`
+GET /auth/me
+\`\`\`
+
+Returns: id, name, email, and extras (including role and workspace access).`,
+    ai_hints: `- Always include Authorization header with Bearer token
+- Check user role before attempting paid-only operations (tasks, some exports)
+- Scope errors return 403 - check if token has required permissions
+- Use \`GET /auth/me\` to verify token and see accessible workspaces`,
+    endpoints: [
+        {
+            method: "GET",
+            path: "/auth/me",
+            tool_name: "getAuthMe",
+            description: "Get the authenticated user's information including ID, name, email, and role.",
+            response: {
+                type: "object",
+                properties: {
+                    id: { type: "integer" },
+                    name: { type: "string" },
+                    email: { type: "string" },
+                    extras: {
+                        type: "object",
+                        description: "Contains instance.membership with role and workspace access"
+                    }
+                }
+            }
+        }
+    ],
+    related_topics: ["start", "workspace"]
+};

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

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

package/dist/api_docs/topics/branch.js

@@ -0,0 +1,73 @@
+export const branchDoc = {
+    topic: "branch",
+    title: "Branch Management",
+    description: `Branches provide environment separation for your Xano workspace. Use branches for development, staging, and production environments.
+
+## Key Concepts
+- Default branch is "v1" (cannot be deleted)
+- Branches contain separate databases and configurations
+- One branch is designated as "live" (production)
+- Useful for safe development without affecting production
+- Import schema to create new branches from exports
+
+## Common Workflow
+1. Create a development branch
+2. Make and test changes on dev branch
+3. Export schema from dev
+4. Import schema to production branch`,
+    ai_hints: `- Cannot delete the "v1" branch or the live branch
+- Use branch parameter in list endpoints to filter by branch
+- Import schema creates a new branch from export file
+- Always verify branch before making changes (dev vs prod)
+- Export before major changes for backup`,
+    endpoints: [
+        {
+            method: "GET",
+            path: "/workspace/{workspace_id}/branch",
+            tool_name: "listBranches",
+            description: "List all branches in a workspace including the default 'v1' branch.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
+            ]
+        },
+        {
+            method: "DELETE",
+            path: "/workspace/{workspace_id}/branch/{branch_label}",
+            tool_name: "deleteBranch",
+            description: "Delete a branch. Cannot delete 'v1' or the live branch.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "branch_label", type: "string", required: true, in: "path", description: "Branch label/name to delete" }
+            ]
+        }
+    ],
+    schemas: {
+        Branch: {
+            type: "object",
+            properties: {
+                label: { type: "string", description: "Branch identifier (e.g., 'v1', 'dev')" },
+                is_live: { type: "boolean", description: "Whether this is the live/production branch" },
+                created_at: { type: "string", format: "date-time" }
+            }
+        }
+    },
+    examples: [
+        {
+            title: "List all branches",
+            description: "Get all branches in a workspace",
+            request: {
+                method: "GET",
+                path: "/workspace/1/branch",
+                headers: { "Authorization": "Bearer <token>" }
+            },
+            response: {
+                items: [
+                    { label: "v1", is_live: true },
+                    { label: "dev", is_live: false },
+                    { label: "staging", is_live: false }
+                ]
+            }
+        }
+    ],
+    related_topics: ["workspace", "table"]
+};

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

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

package/dist/api_docs/topics/file.js

@@ -0,0 +1,70 @@
+export const fileDoc = {
+    topic: "file",
+    title: "File Storage Management",
+    description: `Files in Xano provide storage for images, videos, audio, and other attachments used by your application.
+
+## Key Concepts
+- Files are stored in Xano's managed storage
+- Support for images, videos, audio, and general attachments
+- Files can be public or private access
+- Use in database blob fields or API responses
+- Search and filter by name, type
+
+## File Types
+- **image**: PNG, JPG, GIF, WebP, etc.
+- **video**: MP4, WebM, MOV, etc.
+- **audio**: MP3, WAV, OGG, etc.
+- **attachment**: PDF, DOC, ZIP, and other files`,
+    ai_hints: `- Files must be uploaded via multipart/form-data
+- Use public access for CDN-served static assets
+- Use private access for sensitive documents
+- Reference files in table blob fields by ID or path
+- Large file uploads may need chunked upload strategy`,
+    endpoints: [
+        {
+            method: "GET",
+            path: "/workspace/{workspace_id}/file",
+            tool_name: "listFiles",
+            description: "List all files in a workspace with filtering.",
+            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 filename" },
+                { name: "type", type: "string", enum: ["image", "video", "audio", "attachment"], description: "Filter by file type" }
+            ]
+        },
+        {
+            method: "POST",
+            path: "/workspace/{workspace_id}/file",
+            tool_name: "uploadFile",
+            description: "Upload a file to the workspace.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
+            ],
+            request_body: {
+                type: "multipart/form-data",
+                properties: {
+                    file: { type: "file", description: "File to upload", required: true },
+                    access: { type: "string", description: "Access level: public or private" }
+                }
+            }
+        }
+    ],
+    schemas: {
+        File: {
+            type: "object",
+            properties: {
+                id: { type: "integer" },
+                name: { type: "string" },
+                path: { type: "string" },
+                type: { type: "string", enum: ["image", "video", "audio", "attachment"] },
+                size: { type: "integer", description: "File size in bytes" },
+                access: { type: "string", enum: ["public", "private"] },
+                url: { type: "string", description: "Public URL if accessible" },
+                created_at: { type: "string", format: "date-time" }
+            }
+        }
+    },
+    related_topics: ["table", "api"]
+};

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

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