@xano/developer-mcp 1.0.27 → 1.0.29

package/dist/api_docs/topics/table.js

@@ -0,0 +1,195 @@
+export const tableDoc = {
+    topic: "table",
+    title: "Database Table Management",
+    description: `Tables are the database layer in Xano. Each table has a schema (fields), indexes, and optional triggers.
+
+## Key Concepts
+- Tables store structured data with typed fields
+- Schemas define field types, validation, and defaults
+- Indexes improve query performance
+- Triggers run automatically on data changes
+- Tables can reference other tables (foreign keys)
+
+## Field Types
+- **Primitives:** int, text, bool, decimal, email, password
+- **Temporal:** timestamp, date
+- **Structured:** json, object
+- **Files:** blob (with subtypes: image, video, audio, attachment)
+- **References:** tableref, tablerefuuid (foreign keys)
+- **Special:** enum, vector, geo_* (point, polygon, etc.)`,
+    ai_hints: `- Always check existing schema before adding fields
+- Use \`tableref\` type for foreign keys to other tables
+- Consider indexes for frequently queried fields
+- Triggers run automatically - be careful with side effects
+- Use \`include_xanoscript=true\` to see full table definition`,
+    endpoints: [
+        {
+            method: "GET",
+            path: "/workspace/{workspace_id}/table",
+            tool_name: "listTables",
+            description: "List all database tables in a workspace.",
+            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 table 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" },
+                { name: "include_xanoscript", type: "boolean", default: false, description: "Include XanoScript schema definition" },
+                { name: "branch", type: "string", description: "Filter by branch name" }
+            ]
+        },
+        {
+            method: "GET",
+            path: "/workspace/{workspace_id}/table/{table_id}",
+            tool_name: "getTable",
+            description: "Get details of a specific table including schema.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "table_id", type: "integer", required: true, in: "path", description: "Table ID" },
+                { name: "include_xanoscript", type: "boolean", default: false, description: "Include XanoScript definition" }
+            ]
+        },
+        {
+            method: "POST",
+            path: "/workspace/{workspace_id}/table",
+            tool_name: "createTable",
+            description: "Create a new database table with optional schema.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
+            ],
+            request_body: {
+                type: "application/json",
+                properties: {
+                    name: { type: "string", description: "Table name", required: true },
+                    description: { type: "string", description: "Table description" },
+                    xanoscript: { type: "string", description: "XanoScript table definition with schema" }
+                }
+            },
+            example: {
+                method: "POST",
+                path: "/workspace/1/table",
+                body: {
+                    name: "users",
+                    xanoscript: `table users {
+  id int [pk, auto]
+  email text [unique]
+  name text
+  created_at timestamp [default:now]
+}`
+                }
+            }
+        },
+        {
+            method: "PUT",
+            path: "/workspace/{workspace_id}/table/{table_id}",
+            tool_name: "updateTable",
+            description: "Update table definition and schema.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "table_id", type: "integer", required: true, in: "path", description: "Table ID" }
+            ],
+            request_body: {
+                type: "application/json",
+                properties: {
+                    name: { type: "string", description: "Table name" },
+                    description: { type: "string", description: "Table description" },
+                    xanoscript: { type: "string", description: "Updated XanoScript definition" }
+                }
+            }
+        },
+        {
+            method: "DELETE",
+            path: "/workspace/{workspace_id}/table/{table_id}",
+            tool_name: "deleteTable",
+            description: "Delete a table and all its data. This action is irreversible.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "table_id", type: "integer", required: true, in: "path", description: "Table ID" }
+            ]
+        },
+        {
+            method: "POST",
+            path: "/workspace/{workspace_id}/table/{table_id}/schema",
+            tool_name: "addTableField",
+            description: "Add a new field to the table schema.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "table_id", type: "integer", required: true, in: "path", description: "Table ID" }
+            ],
+            request_body: {
+                type: "application/json",
+                properties: {
+                    name: { type: "string", description: "Field name", required: true },
+                    type: { type: "string", description: "Field type (int, text, bool, etc.)", required: true },
+                    nullable: { type: "boolean", description: "Allow null values" },
+                    default: { type: "any", description: "Default value" }
+                }
+            }
+        },
+        {
+            method: "POST",
+            path: "/workspace/{workspace_id}/table/{table_id}/index",
+            tool_name: "createTableIndex",
+            description: "Create an index on table fields for query performance.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "table_id", type: "integer", required: true, in: "path", description: "Table ID" }
+            ],
+            request_body: {
+                type: "application/json",
+                properties: {
+                    name: { type: "string", description: "Index name", required: true },
+                    type: { type: "string", description: "Index type: primary, unique, btree, search, spatial, vector", required: true },
+                    fields: { type: "array", description: "Fields to index", required: true }
+                }
+            }
+        },
+        {
+            method: "GET",
+            path: "/workspace/{workspace_id}/table/{table_id}/content",
+            tool_name: "getTableContent",
+            description: "Get table content/data (paginated).",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "table_id", type: "integer", required: true, in: "path", description: "Table ID" },
+                { name: "page", type: "integer", default: 1, description: "Page number" },
+                { name: "per_page", type: "integer", default: 50, description: "Items per page" }
+            ]
+        }
+    ],
+    schemas: {
+        Table: {
+            type: "object",
+            properties: {
+                id: { type: "integer" },
+                name: { type: "string" },
+                description: { type: "string" },
+                schema: {
+                    type: "array",
+                    items: {
+                        type: "object",
+                        properties: {
+                            name: { type: "string" },
+                            type: { type: "string" },
+                            nullable: { type: "boolean" },
+                            default: { type: "any" }
+                        }
+                    }
+                },
+                indexes: { type: "array" },
+                created_at: { type: "string", format: "date-time" },
+                updated_at: { type: "string", format: "date-time" }
+            }
+        },
+        FieldTypes: {
+            primitives: ["int", "text", "bool", "decimal", "email", "password"],
+            temporal: ["timestamp", "date"],
+            structured: ["json", "object"],
+            files: ["blob", "image", "video", "audio", "attachment"],
+            references: ["tableref", "tablerefuuid"],
+            special: ["enum", "vector", "geo_point", "geo_polygon", "geo_linestring"]
+        }
+    },
+    related_topics: ["function", "api", "workflows"]
+};

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

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

package/dist/api_docs/topics/task.js

@@ -0,0 +1,165 @@
+export const taskDoc = {
+    topic: "task",
+    title: "Scheduled Task Management",
+    description: `Tasks are scheduled jobs that run automatically based on a cron schedule. They're used for background processing, periodic data sync, automated maintenance, and more.
+
+## Key Concepts
+- Tasks run on a schedule (cron syntax)
+- No HTTP trigger - runs automatically
+- Can access databases, call functions, make external requests
+- Support draft/publish workflow
+- Restricted to paid accounts
+
+## Common Use Cases
+- Data cleanup and archiving
+- Report generation
+- External API sync
+- Notification sending
+- Cache warming`,
+    ai_hints: `- Tasks require paid account (will fail on free tier)
+- Use cron syntax for scheduling (e.g., "0 * * * *" for hourly)
+- Tasks have no HTTP inputs - all data comes from database or environment
+- Draft changes won't affect running schedule until published
+- Check task history to debug execution issues`,
+    endpoints: [
+        {
+            method: "GET",
+            path: "/workspace/{workspace_id}/task",
+            tool_name: "listTasks",
+            description: "List all scheduled tasks in a workspace.",
+            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 task 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" },
+                { name: "include_xanoscript", type: "boolean", default: false, description: "Include XanoScript code" },
+                { 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}/task/{task_id}",
+            tool_name: "getTask",
+            description: "Get details of a specific scheduled task.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "task_id", type: "integer", required: true, in: "path", description: "Task 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}/task",
+            tool_name: "createTask",
+            description: "Create a new scheduled task. Requires paid account.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
+            ],
+            request_body: {
+                type: "application/json",
+                properties: {
+                    name: { type: "string", description: "Task name", required: true },
+                    description: { type: "string", description: "Task description" },
+                    schedule: { type: "string", description: "Cron expression (e.g., '0 * * * *' for hourly)", required: true },
+                    active: { type: "boolean", description: "Whether task is active", required: true },
+                    xanoscript: { type: "string", description: "XanoScript task definition", required: true }
+                }
+            },
+            example: {
+                method: "POST",
+                path: "/workspace/1/task",
+                body: {
+                    name: "cleanup_old_sessions",
+                    description: "Delete sessions older than 30 days",
+                    schedule: "0 3 * * *",
+                    active: true,
+                    xanoscript: `task cleanup_old_sessions {
+  stack {
+    var $cutoff {
+      value = now() - 30.days
+    }
+    db.sessions.query()
+      .where("created_at", "<", $cutoff)
+      .delete()
+  }
+}`
+                }
+            }
+        },
+        {
+            method: "PUT",
+            path: "/workspace/{workspace_id}/task/{task_id}",
+            tool_name: "updateTask",
+            description: "Update an existing scheduled task.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "task_id", type: "integer", required: true, in: "path", description: "Task ID" },
+                { name: "publish", type: "boolean", default: true, description: "Publish changes immediately" }
+            ],
+            request_body: {
+                type: "application/json",
+                properties: {
+                    name: { type: "string", description: "Task name" },
+                    description: { type: "string", description: "Task description" },
+                    schedule: { type: "string", description: "Cron expression" },
+                    active: { type: "boolean", description: "Whether task is active" },
+                    xanoscript: { type: "string", description: "XanoScript task definition" }
+                }
+            }
+        },
+        {
+            method: "DELETE",
+            path: "/workspace/{workspace_id}/task/{task_id}",
+            tool_name: "deleteTask",
+            description: "Delete a scheduled task.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "task_id", type: "integer", required: true, in: "path", description: "Task ID" }
+            ]
+        },
+        {
+            method: "PUT",
+            path: "/workspace/{workspace_id}/task/{task_id}/security",
+            tool_name: "updateTaskSecurity",
+            description: "Update security settings for the task.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "task_id", type: "integer", required: true, in: "path", description: "Task ID" }
+            ],
+            request_body: {
+                type: "application/json",
+                properties: {
+                    guid: { type: "string", description: "Security group GUID" }
+                }
+            }
+        }
+    ],
+    schemas: {
+        Task: {
+            type: "object",
+            properties: {
+                id: { type: "integer" },
+                name: { type: "string" },
+                description: { type: "string" },
+                schedule: { type: "string", description: "Cron expression" },
+                active: { type: "boolean" },
+                xanoscript: { type: "string" },
+                created_at: { type: "string", format: "date-time" },
+                updated_at: { type: "string", format: "date-time" }
+            }
+        },
+        CronExamples: {
+            "every_minute": "* * * * *",
+            "every_hour": "0 * * * *",
+            "every_day_midnight": "0 0 * * *",
+            "every_day_3am": "0 3 * * *",
+            "every_monday": "0 0 * * 1",
+            "first_of_month": "0 0 1 * *"
+        }
+    },
+    related_topics: ["function", "history"]
+};

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

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

package/dist/api_docs/topics/tool.js

@@ -0,0 +1,150 @@
+export const toolDoc = {
+    topic: "tool",
+    title: "Agent Tool Management",
+    description: `Tools are callable functions that AI agents can use to perform actions. They define inputs, outputs, and the logic to execute.
+
+## Key Concepts
+- Tools are used by agents to interact with data and external systems
+- Each tool has defined inputs and outputs
+- Tools contain XanoScript logic
+- Can be shared across multiple agents
+- Support draft/publish workflow
+
+## Tool Design Best Practices
+- Clear, descriptive names (e.g., "lookup_customer", "send_email")
+- Well-defined input schemas
+- Specific, focused functionality
+- Good error handling`,
+    ai_hints: `- Create tools before creating agents that use them
+- Tool names should be descriptive verbs (lookup, create, update, send)
+- Keep tools focused on single responsibilities
+- Use \`include_xanoscript=true\` to see tool implementation
+- Tools can call other functions for code reuse`,
+    endpoints: [
+        {
+            method: "GET",
+            path: "/workspace/{workspace_id}/tool",
+            tool_name: "listTools",
+            description: "List all tools in a workspace.",
+            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 tool name" },
+                { name: "include_xanoscript", type: "boolean", default: false, description: "Include XanoScript code" },
+                { name: "include_draft", type: "boolean", default: false, description: "Include draft versions" }
+            ]
+        },
+        {
+            method: "GET",
+            path: "/workspace/{workspace_id}/tool/{tool_id}",
+            tool_name: "getTool",
+            description: "Get details of a specific tool.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "tool_id", type: "integer", required: true, in: "path", description: "Tool 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}/tool",
+            tool_name: "createTool",
+            description: "Create a new tool for agents to use.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" }
+            ],
+            request_body: {
+                type: "application/json",
+                properties: {
+                    name: { type: "string", description: "Tool name", required: true },
+                    description: { type: "string", description: "Tool description (shown to AI)" },
+                    xanoscript: { type: "string", description: "XanoScript tool definition", required: true }
+                }
+            },
+            example: {
+                method: "POST",
+                path: "/workspace/1/tool",
+                body: {
+                    name: "lookup_order",
+                    description: "Look up an order by order ID or customer email",
+                    xanoscript: `tool lookup_order {
+  input {
+    int order_id?
+    text email?
+  }
+  stack {
+    var $order {
+      value = db.orders.query()
+        .where("id", "=", $input.order_id)
+        .or("customer_email", "=", $input.email)
+        .first()
+    }
+  }
+  response = $order
+}`
+                }
+            }
+        },
+        {
+            method: "PUT",
+            path: "/workspace/{workspace_id}/tool/{tool_id}",
+            tool_name: "updateTool",
+            description: "Update an existing tool.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "tool_id", type: "integer", required: true, in: "path", description: "Tool ID" },
+                { name: "publish", type: "boolean", default: true, description: "Publish changes immediately" }
+            ],
+            request_body: {
+                type: "application/json",
+                properties: {
+                    name: { type: "string", description: "Tool name" },
+                    description: { type: "string", description: "Tool description" },
+                    xanoscript: { type: "string", description: "XanoScript tool definition" }
+                }
+            }
+        },
+        {
+            method: "DELETE",
+            path: "/workspace/{workspace_id}/tool/{tool_id}",
+            tool_name: "deleteTool",
+            description: "Delete a tool. Ensure no agents depend on it.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "tool_id", type: "integer", required: true, in: "path", description: "Tool ID" }
+            ]
+        },
+        {
+            method: "PUT",
+            path: "/workspace/{workspace_id}/tool/{tool_id}/security",
+            tool_name: "updateToolSecurity",
+            description: "Update security settings for the tool.",
+            parameters: [
+                { name: "workspace_id", type: "integer", required: true, in: "path", description: "Workspace ID" },
+                { name: "tool_id", type: "integer", required: true, in: "path", description: "Tool ID" }
+            ],
+            request_body: {
+                type: "application/json",
+                properties: {
+                    guid: { type: "string", description: "Security group GUID" }
+                }
+            }
+        }
+    ],
+    schemas: {
+        Tool: {
+            type: "object",
+            properties: {
+                id: { type: "integer" },
+                name: { type: "string" },
+                description: { type: "string" },
+                xanoscript: { type: "string" },
+                created_at: { type: "string", format: "date-time" },
+                updated_at: { type: "string", format: "date-time" }
+            }
+        }
+    },
+    related_topics: ["agent", "mcp_server", "function"]
+};

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

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

package/dist/api_docs/topics/workflows.js

@@ -0,0 +1,131 @@
+export const workflowsDoc = {
+    topic: "workflows",
+    title: "Common Workflows",
+    description: `Step-by-step guides for common multi-step tasks using the Xano Meta API.
+
+## Quick Reference
+- **Create API Endpoint**: workspace → apigroup → api
+- **Create Database Table**: workspace → table → schema → index
+- **Set Up AI Agent**: tool → agent → (optional) mcp_server
+- **Deploy Changes**: draft → test → publish`,
+    ai_hints: `- Always start by listing existing resources
+- Use workspace context to understand current state
+- Create dependencies first (tables before APIs, tools before agents)
+- Test in development branch before production
+- Export backup before major changes`,
+    patterns: [
+        {
+            name: "Create a Complete REST API",
+            description: "Set up a table with CRUD endpoints",
+            steps: [
+                "1. `GET /workspace` - Find your workspace ID",
+                "2. `POST /workspace/{id}/table` - Create the database table",
+                "3. `POST /workspace/{id}/table/{id}/schema` - Add fields to the table",
+                "4. `POST /workspace/{id}/table/{id}/index` - Add indexes for query performance",
+                "5. `GET /workspace/{id}/apigroup` - Find or create an API group",
+                "6. `POST /workspace/{id}/apigroup/{id}/api` - Create GET (list) endpoint",
+                "7. `POST /workspace/{id}/apigroup/{id}/api` - Create GET (single) endpoint",
+                "8. `POST /workspace/{id}/apigroup/{id}/api` - Create POST endpoint",
+                "9. `POST /workspace/{id}/apigroup/{id}/api` - Create PUT endpoint",
+                "10. `POST /workspace/{id}/apigroup/{id}/api` - Create DELETE endpoint"
+            ],
+            example: `// Example: Create users table and list endpoint
+
+// 1. Create table
+POST /workspace/1/table
+{
+  "name": "users",
+  "xanoscript": "table users {\\n  id int [pk, auto]\\n  email text [unique]\\n  name text\\n  created_at timestamp [default:now]\\n}"
+}
+
+// 2. Create list endpoint
+POST /workspace/1/apigroup/1/api
+{
+  "name": "listUsers",
+  "path": "/users",
+  "verb": "GET",
+  "xanoscript": "query listUsers {\\n  response = db.users.query().all()\\n}"
+}`
+        },
+        {
+            name: "Set Up an AI Agent with Tools",
+            description: "Create tools and an agent that uses them",
+            steps: [
+                "1. `GET /workspace` - Find your workspace ID",
+                "2. `POST /workspace/{id}/tool` - Create first tool",
+                "3. `POST /workspace/{id}/tool` - Create additional tools as needed",
+                "4. `POST /workspace/{id}/agent` - Create agent with tool references",
+                "5. `POST /workspace/{id}/mcp_server` (optional) - Expose via MCP"
+            ],
+            example: `// 1. Create a lookup tool
+POST /workspace/1/tool
+{
+  "name": "lookup_customer",
+  "description": "Look up customer by email or ID",
+  "xanoscript": "tool lookup_customer {\\n  input { text email? int id? }\\n  response = db.customers.query().where('email', '=', $input.email).or('id', '=', $input.id).first()\\n}"
+}
+
+// 2. Create agent
+POST /workspace/1/agent
+{
+  "name": "support_bot",
+  "xanoscript": "agent support_bot {\\n  llm {\\n    type = \\"anthropic\\"\\n    model = \\"claude-4-sonnet-20250514\\"\\n    system_prompt = \\"You help customers with their orders.\\"\\n  }\\n  tools = [lookup_customer]\\n}"
+}`
+        },
+        {
+            name: "Deploy Function Changes Safely",
+            description: "Use draft/publish workflow for safe deployments",
+            steps: [
+                "1. `GET /workspace/{id}/function/{id}?include_xanoscript=true` - Get current function",
+                "2. `PUT /workspace/{id}/function/{id}?publish=false` - Save changes as draft",
+                "3. Test the draft version in development",
+                "4. `PUT /workspace/{id}/function/{id}?publish=true` - Publish to production"
+            ]
+        },
+        {
+            name: "Create a Scheduled Data Cleanup Task",
+            description: "Set up automated data maintenance",
+            steps: [
+                "1. `GET /workspace` - Find workspace ID",
+                "2. `POST /workspace/{id}/task` - Create the task with schedule",
+                "3. Monitor via `GET /workspace/{id}/task_history`"
+            ],
+            example: `POST /workspace/1/task
+{
+  "name": "cleanup_old_sessions",
+  "schedule": "0 3 * * *",
+  "active": true,
+  "xanoscript": "task cleanup_old_sessions {\\n  stack {\\n    db.sessions.query().where('created_at', '<', now() - 30.days).delete()\\n  }\\n}"
+}`
+        },
+        {
+            name: "Export and Import Workspace",
+            description: "Backup or migrate workspace data",
+            steps: [
+                "1. `POST /workspace/{id}/export` - Export complete workspace",
+                "2. Download the export file",
+                "3. `POST /workspace/{target_id}/import` - Import to target workspace"
+            ]
+        },
+        {
+            name: "Add Authentication to API Group",
+            description: "Secure API endpoints with authentication",
+            steps: [
+                "1. `GET /workspace/{id}/apigroup/{id}` - Get API group details",
+                "2. `PUT /workspace/{id}/apigroup/{id}/security` - Set security GUID",
+                "3. Individual endpoints inherit group security unless overridden"
+            ]
+        },
+        {
+            name: "Debug a Failing API Endpoint",
+            description: "Use history to troubleshoot issues",
+            steps: [
+                "1. `POST /workspace/{id}/request_history/search` - Search for failed requests",
+                "2. Filter by status: [400, 401, 403, 404, 500]",
+                "3. Use include_payload=true to see request/response details",
+                "4. `GET /workspace/{id}/apigroup/{id}/api/{id}?include_xanoscript=true` - Review endpoint code"
+            ]
+        }
+    ],
+    related_topics: ["start", "api", "table", "function", "agent"]
+};

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

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