@xano/developer-mcp 1.0.20 → 1.0.22

package/dist/xanoscript_docs/workspace.md

@@ -0,0 +1,209 @@
+---
+applyTo: "workspace.xs"
+---
+
+# Workspace Configuration
+
+Configure workspace-level settings including environment variables, preferences, and realtime configuration.
+
+## Quick Reference
+
+```xs
+workspace "<name>" {
+  description = "Workspace description"
+  env = { ... }
+  acceptance = { ... }
+  preferences = { ... }
+  realtime = { ... }
+}
+```
+
+### Attributes
+| Attribute | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `description` | text | No | Human-readable workspace description |
+| `env` | object | No | Environment variable definitions |
+| `acceptance` | object | No | Terms and acceptance settings |
+| `preferences` | object | No | Workspace behavior preferences |
+| `realtime` | object | No | Realtime channel configuration |
+
+---
+
+## Basic Structure
+
+```xs
+workspace "my_project" {
+  description = "My XanoScript project workspace"
+}
+```
+
+---
+
+## Environment Variables
+
+Define environment variables accessible via `$env.<name>` in your code.
+
+```xs
+workspace "my_project" {
+  env = {
+    API_KEY: "your-api-key",
+    DATABASE_URL: "postgresql://...",
+    REDIS_URL: "redis://...",
+    ENVIRONMENT: "production"
+  }
+}
+```
+
+### Accessing Environment Variables
+
+```xs
+// In any function, query, or task
+stack {
+  var $key { value = $env.API_KEY }
+
+  api.call "external_api" {
+    url = $env.DATABASE_URL ~ "/endpoint"
+    headers = {
+      "Authorization": "Bearer " ~ $env.API_KEY
+    }
+  }
+}
+```
+
+---
+
+## Acceptance Settings
+
+Configure terms and acceptance requirements.
+
+```xs
+workspace "my_project" {
+  acceptance = {
+    ai_terms: true
+  }
+}
+```
+
+### Acceptance Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `ai_terms` | boolean | Accept AI feature terms of service |
+
+---
+
+## Preferences
+
+Configure workspace behavior and features.
+
+```xs
+workspace "my_project" {
+  preferences = {
+    internal_docs: true,
+    sql_columns: true,
+    sql_names: true,
+    track_performance: true
+  }
+}
+```
+
+### Preference Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `internal_docs` | boolean | false | Enable internal documentation generation |
+| `sql_columns` | boolean | false | Include SQL column names in output |
+| `sql_names` | boolean | false | Include SQL table names in output |
+| `track_performance` | boolean | false | Enable performance tracking and metrics |
+
+---
+
+## Realtime Configuration
+
+Configure realtime channel settings.
+
+```xs
+workspace "my_project" {
+  realtime = {
+    canonical: "my-project"
+  }
+}
+```
+
+### Realtime Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `canonical` | text | Base URL path for realtime channels |
+
+---
+
+## Complete Example
+
+```xs
+workspace "ecommerce_platform" {
+  description = "E-commerce backend workspace"
+
+  env = {
+    STRIPE_KEY: "sk_live_...",
+    SENDGRID_KEY: "SG...",
+    AWS_REGION: "us-east-1",
+    S3_BUCKET: "ecommerce-assets",
+    REDIS_URL: "redis://cache.example.com:6379"
+  }
+
+  acceptance = {
+    ai_terms: true
+  }
+
+  preferences = {
+    internal_docs: true,
+    track_performance: true
+  }
+
+  realtime = {
+    canonical: "ecommerce"
+  }
+}
+```
+
+---
+
+## File Location
+
+Workspace configuration is stored in `workspace.xs` at the root of your project.
+
+```
+project/
+├── workspace.xs           // Workspace configuration
+├── branch.xs              // Branch configuration
+├── tables/
+├── functions/
+└── apis/
+```
+
+---
+
+## Built-in Environment Variables
+
+These variables are automatically available without configuration:
+
+| Variable | Description |
+|----------|-------------|
+| `$env.$remote_ip` | Client IP address |
+| `$env.$http_headers` | Request headers array |
+| `$env.$request_uri` | Request URI |
+| `$env.$request_method` | HTTP method (GET, POST, etc.) |
+| `$env.$request_querystring` | Query string |
+| `$env.$datasource` | Current datasource |
+| `$env.$branch` | Current branch name |
+
+---
+
+## Best Practices
+
+1. **Never commit secrets** - Use environment variables for API keys and credentials
+2. **Use descriptive names** - Environment variable names should be self-documenting
+3. **Enable performance tracking** - Helps identify bottlenecks in production
+4. **Set meaningful canonical paths** - Makes realtime channel URLs predictable
+5. **Document your workspace** - Use the description field for team reference

package/dist/xanoscript_docs_auto/README.md

@@ -0,0 +1,119 @@
+# XanoScript Complete Reference
+
+XanoScript is a declarative, statically-typed scripting language for [Xano](https://xano.com). It enables developers to build API endpoints, functions, scheduled tasks, database operations, and AI agents with structured, readable syntax.
+
+## Quick Reference
+
+### Top-Level Object Types
+
+| Type | File Location | Purpose |
+|------|---------------|---------|
+| `query` | `apis/<group>/*.xs` | HTTP API endpoints with verbs, input, processing, response |
+| `function` | `functions/**/*.xs` | Reusable logic blocks with optional testing |
+| `task` | `tasks/*.xs` | Scheduled operations with cron-like triggers |
+| `table` | `tables/*.xs` | Database schema definitions |
+| `table_trigger` | `triggers/**/*.xs` | Trigger handlers for database events |
+| `agent` | `agents/**/*.xs` | AI agent definitions |
+| `tool` | `tools/**/*.xs` | Tool definitions for AI agents |
+| `mcp_server` | `mcp_servers/**/*.xs` | Model Context Protocol server definitions |
+| `middleware` | `middleware/**/*.xs` | Request/response interceptors |
+| `addon` | `addons/*.xs` | Subqueries for related data |
+| `branch` | `branch.xs` | Branch-level configuration |
+| `workspace` | `workspace.xs` | Workspace-level settings |
+| `realtime_channel` | Configuration | Real-time channel definitions |
+| `api_group` | `apis/<group>/` | Collections of related API endpoints |
+
+**Important:** Each `.xs` file must contain exactly one definition.
+
+### Block Structure
+
+```xs
+<construct> "<name>" {
+  input { ... }      // Parameters (optional)
+  stack { ... }      // Logic
+  response = $var    // Output
+}
+```
+
+### Variable Access
+
+```xs
+$input.field        // Input parameters
+$var.name           // Stack variables (in some contexts)
+$auth.id            // Authenticated user ID
+$env.MY_VAR         // Environment variable
+$db.table.field     // Database field reference (in queries)
+$this               // Current item in loops/maps
+$error              // Error information (in catch blocks)
+now                 // Current timestamp
+```
+
+### Language Blocks (Clauses)
+
+| Block | Purpose |
+|-------|---------|
+| `stack` | Container for sequential operations |
+| `input` | Define parameters with types and validation |
+| `schema` | Database table schema |
+| `response` | Specify output data |
+| `schedule` | Execution times for tasks |
+| `security` | Authentication and permissions |
+| `auth` | Authentication configuration |
+| `cache` | Caching configuration |
+| `history` | History tracking |
+| `index` | Database index definitions |
+| `test` | Test definitions |
+| `view` | View definitions |
+| `middleware` | Middleware configuration |
+
+## Workspace Structure
+
+```
+project/
+├── workspace.xs         // Workspace configuration
+├── branch.xs            // Branch configuration
+├── tables/              // Database table schemas
+├── functions/           // Reusable functions (supports subfolders)
+├── apis/
+│   └── <api-group>/     // API endpoints grouped by domain
+├── tasks/               // Scheduled jobs
+├── triggers/            // Event-driven handlers
+├── agents/              // AI agents
+├── tools/               // AI tools
+├── mcp_servers/         // MCP server definitions
+├── middleware/          // Request/response interceptors
+├── addons/              // Query addons
+├── static/              // Frontend files
+└── run/                 // Job and service configurations
+```
+
+## Comments
+
+```xs
+// Single-line comment
+/* Multi-line comment */
+var $total { value = 0 }  // Inline comment
+```
+
+## Documentation Topics
+
+| Topic | Description |
+|-------|-------------|
+| `syntax` | Expressions, operators, filters |
+| `types` | Data types and validation |
+| `operators` | Comparison, logical, math operators |
+| `filters` | Pipe filters for transformations |
+| `control-flow` | Conditionals, loops, error handling |
+| `functions` | Function definitions and calls |
+| `database` | All db.* operations |
+| `apis` | HTTP endpoint definitions |
+| `tables` | Database schema definitions |
+| `tasks` | Scheduled jobs |
+| `triggers` | Event-driven handlers |
+| `agents` | AI agent configuration |
+| `tools` | AI tools for agents |
+| `mcp-servers` | MCP server definitions |
+| `integrations` | Cloud storage, Redis, external APIs |
+| `security-functions` | Encryption, hashing, auth tokens |
+| `testing` | Unit tests and assertions |
+| `variables` | System and built-in variables |