@xano/developer-mcp 1.0.25 → 1.0.27

package/dist/api_docs/topics/workspace.js

@@ -1,153 +0,0 @@
-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

@@ -1,79 +0,0 @@
-/**
- * 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

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

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

@@ -1,10 +0,0 @@
-/**
- * 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;

package/dist/templates/init-workspace.js

@@ -1,278 +0,0 @@
-/**
- * Template for init_workspace tool documentation
- * Edit this file to update the workspace initialization guide
- */
-export function generateInitWorkspaceTemplate(objectTypes) {
-    const objectTypesTable = objectTypes
-        .map(({ type, path, endpoint }) => `| \`${type}\` | \`${path}/\` | \`${endpoint}\` |`)
-        .join("\n");
-    return `# Xano Workspace Initialization Guide
-
-This guide explains how to set up a local development workspace that syncs with the Xano Headless API.
-
-## Directory Structure
-
-Initialize your workspace with these directories:
-
-\`\`\`
-your-project/
-├── .xano/
-│   └── registry.json      # Tracks all objects and their sync state
-├── functions/             # Custom reusable functions
-│   ├── calculate_total.xs
-│   └── validate_email.xs
-├── tables/                # Database table schemas
-│   ├── user.xs
-│   └── order.xs
-├── tasks/                 # Scheduled background tasks
-│   └── cleanup_sessions.xs
-├── apis/                  # API groups and endpoints
-│   └── auth/              # API group directory
-│       ├── api_group.xs   # Group definition
-│       ├── POST_login.xs  # Endpoint: POST /auth/login
-│       └── GET_me.xs      # Endpoint: GET /auth/me
-├── tools/                 # AI-callable tools
-├── agents/                # AI agents
-├── middlewares/           # Request/response middleware
-├── addons/                # Query addons
-├── mcp_servers/           # MCP servers
-└── realtime/              # Realtime channels
-\`\`\`
-
-## Object Types
-
-| Type | Directory | API Endpoint |
-|------|-----------|--------------|
-${objectTypesTable}
-
-## File Naming Convention
-
-Files should follow snake_case naming with the \`.xs\` extension:
-- \`{name}.xs\` - Basic format (e.g., \`calculate_total.xs\`)
-- \`{id}_{name}.xs\` - With ID prefix for disambiguation (e.g., \`42_calculate_total.xs\`)
-- API endpoints: \`{VERB}_{path}.xs\` (e.g., \`POST_login.xs\`, \`GET_users_id.xs\`)
-
-## Registry Format
-
-The \`.xano/registry.json\` file tracks the sync state between local files and the Xano API:
-
-\`\`\`json
-{
-  "workspace_id": 12345,
-  "workspace_name": "My Project",
-  "branch": "",
-  "base_url": "https://your-instance.xano.io/api:headless",
-  "created_at": "2025-01-15T10:30:00Z",
-  "updated_at": "2025-01-15T10:30:00Z",
-  "objects": [
-    {
-      "id": 1,
-      "type": "function",
-      "name": "calculate_total",
-      "path": "functions/calculate_total.xs",
-      "sha256": "abc123...",
-      "status": "unchanged",
-      "original": "ZnVuY3Rpb24gY2FsY3VsYXRlX3RvdGFsIHsgLi4uIH0=",
-      "updated_at": "2025-01-15T10:30:00Z"
-    },
-    {
-      "id": 0,
-      "type": "function",
-      "name": "new_function",
-      "path": "functions/new_function.xs",
-      "status": "new"
-    }
-  ]
-}
-\`\`\`
-
-### Registry Record Fields
-
-| Field | Description |
-|-------|-------------|
-| \`id\` | Xano object ID (0 = new, not yet synced) |
-| \`type\` | Object type (function, table, task, etc.) |
-| \`name\` | Object name extracted from XanoScript |
-| \`path\` | Relative file path from workspace root |
-| \`sha256\` | SHA256 hash of file content for change detection |
-| \`status\` | Sync status: "new", "unchanged", "changed", "deleted" |
-| \`original\` | Base64-encoded original content (for conflict detection) |
-| \`updated_at\` | Last sync timestamp |
-
-### Status Values
-
-| Status | Description |
-|--------|-------------|
-| \`new\` | Created locally, not yet pushed to Xano |
-| \`unchanged\` | In sync with remote |
-| \`changed\` | Modified locally since last sync |
-| \`deleted\` | Marked for deletion (file removed locally) |
-
-## Fetching Objects from the API
-
-Use the Headless API to fetch objects.
-
-### List Objects
-
-\`\`\`
-GET /workspace/{workspace_id}/{type}
-Headers:
-  Authorization: Bearer {token}
-
-Query Parameters:
-  - branch: Branch label (empty = live branch)
-  - page: Page number (default: 1)
-  - per_page: Items per page (default: 50, max: 10000)
-  - search: Text search filter
-  - sort: Sort field (created_at, updated_at, name)
-  - order: asc or desc
-\`\`\`
-
-### Get Single Object with XanoScript
-
-\`\`\`
-GET /workspace/{workspace_id}/{type}/{id}
-Headers:
-  Authorization: Bearer {token}
-
-Query Parameters:
-  - branch: Branch label
-\`\`\`
-
-The response includes the \`xanoscript\` field with the code content:
-\`\`\`json
-{
-  "id": 1,
-  "name": "calculate_total",
-  "xanoscript": {
-    "status": "ok",
-    "value": "function calculate_total { ... }"
-  }
-}
-\`\`\`
-
-### API Endpoints (Nested Under API Groups)
-
-**Important:** API endpoints are nested resources under API groups. You must first fetch API groups to obtain their IDs, then use those IDs to fetch the endpoints within each group.
-
-\`\`\`
-# 1. First, list API groups
-GET /workspace/{workspace_id}/apigroup
-
-# 2. Then, list endpoints for each group using the apigroup_id
-GET /workspace/{workspace_id}/apigroup/{apigroup_id}/api
-
-# 3. Get a single endpoint
-GET /workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}
-\`\`\`
-
-This hierarchical structure is reflected in the local directory layout:
-\`\`\`
-apis/
-└── auth/                  # API group (apigroup_id required)
-    ├── api_group.xs       # Group definition
-    ├── POST_login.xs      # Endpoint within this group
-    └── GET_me.xs          # Another endpoint
-\`\`\`
-
-API groups contain endpoints that share common configuration.
-
-## Pull Workflow
-
-1. **Fetch object list** from API (paginated)
-2. **For each object**, get the full definition including XanoScript
-3. **Generate file path** based on type and name
-4. **Write file** to the appropriate directory
-5. **Update registry** with object metadata and SHA256 hash
-
-### Example Pull Request Sequence
-
-\`\`\`javascript
-// 1. List all functions
-const response = await fetch(
-  \`\${baseUrl}/workspace/\${workspaceId}/function?branch=\${branch}&per_page=100\`,
-  { headers: { Authorization: \`Bearer \${token}\` } }
-);
-const { items, nextPage } = await response.json();
-
-// 2. For each function, save to file
-for (const func of items) {
-  const xanoscript = func.xanoscript?.value || '';
-  const fileName = \`\${snakeCase(func.name)}.xs\`;
-  const filePath = \`functions/\${fileName}\`;
-
-  // Write file
-  await writeFile(filePath, xanoscript);
-
-  // Add to registry
-  registry.objects.push({
-    id: func.id,
-    type: 'function',
-    name: func.name,
-    path: filePath,
-    sha256: sha256(xanoscript),
-    status: 'unchanged',
-    original: btoa(xanoscript),
-    updated_at: func.updated_at
-  });
-}
-\`\`\`
-
-## Push Workflow
-
-1. **Read registry** to find changed/new objects
-2. **For each changed file**, read content and detect changes
-3. **Create or update** via API with XanoScript content
-4. **Update registry** with new IDs and hashes
-
-### Example Push Request
-
-\`\`\`javascript
-// Create new function
-const response = await fetch(
-  \`\${baseUrl}/workspace/\${workspaceId}/function?branch=\${branch}\`,
-  {
-    method: 'POST',
-    headers: {
-      'Authorization': \`Bearer \${token}\`,
-      'Content-Type': 'text/x-xanoscript'
-    },
-    body: xanoscriptContent
-  }
-);
-
-// Update existing function
-const response = await fetch(
-  \`\${baseUrl}/workspace/\${workspaceId}/function/\${functionId}?publish=true\`,
-  {
-    method: 'PUT',
-    headers: {
-      'Authorization': \`Bearer \${token}\`,
-      'Content-Type': 'text/x-xanoscript'
-    },
-    body: xanoscriptContent
-  }
-);
-\`\`\`
-
-## XanoScript Documentation References
-
-For writing XanoScript code, use:
-
-- \`xanoscript_docs()\` - Full documentation index
-- \`xanoscript_docs({ topic: "functions" })\` - Function syntax
-- \`xanoscript_docs({ topic: "tables" })\` - Table schema syntax
-- \`xanoscript_docs({ topic: "apis" })\` - API endpoint syntax
-- \`xanoscript_docs({ topic: "syntax" })\` - Language reference
-
-## Validating XanoScript
-
-Before pushing changes, validate the XanoScript syntax:
-
-\`\`\`
-validate_xanoscript({ code: "function foo { ... }" })
-\`\`\`
-
-This will check for syntax errors and return line/column positions for any issues.
-`;
-}

package/dist/templates/xanoscript-index.d.ts

@@ -1,11 +0,0 @@
-/**
- * Template for xanoscript_docs index documentation
- * Edit this file to update the XanoScript documentation index
- *
- * NOTE: This template is currently unused. The actual documentation is served
- * directly from the XANOSCRIPT_DOCS_V2 config in index.ts.
- */
-export interface XanoscriptIndexParams {
-    version: string;
-}
-export declare function generateXanoscriptIndexTemplate(params: XanoscriptIndexParams): string;

package/dist/templates/xanoscript-index.js

@@ -1,72 +0,0 @@
-/**
- * Template for xanoscript_docs index documentation
- * Edit this file to update the XanoScript documentation index
- *
- * NOTE: This template is currently unused. The actual documentation is served
- * directly from the XANOSCRIPT_DOCS_V2 config in index.ts.
- */
-export function generateXanoscriptIndexTemplate(params) {
-    const { version } = params;
-    return `# XanoScript Documentation Index
-Version: ${version}
-
-Use \`xanoscript_docs({ topic: "<topic>" })\` to retrieve documentation.
-
-## Core Language
-| Topic | Description |
-|-------|-------------|
-| \`syntax\` | Expressions, operators, filters, system variables |
-| \`types\` | Data types, validation, input blocks |
-| \`functions\` | Reusable function stacks, async, loops |
-| \`schema\` | Runtime schema parsing and validation |
-
-## Data
-| Topic | Description |
-|-------|-------------|
-| \`tables\` | Database schema definitions with indexes and relationships |
-| \`database\` | All db.* operations: query, get, add, edit, patch, delete |
-| \`addons\` | Reusable subqueries for fetching related data |
-| \`streaming\` | Streaming data from files, requests, and responses |
-
-## APIs & Endpoints
-| Topic | Description |
-|-------|-------------|
-| \`apis\` | HTTP endpoint definitions with authentication and CRUD patterns |
-| \`tasks\` | Scheduled and cron jobs |
-| \`triggers\` | Event-driven handlers (table, realtime, workspace, agent, MCP) |
-| \`realtime\` | Real-time channels and events for push updates |
-
-## AI & Agents
-| Topic | Description |
-|-------|-------------|
-| \`agents\` | AI agent configuration with LLM providers and tools |
-| \`tools\` | AI tools for agents and MCP servers |
-| \`mcp-servers\` | MCP server definitions exposing tools |
-
-## Integrations
-| Topic | Description |
-|-------|-------------|
-| \`integrations\` | Cloud storage, Redis, security, and external APIs |
-
-## Configuration
-| Topic | Description |
-|-------|-------------|
-| \`workspace\` | Workspace-level settings: environment variables, preferences, realtime |
-| \`branch\` | Branch-level settings: middleware, history retention, visual styling |
-| \`middleware\` | Request/response interceptors for functions, queries, tasks, and tools |
-
-## Development
-| Topic | Description |
-|-------|-------------|
-| \`testing\` | Unit tests, mocks, and assertions |
-| \`debugging\` | Logging, inspecting, and debugging XanoScript execution |
-| \`frontend\` | Static frontend development and deployment |
-| \`run\` | Run job and service configurations for the Xano Job Runner |
-
-## Best Practices
-| Topic | Description |
-|-------|-------------|
-| \`performance\` | Performance optimization best practices |
-| \`security\` | Security best practices for authentication and authorization |
-`;
-}