@xano/developer-mcp 1.0.25 → 1.0.26

package/dist/cli_docs/topics/workspace.js

@@ -0,0 +1,119 @@
+export const workspaceDoc = {
+    topic: "workspace",
+    title: "Xano CLI - Workspace Operations",
+    description: `Workspace commands let you sync XanoScript code between your local filesystem and Xano. This enables version control, local editing, and CI/CD workflows.
+
+## Multidoc Format
+
+Xano uses a "multidoc" format where multiple XanoScript documents are separated by \`---\`:
+
+\`\`\`xanoscript
+# functions/auth.xs
+---
+function: validate_token
+...
+---
+function: refresh_token
+...
+\`\`\`
+
+When you pull, the CLI splits these into individual \`.xs\` files organized by type.`,
+    ai_hints: `**Key concepts:**
+- \`pull\` downloads workspace code and splits into organized .xs files
+- \`push\` combines .xs files and uploads to Xano
+- Files are organized by type: functions/, apis/, tasks/, etc.
+
+**Typical workflow:**
+1. \`xano workspace:pull ./xano-code\` - download
+2. Edit .xs files with your editor/IDE
+3. \`xano workspace:push ./xano-code\` - deploy
+
+**Version control:**
+- The pulled directory structure is git-friendly
+- Commit changes to track history
+- Use branches for different environments
+
+**Branch handling:**
+- Use \`-b\` flag or set branch in profile
+- Pull from one branch, push to another is supported`,
+    related_topics: ["start", "function", "integration"],
+    commands: [
+        {
+            name: "workspace:list",
+            description: "List all workspaces accessible to your account",
+            usage: "xano workspace:list [-p <profile>]",
+            examples: ["xano workspace:list", "xano workspace:list -p production"]
+        },
+        {
+            name: "workspace:pull",
+            description: "Download workspace code to local directory",
+            usage: "xano workspace:pull <directory> [options]",
+            args: [
+                { name: "directory", required: true, description: "Local directory to save files" }
+            ],
+            flags: [
+                { name: "workspace", short: "w", type: "string", required: false, description: "Workspace ID (uses profile default if not set)" },
+                { name: "branch", short: "b", type: "string", required: false, description: "Branch ID to pull from" },
+                { name: "env", type: "boolean", required: false, description: "Include environment variables" },
+                { name: "records", type: "boolean", required: false, description: "Include table records" }
+            ],
+            examples: [
+                "xano workspace:pull ./my-app",
+                "xano workspace:pull ./staging-code -b 2",
+                "xano workspace:pull ./backup --env --records"
+            ]
+        },
+        {
+            name: "workspace:push",
+            description: "Upload local XanoScript files to workspace",
+            usage: "xano workspace:push <directory> [options]",
+            args: [
+                { name: "directory", required: true, description: "Local directory containing .xs files" }
+            ],
+            flags: [
+                { name: "workspace", short: "w", type: "string", required: false, description: "Workspace ID (uses profile default if not set)" },
+                { name: "branch", short: "b", type: "string", required: false, description: "Branch ID to push to" }
+            ],
+            examples: [
+                "xano workspace:push ./my-app",
+                "xano workspace:push ./my-app -b 2"
+            ]
+        }
+    ],
+    workflows: [
+        {
+            name: "Local Development Cycle",
+            description: "Edit Xano code locally with your preferred tools",
+            steps: [
+                "Pull workspace: `xano workspace:pull ./code`",
+                "Edit .xs files in your IDE",
+                "Validate changes: Use xanoscript_docs MCP tool",
+                "Push changes: `xano workspace:push ./code`",
+                "Test in Xano dashboard or via API"
+            ],
+            example: `xano workspace:pull ./my-app
+# Edit files...
+xano workspace:push ./my-app`
+        },
+        {
+            name: "Version Control Setup",
+            description: "Track Xano code changes in git",
+            steps: [
+                "Pull workspace: `xano workspace:pull ./xano`",
+                "Initialize git: `cd xano && git init`",
+                "Add files: `git add . && git commit -m 'Initial import'`",
+                "Make changes and commit regularly",
+                "Push to Xano when ready: `xano workspace:push ./xano`"
+            ]
+        },
+        {
+            name: "Cross-Branch Deployment",
+            description: "Promote code from staging to production",
+            steps: [
+                "Pull from staging: `xano workspace:pull ./deploy -b staging`",
+                "Review changes",
+                "Push to production: `xano workspace:push ./deploy -b production`"
+            ]
+        }
+    ]
+};

package/dist/cli_docs/types.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Type definitions for Xano CLI documentation
+ */
+export interface CommandDoc {
+    name: string;
+    description: string;
+    usage: string;
+    flags?: FlagDoc[];
+    args?: ArgDoc[];
+    examples?: string[];
+}
+export interface FlagDoc {
+    name: string;
+    short?: string;
+    type: string;
+    required?: boolean;
+    default?: string;
+    description: string;
+}
+export interface ArgDoc {
+    name: string;
+    required?: boolean;
+    description: string;
+}
+export interface WorkflowDoc {
+    name: string;
+    description: string;
+    steps: string[];
+    example?: string;
+}
+export interface TopicDoc {
+    topic: string;
+    title: string;
+    description: string;
+    commands?: CommandDoc[];
+    workflows?: WorkflowDoc[];
+    related_topics?: string[];
+    ai_hints?: string;
+}
+export type DetailLevel = "overview" | "detailed" | "examples";
+export interface CliDocsArgs {
+    topic: string;
+    detail_level?: DetailLevel;
+}

package/dist/cli_docs/types.js

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

package/dist/index.js

@@ -9,6 +9,7 @@ import { xanoscriptParser } from "@xano/xanoscript-language-server/parser/parser
 import { getSchemeFromContent } from "@xano/xanoscript-language-server/utils.js";
 import { metaApiDocsToolDefinition, handleMetaApiDocs } from "./meta_api_docs/index.js";
 import { runApiDocsToolDefinition, handleRunApiDocs } from "./run_api_docs/index.js";
+import { cliDocsToolDefinition, handleCliDocs } from "./cli_docs/index.js";
 import { XANOSCRIPT_DOCS_V2, readXanoscriptDocsV2, getXanoscriptDocsVersion, getTopicDescriptions, } from "./xanoscript.js";
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
@@ -146,6 +147,7 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
             },
             metaApiDocsToolDefinition,
             runApiDocsToolDefinition,
+            cliDocsToolDefinition,
         ],
     };
 });
@@ -322,6 +324,46 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
             };
         }
     }
+    if (request.params.name === "cli_docs") {
+        const args = request.params.arguments;
+        if (!args?.topic) {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: "Error: 'topic' parameter is required. Use cli_docs with topic='start' for overview.",
+                    },
+                ],
+                isError: true,
+            };
+        }
+        try {
+            const documentation = handleCliDocs({
+                topic: args.topic,
+                detail_level: args.detail_level,
+            });
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: documentation,
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Error retrieving CLI documentation: ${errorMessage}`,
+                    },
+                ],
+                isError: true,
+            };
+        }
+    }
     return {
         content: [
             {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xano/developer-mcp",
-  "version": "1.0.25",
+  "version": "1.0.26",
   "description": "MCP server for Xano Headless API documentation and XanoScript code validation",
   "type": "module",
   "main": "dist/index.js",