@xano/developer-mcp 1.0.10 → 1.0.12

package/api_docs/middleware.md

@@ -1,205 +0,0 @@
-# Middleware API
-
-Middleware are reusable code blocks that run before or after API endpoints. They add common functionality like authentication, logging, or request/response transformation.
-
-## Endpoints Overview
-
-| Method | Endpoint | Description |
-|--------|----------|-------------|
-| GET | `/workspace/{workspace_id}/middleware` | List middlewares |
-| GET | `/workspace/{workspace_id}/middleware/{middleware_id}` | Get middleware |
-| POST | `/workspace/{workspace_id}/middleware` | Create middleware |
-| PUT | `/workspace/{workspace_id}/middleware/{middleware_id}` | Update middleware |
-| DELETE | `/workspace/{workspace_id}/middleware/{middleware_id}` | Delete middleware |
-| PUT | `/workspace/{workspace_id}/middleware/{middleware_id}/security` | Update security |
-
----
-
-## List Middlewares
-
-```
-GET /workspace/{workspace_id}/middleware
-```
-
-**Query Parameters:**
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| `branch` | text | "" | Branch label |
-| `page` | int | 1 | Page number |
-| `per_page` | int | 50 | Items per page (1-10000) |
-| `search` | text | "" | Search filter |
-| `sort` | enum | "created_at" | Sort field |
-| `order` | enum | "desc" | Sort order |
-
----
-
-## Get Middleware
-
-```
-GET /workspace/{workspace_id}/middleware/{middleware_id}
-```
-
-Returns middleware definition including XanoScript.
-
----
-
-## Create Middleware
-
-```
-POST /workspace/{workspace_id}/middleware
-```
-
-**Content-Type:** `text/x-xanoscript`
-
-**Query Parameters:**
-- `branch` (text): Target branch label
-
-### XanoScript Middleware Syntax
-
-Middleware follows the same syntax as functions:
-
-```xanoscript
-middleware foo {
-  input {
-    int score
-  }
-
-  stack {
-    var $x1 {
-      value = $input.score + 1
-    }
-  }
-
-  response = $x1
-}
-```
-
-### Common Use Cases
-
-#### Authentication Check
-
-```xanoscript
-middleware auth_check {
-  input {
-    text token?
-  }
-
-  stack {
-    // Validate token
-    if $input.token == null {
-      precondition.abort {
-        status = 401
-        message = "Unauthorized"
-      }
-    }
-
-    // Decode and verify token
-    var $user {
-      value = decode_jwt($input.token)
-    }
-  }
-
-  response = $user
-}
-```
-
-#### Request Logging
-
-```xanoscript
-middleware request_logger {
-  input {
-    text endpoint
-    json body?
-  }
-
-  stack {
-    db.insert request_log {
-      data = {
-        endpoint: $input.endpoint,
-        body: $input.body,
-        timestamp: now()
-      }
-    }
-  }
-
-  response = true
-}
-```
-
-#### Rate Limiting
-
-```xanoscript
-middleware rate_limit {
-  input {
-    text client_ip
-  }
-
-  stack {
-    // Count recent requests
-    db.query rate_limit {
-      where = $db.rate_limit.ip == $input.client_ip
-        && $db.rate_limit.timestamp > now() - 60
-      return = {type: "count"}
-    }
-
-    if $rate_limit > 100 {
-      precondition.abort {
-        status = 429
-        message = "Too many requests"
-      }
-    }
-
-    // Log this request
-    db.insert rate_limit {
-      data = {ip: $input.client_ip, timestamp: now()}
-    }
-  }
-
-  response = true
-}
-```
-
-### Use Cases
-
-- Authentication and authorization
-- Request logging
-- Rate limiting
-- Request/response transformation
-- Error handling
-- CORS headers
-
----
-
-## Update Middleware
-
-```
-PUT /workspace/{workspace_id}/middleware/{middleware_id}
-```
-
-**Query Parameters:**
-- `publish` (bool, default: true): Publish changes immediately
-
-**Content-Type:** `text/x-xanoscript`
-
----
-
-## Delete Middleware
-
-```
-DELETE /workspace/{workspace_id}/middleware/{middleware_id}
-```
-
-**Warning:** This action cannot be undone. Any API groups using this middleware will no longer have it applied.
-
----
-
-## Update Middleware Security
-
-```
-PUT /workspace/{workspace_id}/middleware/{middleware_id}/security
-```
-
-**Parameters:**
-| Parameter | Type | Required | Description |
-|-----------|------|----------|-------------|
-| `guid` | text | Yes | New security GUID |

package/api_docs/realtime.md

@@ -1,153 +0,0 @@
-# Realtime API
-
-Realtime channels enable real-time bidirectional communication between clients using WebSockets. They support features like presence, message history, and private messaging.
-
-## Endpoints Overview
-
-| Method | Endpoint | Description |
-|--------|----------|-------------|
-| GET | `/workspace/{workspace_id}/realtime/channel` | List channels |
-| GET | `/workspace/{workspace_id}/realtime/channel/{channel_id}` | Get channel |
-| POST | `/workspace/{workspace_id}/realtime/channel` | Create channel |
-| PUT | `/workspace/{workspace_id}/realtime/channel/{channel_id}` | Update channel |
-| DELETE | `/workspace/{workspace_id}/realtime/channel/{channel_id}` | Delete channel |
-
----
-
-## List Realtime Channels
-
-```
-GET /workspace/{workspace_id}/realtime/channel
-```
-
-**Query Parameters:**
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| `page` | int | 1 | Page number |
-| `per_page` | int | 50 | Items per page (1-10000) |
-| `search` | text | "" | Search filter |
-| `sort` | enum | "name" | Sort field: "name" |
-| `order` | enum | "desc" | Sort order |
-
----
-
-## Get Realtime Channel
-
-```
-GET /workspace/{workspace_id}/realtime/channel/{channel_id}
-```
-
-Returns channel definition including XanoScript.
-
----
-
-## Create Realtime Channel
-
-```
-POST /workspace/{workspace_id}/realtime/channel
-```
-
-**Content-Type:** `text/x-xanoscript`
-
-### XanoScript Realtime Channel Syntax
-
-```xanoscript
-realtime_channel foo {
-  public_messaging = {active: false}
-  private_messaging = {active: false}
-  settings = {
-    anonymous_clients: false
-    nested_channels  : false
-    message_history  : 0
-    auth_channel     : false
-    presence         : false
-  }
-}
-```
-
-### Messaging Options
-
-| Field | Type | Description |
-|-------|------|-------------|
-| `public_messaging` | object | Configure public message broadcasting |
-| `private_messaging` | object | Configure private direct messages |
-
-### Settings
-
-| Field | Type | Description |
-|-------|------|-------------|
-| `anonymous_clients` | bool | Allow connections without authentication |
-| `nested_channels` | bool | Allow sub-channels (e.g., `chat/room1`) |
-| `message_history` | int | Messages to keep in history (0 = disabled) |
-| `auth_channel` | bool | Require authentication for channel access |
-| `presence` | bool | Track online/offline status of users |
-
-### Example: Chat Room Channel
-
-```xanoscript
-realtime_channel chat {
-  public_messaging = {active: true}
-  private_messaging = {active: true}
-  settings = {
-    anonymous_clients: false
-    nested_channels  : true
-    message_history  : 100
-    auth_channel     : true
-    presence         : true
-  }
-}
-```
-
-### Example: Notifications Channel
-
-```xanoscript
-realtime_channel notifications {
-  public_messaging = {active: true}
-  private_messaging = {active: false}
-  settings = {
-    anonymous_clients: false
-    nested_channels  : false
-    message_history  : 50
-    auth_channel     : true
-    presence         : false
-  }
-}
-```
-
-### Example: Public Broadcast Channel
-
-```xanoscript
-realtime_channel announcements {
-  public_messaging = {active: true}
-  private_messaging = {active: false}
-  settings = {
-    anonymous_clients: true
-    nested_channels  : false
-    message_history  : 10
-    auth_channel     : false
-    presence         : false
-  }
-}
-```
-
----
-
-## Update Realtime Channel
-
-```
-PUT /workspace/{workspace_id}/realtime/channel/{channel_id}
-```
-
-**Content-Type:** `text/x-xanoscript`
-
-Send complete channel definition.
-
----
-
-## Delete Realtime Channel
-
-```
-DELETE /workspace/{workspace_id}/realtime/channel/{channel_id}
-```
-
-**Warning:** This action cannot be undone. All connected clients will be disconnected.

package/api_docs/table.md

@@ -1,151 +0,0 @@
-# Table API
-
-Tables are database objects that store structured data. Tables are defined using XanoScript with schema definitions, indexes, and constraints.
-
-## Endpoints Overview
-
-| Method | Endpoint | Description |
-|--------|----------|-------------|
-| GET | `/workspace/{workspace_id}/table` | List all tables |
-| GET | `/workspace/{workspace_id}/table/{table_id}` | Get table details |
-| POST | `/workspace/{workspace_id}/table` | Create table |
-| PUT | `/workspace/{workspace_id}/table/{table_id}` | Update table |
-| DELETE | `/workspace/{workspace_id}/table/{table_id}` | Delete table |
-
----
-
-## List Tables
-
-```
-GET /workspace/{workspace_id}/table
-```
-
-**Query Parameters:**
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| `page` | int | 1 | Page number |
-| `per_page` | int | 50 | Items per page (1-10000) |
-| `search` | text | "" | Search filter |
-| `sort` | enum | "name" | Sort: "created_at", "updated_at", "name" |
-| `order` | enum | "asc" | Sort order: "asc", "desc" |
-
----
-
-## Get Table
-
-```
-GET /workspace/{workspace_id}/table/{table_id}
-```
-
-Returns table definition including schema, indexes, and XanoScript.
-
----
-
-## Create Table
-
-```
-POST /workspace/{workspace_id}/table
-```
-
-**Content-Type:** `text/x-xanoscript`
-
-### XanoScript Table Syntax
-
-```xanoscript
-table book {
-  schema {
-    int id
-    text title
-    text description
-  }
-
-  index = [
-    {type: "primary", field: [{name: "id"}]}
-  ]
-}
-```
-
-### Schema Field Types
-
-| Type | Description |
-|------|-------------|
-| `int` | Integer |
-| `text` | Text/string |
-| `bool` | Boolean |
-| `float` | Floating point number |
-| `timestamp` | Timestamp/datetime |
-| `date` | Date only |
-| `time` | Time only |
-| `json` | JSON object |
-| `uuid` | UUID string |
-| `enum` | Enumerated values |
-| `object` | Nested object |
-| `object[]` | Array of objects |
-
-### Field Modifiers
-
-| Modifier | Syntax | Description |
-|----------|--------|-------------|
-| Optional | `field_name?` | Nullable field |
-| Default | `default = value` | Default value |
-
-### Index Types
-
-| Type | Description |
-|------|-------------|
-| `primary` | Primary key index |
-| `unique` | Unique constraint |
-| `index` | Regular index |
-| `fulltext` | Full-text search index |
-
-### Complete Example
-
-```xanoscript
-table user {
-  schema {
-    int id
-    text email
-    text password
-    text name?
-    timestamp created_at
-    bool active default = true
-    enum role {
-      values = ["admin", "user", "guest"]
-      default = "user"
-    }
-  }
-
-  index = [
-    {type: "primary", field: [{name: "id"}]},
-    {type: "unique", field: [{name: "email"}]},
-    {type: "index", field: [{name: "created_at"}]}
-  ]
-}
-```
-
----
-
-## Update Table
-
-```
-PUT /workspace/{workspace_id}/table/{table_id}
-```
-
-**Content-Type:** `text/x-xanoscript`
-
-Send complete table definition with updated schema.
-
-**Notes:**
-- Schema changes may trigger database migrations
-- Removing fields or changing types may result in data loss
-- Adding new fields typically requires default values for existing rows
-
----
-
-## Delete Table
-
-```
-DELETE /workspace/{workspace_id}/table/{table_id}
-```
-
-**Warning:** This action cannot be undone. All data in the table will be permanently deleted.

package/api_docs/task.md

@@ -1,191 +0,0 @@
-# Task API
-
-Tasks are scheduled jobs that run automatically based on a cron-like schedule. They are defined using XanoScript.
-
-**Note:** Task functionality is restricted to paid accounts.
-
-## Endpoints Overview
-
-| Method | Endpoint | Description |
-|--------|----------|-------------|
-| GET | `/workspace/{workspace_id}/task` | List tasks |
-| GET | `/workspace/{workspace_id}/task/{task_id}` | Get task |
-| POST | `/workspace/{workspace_id}/task` | Create task |
-| PUT | `/workspace/{workspace_id}/task/{task_id}` | Update task |
-| DELETE | `/workspace/{workspace_id}/task/{task_id}` | Delete task |
-| PUT | `/workspace/{workspace_id}/task/{task_id}/security` | Update security |
-
----
-
-## List Tasks
-
-```
-GET /workspace/{workspace_id}/task
-```
-
-**Query Parameters:**
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| `branch` | text | "" | Branch label |
-| `page` | int | 1 | Page number |
-| `per_page` | int | 50 | Items per page (1-10000) |
-| `search` | text | "" | Search filter |
-| `sort` | enum | "created_at" | Sort field |
-| `order` | enum | "desc" | Sort order |
-
----
-
-## Get Task
-
-```
-GET /workspace/{workspace_id}/task/{task_id}
-```
-
-Returns task definition including schedule and XanoScript.
-
----
-
-## Create Task
-
-```
-POST /workspace/{workspace_id}/task
-```
-
-**Content-Type:** `text/x-xanoscript`
-
-**Query Parameters:**
-- `branch` (text): Target branch label
-
-### XanoScript Task Syntax
-
-```xanoscript
-task foo {
-  stack {
-    var $x1 {
-      value = 1
-    }
-  }
-
-  schedule = [{starts_on: 2025-10-28 18:03:58+0000, freq: 900}]
-}
-```
-
-### Stack Section
-
-The task logic (same syntax as functions):
-
-```xanoscript
-stack {
-  db.query user {
-    where = $db.user.active == false
-    return = {type: "list"}
-  }
-
-  foreach $user as $u {
-    // Process each user
-  }
-}
-```
-
-### Schedule Section
-
-#### Inline Format
-```xanoscript
-schedule = [{
-  starts_on: 2025-10-28 18:03:58+0000,
-  freq: 900
-}]
-```
-
-#### Block Format
-```xanoscript
-schedule {
-  events = [{
-    starts_on: 2025-07-25 20:00:12+0000,
-    freq: 900
-  }]
-}
-```
-
-### Schedule Options
-
-| Field | Description |
-|-------|-------------|
-| `starts_on` | ISO timestamp when schedule begins |
-| `freq` | Frequency in seconds between runs |
-
-### Common Frequencies
-
-| Seconds | Interval |
-|---------|----------|
-| 60 | Every minute |
-| 300 | Every 5 minutes |
-| 900 | Every 15 minutes |
-| 3600 | Every hour |
-| 86400 | Every day |
-
-### Complete Example
-
-```xanoscript
-task cleanup_expired_sessions {
-  stack {
-    // Find expired sessions
-    db.query session {
-      where = $db.session.expires_at < now()
-      return = {type: "list"}
-    }
-
-    // Delete each expired session
-    foreach $session as $s {
-      db.delete session {
-        where = $db.session.id == $s.id
-      }
-    }
-
-    var $deleted_count {
-      value = count($session)
-    }
-  }
-
-  schedule = [{
-    starts_on: 2025-01-01 00:00:00+0000,
-    freq: 3600
-  }]
-}
-```
-
----
-
-## Update Task
-
-```
-PUT /workspace/{workspace_id}/task/{task_id}
-```
-
-**Query Parameters:**
-- `publish` (bool, default: true): Publish changes immediately
-
-**Content-Type:** `text/x-xanoscript`
-
----
-
-## Delete Task
-
-```
-DELETE /workspace/{workspace_id}/task/{task_id}
-```
-
-**Warning:** This action cannot be undone.
-
----
-
-## Update Task Security
-
-```
-PUT /workspace/{workspace_id}/task/{task_id}/security
-```
-
-**Parameters:**
-| Parameter | Type | Required | Description |
-|-----------|------|----------|-------------|
-| `guid` | text | Yes | New security GUID |