@xano/developer-mcp 1.0.27 → 1.0.29

package/dist/api_docs/topics/workspace.js

@@ -0,0 +1,153 @@
+export const workspaceDoc = {
+    topic: "workspace",
+    title: "Workspace Management",
+    description: `Workspaces are the top-level container for all Xano resources. Each workspace contains databases, APIs, functions, tasks, agents, and more.
+
+## Key Operations
+- List/get workspaces
+- Export/import workspace data
+- Generate workspace context for AI
+- Get OpenAPI specifications
+- Convert between XanoScript and JSON`,
+    ai_hints: `- Use \`getWorkspaceContext\` first to understand workspace structure
+- Export before making major changes (backup)
+- Check branch before modifying (prod vs dev)
+- \`export-schema\` is lighter than \`export\` (schema only vs full data)
+- OpenAPI spec useful for understanding available endpoints`,
+    endpoints: [
+        {
+            method: "GET",
+            path: "/workspace",
+            tool_name: "listWorkspaces",
+            description: "List all accessible workspaces with pagination and filtering.",
+            parameters: [
+                { name: "page", type: "integer", default: 1, description: "Page number" },
+                { name: "per_page", type: "integer", default: 50, description: "Items per page (max 10000)" },
+                { name: "search", type: "string", description: "Search by workspace 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}",
+            tool_name: "getWorkspace",
+            description: "Get details of a specific workspace.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
+            ]
+        },
+        {
+            method: "POST",
+            path: "/workspace/{workspace_id}/export-schema",
+            tool_name: "exportWorkspaceSchema",
+            description: "Export database schemas and branch configuration only (lighter than full export).",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "password", type: "string", description: "Optional encryption password" }
+            ]
+        },
+        {
+            method: "POST",
+            path: "/workspace/{workspace_id}/export",
+            tool_name: "exportWorkspace",
+            description: "Export complete workspace data and configuration including APIs, functions, data.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "password", type: "string", description: "Optional encryption password" }
+            ]
+        },
+        {
+            method: "POST",
+            path: "/workspace/{workspace_id}/import",
+            tool_name: "importWorkspace",
+            description: "Import and restore workspace content from an export file.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
+            ],
+            request_body: {
+                type: "multipart/form-data",
+                properties: {
+                    file: { type: "file", description: "Export file to import", required: true },
+                    password: { type: "string", description: "Decryption password if encrypted" }
+                }
+            }
+        },
+        {
+            method: "POST",
+            path: "/workspace/{workspace_id}/import-schema",
+            tool_name: "importWorkspaceSchema",
+            description: "Import database schema into a new branch.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
+            ],
+            request_body: {
+                type: "multipart/form-data",
+                properties: {
+                    file: { type: "file", description: "Schema export file", required: true },
+                    password: { type: "string", description: "Decryption password if encrypted" }
+                }
+            }
+        },
+        {
+            method: "GET",
+            path: "/workspace/{workspace_id}/openapi",
+            tool_name: "getWorkspaceOpenAPI",
+            description: "Get OpenAPI v3 specification for all APIs in the workspace.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
+            ]
+        },
+        {
+            method: "GET",
+            path: "/workspace/{workspace_id}/context",
+            tool_name: "getWorkspaceContext",
+            description: "Generate complete workspace context map for AI agents. Essential for understanding workspace structure.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "format", type: "string", enum: ["json", "yaml"], default: "json", description: "Output format" },
+                { name: "user_descriptions", type: "boolean", default: false, description: "Include user-provided descriptions" },
+                { name: "ai_descriptions", type: "boolean", default: false, description: "Include AI-generated descriptions" }
+            ]
+        },
+        {
+            method: "POST",
+            path: "/workspace/{workspace_id}/convert/fromXS",
+            tool_name: "convertFromXanoScript",
+            description: "Convert XanoScript code to JSON format for programmatic manipulation.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
+            ],
+            request_body: {
+                type: "text/x-xanoscript",
+                description: "XanoScript code to convert"
+            }
+        },
+        {
+            method: "POST",
+            path: "/workspace/{workspace_id}/convert/toXS",
+            tool_name: "convertToXanoScript",
+            description: "Convert JSON to XanoScript format for human-readable code.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
+            ],
+            request_body: {
+                type: "application/json",
+                description: "JSON structure to convert to XanoScript"
+            }
+        }
+    ],
+    schemas: {
+        Workspace: {
+            type: "object",
+            properties: {
+                id: { type: "integer", description: "Unique workspace ID" },
+                name: { type: "string", description: "Workspace name" },
+                description: { type: "string", description: "Workspace description" },
+                created_at: { type: "string", format: "date-time" },
+                updated_at: { type: "string", format: "date-time" }
+            }
+        }
+    },
+    related_topics: ["apigroup", "table", "function", "branch"]
+};

package/dist/api_docs/types.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Type definitions for Xano Meta API documentation
+ */
+export type HttpMethod = "GET" | "POST" | "PUT" | "DELETE";
+export interface ParameterDoc {
+    name: string;
+    type: string;
+    required?: boolean;
+    default?: unknown;
+    description: string;
+    enum?: string[];
+    in?: "path" | "query" | "header";
+}
+export interface RequestBodyDoc {
+    type: string;
+    description?: string;
+    properties?: Record<string, {
+        type: string;
+        description?: string;
+        required?: boolean;
+    }>;
+    example?: unknown;
+}
+export interface ResponseDoc {
+    type: string;
+    description?: string;
+    properties?: Record<string, unknown>;
+}
+export interface RequestExampleDoc {
+    method: string;
+    path: string;
+    headers?: Record<string, string>;
+    body?: unknown;
+}
+export interface EndpointDoc {
+    method: HttpMethod;
+    path: string;
+    tool_name?: string;
+    description: string;
+    tags?: string[];
+    parameters?: ParameterDoc[];
+    request_body?: RequestBodyDoc;
+    response?: ResponseDoc;
+    example?: RequestExampleDoc;
+}
+export interface ExampleDoc {
+    title: string;
+    description: string;
+    request: {
+        method: string;
+        path: string;
+        headers?: Record<string, string>;
+        body?: unknown;
+    };
+    response?: unknown;
+}
+export interface PatternDoc {
+    name: string;
+    description?: string;
+    steps: string[];
+    example?: string;
+}
+export interface TopicDoc {
+    topic: string;
+    title: string;
+    description: string;
+    endpoints?: EndpointDoc[];
+    examples?: ExampleDoc[];
+    related_topics?: string[];
+    schemas?: Record<string, unknown>;
+    patterns?: PatternDoc[];
+    ai_hints?: string;
+}
+export type DetailLevel = "overview" | "detailed" | "examples";
+export interface ApiDocsArgs {
+    topic: string;
+    detail_level?: DetailLevel;
+    include_schemas?: boolean;
+}

package/dist/api_docs/types.js

@@ -0,0 +1,4 @@
+/**
+ * Type definitions for Xano Meta API documentation
+ */
+export {};

package/dist/meta_api_docs/topics/branch.js

@@ -4,22 +4,23 @@ export const branchDoc = {
     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)
+- Default branch is "v1" (cannot be deleted or renamed)
 - Branches contain separate databases and configurations
 - One branch is designated as "live" (production)
+- Create branches by cloning from existing branches
 - 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`,
+1. Create a development branch by cloning from "v1"
+2. Make and test changes on the dev branch
+3. Set the dev branch as live when ready
+4. Or merge changes back to production manually`,
     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`,
+- Cannot update/rename the "v1" branch label
+- Use "v1" as the source_branch when cloning from the default branch
+- The "live" property indicates which branch is active for API requests
+- "backup" property indicates if branch was created as a backup
+- Always verify branch before making changes (dev vs prod)`,
     endpoints: [
         {
             method: "GET",
@@ -30,11 +31,78 @@ export const branchDoc = {
                 { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
             ]
         },
+        {
+            method: "GET",
+            path: "/workspace/{workspace_id}/branch/{branch_label}",
+            tool_name: "getBranch",
+            description: "Retrieve details for a specific branch by label. Use 'v1' for the default 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 (use 'v1' for default branch)" }
+            ]
+        },
+        {
+            method: "POST",
+            path: "/workspace/{workspace_id}/branch",
+            tool_name: "createBranch",
+            description: "Create a new branch by cloning from an existing branch. Use 'v1' as source_branch for the default branch.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
+            ],
+            request_body: {
+                type: "object",
+                properties: {
+                    source_branch: { type: "string", description: "Label of the branch to clone from. Defaults to 'v1'", required: false },
+                    label: { type: "string", description: "Label for the new branch", required: true },
+                    description: { type: "string", description: "Description for the new branch", required: false },
+                    color: { type: "string", description: "Color hex code for the branch (e.g., '#ebc346')", required: false }
+                },
+                example: {
+                    source_branch: "v1",
+                    label: "feature-branch",
+                    description: "A new feature branch",
+                    color: "#ebc346"
+                }
+            }
+        },
+        {
+            method: "PUT",
+            path: "/workspace/{workspace_id}/branch/{branch_label}",
+            tool_name: "updateBranch",
+            description: "Update an existing branch's label, description, or color. Cannot update the default 'v1' branch label.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "branch_label", type: "string", required: true, in: "path", description: "Current label of the branch to update" }
+            ],
+            request_body: {
+                type: "object",
+                properties: {
+                    label: { type: "string", description: "New label for the branch", required: false },
+                    description: { type: "string", description: "New description for the branch", required: false },
+                    color: { type: "string", description: "New color hex code for the branch", required: false }
+                },
+                example: {
+                    label: "updated-branch",
+                    description: "Updated description",
+                    color: "#ff5733"
+                }
+            }
+        },
+        {
+            method: "POST",
+            path: "/workspace/{workspace_id}/branch/{branch_label}/live",
+            tool_name: "setBranchLive",
+            description: "Set a branch as the live (active) branch for the workspace. The live branch is the default branch used for API requests.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "branch_label", type: "string", required: true, in: "path", description: "Label of the branch to set as live (use 'v1' for default)" }
+            ]
+        },
         {
             method: "DELETE",
             path: "/workspace/{workspace_id}/branch/{branch_label}",
             tool_name: "deleteBranch",
-            description: "Delete a branch. Cannot delete 'v1' or the live branch.",
+            description: "Delete a branch. Cannot delete the 'v1' branch or the currently 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" }
@@ -45,9 +113,10 @@ export const branchDoc = {
         Branch: {
             type: "object",
             properties: {
+                created_at: { type: "string", format: "date-time", description: "When the branch was created" },
                 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" }
+                backup: { type: "boolean", description: "Whether this branch was created as a backup" },
+                live: { type: "boolean", description: "Whether this is the live/production branch" }
             }
         }
     },
@@ -60,12 +129,79 @@ export const branchDoc = {
                 path: "/workspace/1/branch",
                 headers: { "Authorization": "Bearer <token>" }
             },
+            response: [
+                { created_at: "2024-01-15T10:30:00Z", label: "v1", backup: false, live: true },
+                { created_at: "2024-02-01T14:20:00Z", label: "dev", backup: false, live: false },
+                { created_at: "2024-02-10T09:15:00Z", label: "staging", backup: false, live: false }
+            ]
+        },
+        {
+            title: "Get a specific branch",
+            description: "Retrieve details for a single branch",
+            request: {
+                method: "GET",
+                path: "/workspace/1/branch/dev",
+                headers: { "Authorization": "Bearer <token>" }
+            },
+            response: {
+                created_at: "2024-02-01T14:20:00Z",
+                label: "dev",
+                backup: false,
+                live: false
+            }
+        },
+        {
+            title: "Create a new branch",
+            description: "Clone from v1 to create a development branch",
+            request: {
+                method: "POST",
+                path: "/workspace/1/branch",
+                headers: { "Authorization": "Bearer <token>" },
+                body: {
+                    source_branch: "v1",
+                    label: "feature-auth",
+                    description: "Authentication feature development",
+                    color: "#ebc346"
+                }
+            },
+            response: {
+                created_at: "2024-02-11T10:00:00Z",
+                label: "feature-auth",
+                backup: false,
+                live: false
+            }
+        },
+        {
+            title: "Update a branch",
+            description: "Rename a branch and update its color",
+            request: {
+                method: "PUT",
+                path: "/workspace/1/branch/feature-auth",
+                headers: { "Authorization": "Bearer <token>" },
+                body: {
+                    label: "feature-authentication",
+                    color: "#ff5733"
+                }
+            },
+            response: {
+                created_at: "2024-02-11T10:00:00Z",
+                label: "feature-authentication",
+                backup: false
+            }
+        },
+        {
+            title: "Set branch as live",
+            description: "Make a branch the active production branch",
+            request: {
+                method: "POST",
+                path: "/workspace/1/branch/staging/live",
+                headers: { "Authorization": "Bearer <token>" }
+            },
             response: {
-                items: [
-                    { label: "v1", is_live: true },
-                    { label: "dev", is_live: false },
-                    { label: "staging", is_live: false }
-                ]
+                created_at: "2024-02-10T09:15:00Z",
+                label: "staging",
+                backup: false,
+                live: true
             }
         }
     ],

package/dist/meta_api_docs/topics/workspace.js

@@ -4,7 +4,7 @@ export const workspaceDoc = {
     description: `Workspaces are the top-level container for all Xano resources. Each workspace contains databases, APIs, functions, tasks, agents, and more.
 
 ## Key Operations
-- List/get workspaces
+- Create/list/get/update/delete workspaces
 - Export/import workspace data
 - Generate workspace context for AI
 - Get OpenAPI specifications
@@ -13,7 +13,9 @@ export const workspaceDoc = {
 - Export before making major changes (backup)
 - Check branch before modifying (prod vs dev)
 - \`export-schema\` is lighter than \`export\` (schema only vs full data)
-- OpenAPI spec useful for understanding available endpoints`,
+- OpenAPI spec useful for understanding available endpoints
+- \`deleteWorkspace\` requires user confirmation - workspaces with active tenants cannot be deleted
+- Workspace creation is limited by the package tier`,
     endpoints: [
         {
             method: "GET",
@@ -37,6 +39,38 @@ export const workspaceDoc = {
                 { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
             ]
         },
+        {
+            method: "POST",
+            path: "/workspace",
+            tool_name: "addWorkspace",
+            description: "Create a new workspace. Respects the instance workspace limit based on the package tier.",
+            parameters: [
+                { name: "name", type: "string", required: true, description: "Name of the workspace" },
+                { name: "description", type: "string", description: "Description for the workspace" }
+            ]
+        },
+        {
+            method: "PUT",
+            path: "/workspace/{workspace_id}",
+            tool_name: "updateWorkspace",
+            description: "Update an existing workspace's settings.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "ID of the workspace to update" },
+                { name: "name", type: "string", description: "New name for the workspace" },
+                { name: "description", type: "string", description: "New description for the workspace" },
+                { name: "swagger", type: "boolean", description: "Enable or disable swagger documentation" },
+                { name: "documentation.require_token", type: "boolean", description: "Whether to require a token for documentation access" }
+            ]
+        },
+        {
+            method: "DELETE",
+            path: "/workspace/{workspace_id}",
+            tool_name: "deleteWorkspace",
+            description: "Delete a workspace and all its data permanently. Cannot delete a workspace that has active tenants.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "ID of the workspace to delete" }
+            ]
+        },
         {
             method: "POST",
             path: "/workspace/{workspace_id}/export-schema",
@@ -144,6 +178,15 @@ export const workspaceDoc = {
                 id: { type: "integer", description: "Unique workspace ID" },
                 name: { type: "string", description: "Workspace name" },
                 description: { type: "string", description: "Workspace description" },
+                swagger: { type: "boolean", description: "Whether swagger documentation is enabled" },
+                documentation: {
+                    type: "object",
+                    properties: {
+                        link: { type: "string", description: "Link to the documentation" },
+                        require_token: { type: "boolean", description: "Whether a token is required for documentation access" }
+                    }
+                },
+                branch: { type: "string", description: "Current branch label" },
                 created_at: { type: "string", format: "date-time" },
                 updated_at: { type: "string", format: "date-time" }
             }

package/dist/templates/init-workspace.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Template for init_workspace tool documentation
+ * Edit this file to update the workspace initialization guide
+ */
+export interface ObjectTypeConfig {
+    type: string;
+    path: string;
+    endpoint: string;
+}
+export declare function generateInitWorkspaceTemplate(objectTypes: ObjectTypeConfig[]): string;