@xano/developer-mcp 1.0.25 → 1.0.26

package/dist/cli_docs/topics/profile.js

@@ -0,0 +1,153 @@
+export const profileDoc = {
+    topic: "profile",
+    title: "Xano CLI - Profile Management",
+    description: `Profiles store your Xano credentials and context (workspace, branch, project). Multiple profiles let you switch between instances and environments.
+
+## Storage Location
+
+\`~/.xano/credentials.yaml\`
+
+## Profile Structure
+
+\`\`\`yaml
+profiles:
+  production:
+    account_origin: https://app.xano.com
+    instance_origin: https://prod-instance.xano.io
+    access_token: <token>
+    workspace: 1
+    branch: 1           # main branch
+    project: abc123     # Run project ID
+    run_base_url: https://app.dev.xano.com/
+  staging:
+    instance_origin: https://staging-instance.xano.io
+    access_token: <token>
+    workspace: 1
+    branch: 2           # staging branch
+default: production
+\`\`\``,
+    ai_hints: `**Use profiles for:**
+- Different environments (production, staging, development)
+- Multiple Xano instances
+- Team member accounts
+
+**Token security:**
+- Tokens are stored in plaintext - ensure proper file permissions
+- Use \`profile:token\` to pipe token to clipboard without exposing in terminal history
+
+**Switching contexts:**
+- Use \`-p <profile>\` flag on any command
+- Or set \`XANO_PROFILE\` environment variable
+- Or use \`profile:set-default\` to change default`,
+    related_topics: ["start", "integration"],
+    commands: [
+        {
+            name: "profile:wizard",
+            description: "Interactive setup wizard for creating a profile",
+            usage: "xano profile:wizard",
+            examples: ["xano profile:wizard"]
+        },
+        {
+            name: "profile:create",
+            description: "Create a new profile with explicit flags",
+            usage: "xano profile:create <name> -i <instance_origin> -t <token> [options]",
+            args: [
+                { name: "name", required: true, description: "Profile name" }
+            ],
+            flags: [
+                { name: "instance_origin", short: "i", type: "string", required: true, description: "Xano instance URL" },
+                { name: "access_token", short: "t", type: "string", required: true, description: "Access token" },
+                { name: "workspace", short: "w", type: "string", required: false, description: "Default workspace ID" },
+                { name: "branch", short: "b", type: "string", required: false, description: "Default branch ID" },
+                { name: "project", short: "j", type: "string", required: false, description: "Default Run project ID" }
+            ],
+            examples: [
+                "xano profile:create production -i https://x8ki.xano.io -t mytoken123",
+                "xano profile:create staging -i https://x8ki.xano.io -t mytoken -w 1 -b 2"
+            ]
+        },
+        {
+            name: "profile:list",
+            description: "List all configured profiles",
+            usage: "xano profile:list [--details]",
+            flags: [
+                { name: "details", type: "boolean", required: false, description: "Show masked tokens and full config" }
+            ],
+            examples: ["xano profile:list", "xano profile:list --details"]
+        },
+        {
+            name: "profile:edit",
+            description: "Edit an existing profile",
+            usage: "xano profile:edit <name> [options]",
+            args: [
+                { name: "name", required: true, description: "Profile name to edit" }
+            ],
+            flags: [
+                { name: "workspace", short: "w", type: "string", required: false, description: "Set workspace ID" },
+                { name: "branch", short: "b", type: "string", required: false, description: "Set branch ID" },
+                { name: "project", short: "j", type: "string", required: false, description: "Set Run project ID" },
+                { name: "remove-workspace", type: "boolean", required: false, description: "Remove workspace setting" },
+                { name: "remove-branch", type: "boolean", required: false, description: "Remove branch setting" }
+            ],
+            examples: [
+                "xano profile:edit production -w 2",
+                "xano profile:edit staging --remove-branch"
+            ]
+        },
+        {
+            name: "profile:delete",
+            description: "Delete a profile",
+            usage: "xano profile:delete <name> [--force]",
+            args: [
+                { name: "name", required: true, description: "Profile name to delete" }
+            ],
+            flags: [
+                { name: "force", type: "boolean", required: false, description: "Skip confirmation prompt" }
+            ],
+            examples: ["xano profile:delete old-profile", "xano profile:delete test --force"]
+        },
+        {
+            name: "profile:set-default",
+            description: "Set the default profile",
+            usage: "xano profile:set-default <name>",
+            args: [
+                { name: "name", required: true, description: "Profile to set as default" }
+            ],
+            examples: ["xano profile:set-default production"]
+        },
+        {
+            name: "profile:get-default",
+            description: "Show the current default profile name",
+            usage: "xano profile:get-default",
+            examples: ["xano profile:get-default"]
+        },
+        {
+            name: "profile:me",
+            description: "Display current authenticated user info",
+            usage: "xano profile:me [-p <profile>]",
+            examples: ["xano profile:me", "xano profile:me -p staging"]
+        },
+        {
+            name: "profile:token",
+            description: "Print the access token (for piping to clipboard)",
+            usage: "xano profile:token [-p <profile>]",
+            examples: [
+                "xano profile:token",
+                "xano profile:token | pbcopy  # macOS",
+                "xano profile:token | xclip   # Linux"
+            ]
+        }
+    ],
+    workflows: [
+        {
+            name: "Multi-environment Setup",
+            description: "Configure profiles for production and staging",
+            steps: [
+                "Create production profile: `xano profile:create prod -i <url> -t <token> -b 1`",
+                "Create staging profile: `xano profile:create staging -i <url> -t <token> -b 2`",
+                "Set default: `xano profile:set-default prod`",
+                "Use staging when needed: `xano workspace:pull ./code -p staging`"
+            ]
+        }
+    ]
+};

package/dist/cli_docs/topics/run.d.ts

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

package/dist/cli_docs/topics/run.js

@@ -0,0 +1,248 @@
+export const runDoc = {
+    topic: "run",
+    title: "Xano CLI - Run API Commands",
+    description: `Run commands let you execute XanoScript code, manage Run projects, sessions, environment variables, and secrets. The Run API enables serverless execution of XanoScript.
+
+## Run API Base URL
+
+\`https://app.dev.xano.com/api:run\`
+
+This is different from your instance URL used by the Meta API.`,
+    ai_hints: `**Run vs Meta API:**
+- Run API: Execute code, manage runtime environment
+- Meta API: Manage workspace resources (tables, APIs, functions)
+
+**Project context:**
+- Most run commands require a project
+- Set project in profile or use \`-j\` flag
+- Projects isolate execution environments
+
+**Execution modes:**
+- Jobs: One-time execution, returns result
+- Services: Long-running, exposes endpoints
+
+**Environment variables:**
+- Stored per-project in Run API
+- Override at runtime with \`--env KEY=value\``,
+    related_topics: ["profile", "integration"],
+    commands: [
+        {
+            name: "run:exec",
+            description: "Execute XanoScript code",
+            usage: "xano run:exec [path] [options]",
+            args: [
+                { name: "path", required: false, description: "Path to .xs file, directory, or URL" }
+            ],
+            flags: [
+                { name: "project", short: "j", type: "string", required: false, description: "Run project ID" },
+                { name: "args", short: "a", type: "string", required: false, description: "JSON file with input arguments" },
+                { name: "env", type: "string", required: false, description: "Environment override KEY=value (repeatable)" },
+                { name: "stdin", type: "boolean", required: false, description: "Read code from stdin" },
+                { name: "edit", type: "boolean", required: false, description: "Open in $EDITOR before execution" }
+            ],
+            examples: [
+                "xano run:exec ./job.xs",
+                "xano run:exec ./job.xs -a inputs.json",
+                "xano run:exec ./job.xs --env API_KEY=secret --env DEBUG=true",
+                "echo 'var:x = 1 + 1' | xano run:exec --stdin",
+                "xano run:exec ./scripts/  # executes all .xs files as multidoc"
+            ]
+        },
+        {
+            name: "run:info",
+            description: "Analyze XanoScript without executing",
+            usage: "xano run:info [path] [options]",
+            args: [
+                { name: "path", required: false, description: "Path to .xs file" }
+            ],
+            flags: [
+                { name: "stdin", type: "boolean", required: false, description: "Read from stdin" }
+            ],
+            examples: [
+                "xano run:info ./job.xs",
+                "cat script.xs | xano run:info --stdin"
+            ]
+        },
+        {
+            name: "run:projects:list",
+            description: "List all Run projects",
+            usage: "xano run:projects:list",
+            examples: ["xano run:projects:list"]
+        },
+        {
+            name: "run:projects:create",
+            description: "Create a new Run project",
+            usage: "xano run:projects:create [options]",
+            flags: [
+                { name: "name", short: "n", type: "string", required: true, description: "Project name" },
+                { name: "description", short: "d", type: "string", required: false, description: "Project description" }
+            ],
+            examples: ["xano run:projects:create -n 'My Project' -d 'Production jobs'"]
+        },
+        {
+            name: "run:projects:update",
+            description: "Update a Run project",
+            usage: "xano run:projects:update <project_id> [options]",
+            args: [
+                { name: "project_id", required: true, description: "Project ID to update" }
+            ],
+            flags: [
+                { name: "name", short: "n", type: "string", required: false, description: "New project name" },
+                { name: "description", short: "d", type: "string", required: false, description: "New description" }
+            ],
+            examples: ["xano run:projects:update abc123 -n 'Updated Name'"]
+        },
+        {
+            name: "run:projects:delete",
+            description: "Delete a Run project",
+            usage: "xano run:projects:delete <project_id> [--force]",
+            args: [
+                { name: "project_id", required: true, description: "Project ID to delete" }
+            ],
+            flags: [
+                { name: "force", type: "boolean", required: false, description: "Skip confirmation" }
+            ],
+            examples: ["xano run:projects:delete abc123 --force"]
+        },
+        {
+            name: "run:env:list",
+            description: "List environment variables for project",
+            usage: "xano run:env:list [-j <project>]",
+            examples: ["xano run:env:list"]
+        },
+        {
+            name: "run:env:set",
+            description: "Set an environment variable",
+            usage: "xano run:env:set <name> <value> [-j <project>]",
+            args: [
+                { name: "name", required: true, description: "Variable name" },
+                { name: "value", required: true, description: "Variable value" }
+            ],
+            examples: ["xano run:env:set API_KEY sk-123456"]
+        },
+        {
+            name: "run:env:get",
+            description: "Get an environment variable value",
+            usage: "xano run:env:get <name> [-j <project>]",
+            args: [
+                { name: "name", required: true, description: "Variable name" }
+            ],
+            examples: ["xano run:env:get API_KEY"]
+        },
+        {
+            name: "run:env:delete",
+            description: "Delete an environment variable",
+            usage: "xano run:env:delete <name> [-j <project>]",
+            args: [
+                { name: "name", required: true, description: "Variable name" }
+            ],
+            examples: ["xano run:env:delete OLD_KEY"]
+        },
+        {
+            name: "run:sessions:list",
+            description: "List execution sessions",
+            usage: "xano run:sessions:list [-j <project>]",
+            examples: ["xano run:sessions:list"]
+        },
+        {
+            name: "run:sessions:get",
+            description: "Get session details",
+            usage: "xano run:sessions:get <session_id>",
+            args: [
+                { name: "session_id", required: true, description: "Session ID" }
+            ],
+            examples: ["xano run:sessions:get sess_abc123"]
+        },
+        {
+            name: "run:sessions:start",
+            description: "Start a session",
+            usage: "xano run:sessions:start <session_id>",
+            args: [
+                { name: "session_id", required: true, description: "Session ID" }
+            ],
+            examples: ["xano run:sessions:start sess_abc123"]
+        },
+        {
+            name: "run:sessions:stop",
+            description: "Stop a session",
+            usage: "xano run:sessions:stop <session_id>",
+            args: [
+                { name: "session_id", required: true, description: "Session ID" }
+            ],
+            examples: ["xano run:sessions:stop sess_abc123"]
+        },
+        {
+            name: "run:sessions:delete",
+            description: "Delete a session",
+            usage: "xano run:sessions:delete <session_id>",
+            args: [
+                { name: "session_id", required: true, description: "Session ID" }
+            ],
+            examples: ["xano run:sessions:delete sess_abc123"]
+        },
+        {
+            name: "run:secrets:list",
+            description: "List secrets",
+            usage: "xano run:secrets:list [-j <project>]",
+            examples: ["xano run:secrets:list"]
+        },
+        {
+            name: "run:secrets:set",
+            description: "Set a secret (docker registry or service account)",
+            usage: "xano run:secrets:set <name> [options]",
+            args: [
+                { name: "name", required: true, description: "Secret name" }
+            ],
+            flags: [
+                { name: "type", short: "t", type: "string", required: true, description: "Secret type: dockerconfigjson, service-account-token" }
+            ],
+            examples: ["xano run:secrets:set docker-creds -t dockerconfigjson"]
+        },
+        {
+            name: "run:secrets:get",
+            description: "Get a secret",
+            usage: "xano run:secrets:get <name>",
+            args: [
+                { name: "name", required: true, description: "Secret name" }
+            ],
+            examples: ["xano run:secrets:get docker-creds"]
+        },
+        {
+            name: "run:secrets:delete",
+            description: "Delete a secret",
+            usage: "xano run:secrets:delete <name>",
+            args: [
+                { name: "name", required: true, description: "Secret name" }
+            ],
+            examples: ["xano run:secrets:delete old-secret"]
+        }
+    ],
+    workflows: [
+        {
+            name: "Execute a Job",
+            description: "Run XanoScript code and get results",
+            steps: [
+                "Write your job in a .xs file",
+                "Execute: `xano run:exec ./job.xs`",
+                "View timing and response in output"
+            ],
+            example: `# job.xs
+job: my_job
+---
+var:result = 1 + 1
+return = var:result
+
+# Execute
+xano run:exec ./job.xs`
+        },
+        {
+            name: "Configure Environment",
+            description: "Set up environment variables for a project",
+            steps: [
+                "List existing: `xano run:env:list`",
+                "Set variables: `xano run:env:set KEY value`",
+                "Execute with overrides: `xano run:exec job.xs --env KEY=override`"
+            ]
+        }
+    ]
+};

package/dist/cli_docs/topics/start.d.ts

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

package/dist/cli_docs/topics/start.js

@@ -0,0 +1,111 @@
+export const startDoc = {
+    topic: "start",
+    title: "Xano CLI - Getting Started",
+    description: `The Xano CLI provides command-line access to manage your Xano workspaces, execute XanoScript, and interact with the Run API.
+
+> **Note:** The CLI is optional but recommended for local development workflows. Not all Xano users will have it installed. You can accomplish most tasks using the Meta API directly, but the CLI provides a more convenient developer experience for code sync and local editing.
+
+## Installation
+
+**Via npm (recommended):**
+\`\`\`bash
+npm install -g @xano/cli
+\`\`\`
+
+**Via GitHub:**
+\`\`\`bash
+git clone https://github.com/xano-inc/cli.git
+cd cli
+npm install
+npm link
+\`\`\`
+
+**Links:**
+- npm: https://www.npmjs.com/package/@xano/cli
+- GitHub: https://github.com/xano-inc/cli
+
+## Quick Setup
+
+Use the interactive wizard to configure your first profile:
+
+\`\`\`bash
+xano profile:wizard
+\`\`\`
+
+This will prompt you for:
+1. Your Xano access token (from Settings > Access Tokens in dashboard)
+2. Select your instance
+3. Select a workspace
+4. Select a branch
+5. Select a Run project (optional)
+
+## Credential Storage
+
+Credentials are stored in \`~/.xano/credentials.yaml\`:
+
+\`\`\`yaml
+profiles:
+  default:
+    instance_origin: https://your-instance.xano.io
+    access_token: <your-token>
+    workspace: 1
+    branch: 1
+    project: abc123
+default: default
+\`\`\`
+
+## Global Flags
+
+All commands support:
+- \`-p, --profile <name>\` - Use a specific profile (overrides default)
+- \`-v, --verbose\` - Show detailed HTTP request/response logs
+
+## Environment Variables
+
+- \`XANO_PROFILE\` - Override the default profile
+- \`XANO_VERBOSE\` - Enable verbose logging
+
+## Command Categories
+
+| Category | Description |
+|----------|-------------|
+| \`profile:*\` | Manage authentication profiles |
+| \`workspace:*\` | Sync workspaces (pull/push) |
+| \`function:*\` | Manage functions |
+| \`run:*\` | Execute code and manage Run projects |
+| \`static_host:*\` | Deploy static sites |`,
+    ai_hints: `**Important:** The CLI is optional - not all users will have it installed. Before suggesting CLI commands, check if the user has it available or ask if they'd like to install it. The Meta API can accomplish the same tasks programmatically.
+
+**When to use CLI vs Meta API:**
+- Use CLI for: local development, code sync, quick execution, scripting
+- Use Meta API for: programmatic management, integrations, automation from code
+- If CLI not installed: Use Meta API endpoints directly
+
+**Getting started workflow (if CLI is installed):**
+1. Run \`xano profile:wizard\` to set up authentication
+2. Use \`xano workspace:pull ./code\` to download workspace code
+3. Edit .xs files locally
+4. Use \`xano workspace:push ./code\` to deploy changes
+
+**Profile selection priority:**
+1. \`-p\` flag on command
+2. \`XANO_PROFILE\` environment variable
+3. Default profile in credentials.yaml`,
+    related_topics: ["profile", "workspace", "integration"],
+    workflows: [
+        {
+            name: "Initial Setup",
+            description: "Set up the CLI for first use",
+            steps: [
+                "Install: `npm install -g @xano/cli`",
+                "Run wizard: `xano profile:wizard`",
+                "Enter your access token when prompted",
+                "Select your instance, workspace, and branch",
+                "Verify: `xano profile:me`"
+            ],
+            example: `npm install -g @xano/cli
+xano profile:wizard
+xano profile:me`
+        }
+    ]
+};

package/dist/cli_docs/topics/static_host.d.ts

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

package/dist/cli_docs/topics/static_host.js

@@ -0,0 +1,77 @@
+export const staticHostDoc = {
+    topic: "static_host",
+    title: "Xano CLI - Static Hosting",
+    description: `Static host commands let you deploy frontend builds to Xano's static hosting infrastructure.`,
+    ai_hints: `**Static hosting workflow:**
+1. Build your frontend (React, Vue, etc.)
+2. Zip the build output
+3. Upload with \`static_host:build:create\`
+
+**Use cases:**
+- Deploy SPAs built with modern frameworks
+- Host static documentation sites
+- Serve frontend that calls your Xano APIs`,
+    related_topics: ["workspace"],
+    commands: [
+        {
+            name: "static_host:list",
+            description: "List all static hosts in workspace",
+            usage: "xano static_host:list [-w <workspace>]",
+            flags: [
+                { name: "workspace", short: "w", type: "string", required: false, description: "Workspace ID" }
+            ],
+            examples: ["xano static_host:list"]
+        },
+        {
+            name: "static_host:build:create",
+            description: "Create a new build for a static host",
+            usage: "xano static_host:build:create <static_host> [options]",
+            args: [
+                { name: "static_host", required: true, description: "Static host name or ID" }
+            ],
+            flags: [
+                { name: "file", short: "f", type: "string", required: true, description: "Path to ZIP file" },
+                { name: "name", short: "n", type: "string", required: true, description: "Build name/version" },
+                { name: "description", short: "d", type: "string", required: false, description: "Build description" },
+                { name: "workspace", short: "w", type: "string", required: false, description: "Workspace ID" }
+            ],
+            examples: [
+                "xano static_host:build:create my-app -f ./build.zip -n 'v1.0.0'",
+                "xano static_host:build:create my-app -f ./dist.zip -n 'v1.1.0' -d 'Bug fixes'"
+            ]
+        },
+        {
+            name: "static_host:build:list",
+            description: "List all builds for a static host",
+            usage: "xano static_host:build:list <static_host> [-w <workspace>]",
+            args: [
+                { name: "static_host", required: true, description: "Static host name or ID" }
+            ],
+            examples: ["xano static_host:build:list my-app"]
+        },
+        {
+            name: "static_host:build:get",
+            description: "Get details of a specific build",
+            usage: "xano static_host:build:get <static_host> <build_id>",
+            args: [
+                { name: "static_host", required: true, description: "Static host name or ID" },
+                { name: "build_id", required: true, description: "Build ID" }
+            ],
+            examples: ["xano static_host:build:get my-app 12345"]
+        }
+    ],
+    workflows: [
+        {
+            name: "Deploy Frontend",
+            description: "Build and deploy a frontend application",
+            steps: [
+                "Build your app: `npm run build`",
+                "Create ZIP: `zip -r build.zip dist/`",
+                "Deploy: `xano static_host:build:create my-app -f build.zip -n 'v1.0.0'`"
+            ],
+            example: `npm run build
+zip -r build.zip dist/
+xano static_host:build:create my-frontend -f build.zip -n 'v1.0.0' -d 'Initial release'`
+        }
+    ]
+};

package/dist/cli_docs/topics/workspace.d.ts

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