@xano/developer-mcp 1.0.21 → 1.0.22

package/dist/xanoscript_docs_auto/variables.md

@@ -0,0 +1,462 @@
+---
+applyTo: "**/*.xs"
+---
+
+# Variables
+
+System variables, built-in variables, and variable operations in XanoScript.
+
+## Quick Reference
+
+| Variable | Description |
+|----------|-------------|
+| `$input.*` | Input parameters |
+| `$auth.*` | Authenticated user data |
+| `$env.*` | Environment variables |
+| `$db.*` | Database field references |
+| `$this` | Current item in loops |
+| `$error` | Error info in catch blocks |
+| `now` | Current timestamp |
+
+---
+
+## Variable Definition
+
+### Create Variable
+
+```xs
+var $name {
+  value = "initial value"
+}
+
+var $count {
+  value = 0
+}
+
+var $items {
+  value = []
+}
+
+var $config {
+  value = {
+    enabled: true,
+    limit: 100
+  }
+}
+```
+
+### Update Variable
+
+```xs
+var.update $count {
+  value = $count + 1
+}
+
+var.update $items {
+  value = $items|push:$new_item
+}
+
+var.update $config {
+  value = $config|set:"limit":200
+}
+```
+
+---
+
+## Input Variables
+
+Access parameters passed to functions, queries, and tasks:
+
+```xs
+// In function definition
+function "example" {
+  input {
+    text name
+    int age
+    json options
+  }
+  stack {
+    var $greeting {
+      value = "Hello, " ~ $input.name
+    }
+
+    var $birth_year {
+      value = now|timestamp_year - $input.age
+    }
+
+    var $limit {
+      value = $input.options.limit ?? 10
+    }
+  }
+}
+```
+
+### Accessing Nested Input
+
+```xs
+$input.user.name
+$input.settings.theme
+$input.items|first
+$input.data|get:"key"
+```
+
+---
+
+## Auth Variables
+
+Access authenticated user data:
+
+```xs
+$auth.id              // User ID
+$auth.role            // User role
+$auth.email           // User email
+$auth.name            // User name
+```
+
+### Check Authentication
+
+```xs
+conditional {
+  if ($auth != null) {
+    // User is authenticated
+    var $user_id { value = $auth.id }
+  }
+  else {
+    // Not authenticated
+    throw {
+      name = "Unauthorized"
+      value = "Please log in"
+      code = 401
+    }
+  }
+}
+```
+
+### Role-Based Access
+
+```xs
+precondition ($auth.role == "admin") {
+  error_type = "accessdenied"
+  error = "Admin access required"
+}
+```
+
+---
+
+## Environment Variables
+
+Access environment configuration:
+
+```xs
+$env.DATABASE_URL
+$env.API_KEY
+$env.MY_CUSTOM_VAR
+```
+
+### System Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `$env.$remote_ip` | Client IP address |
+| `$env.$remote_port` | Client port |
+| `$env.$remote_host` | Remote hostname |
+| `$env.$request_method` | HTTP method |
+| `$env.$request_uri` | Request URI |
+| `$env.$request_querystring` | Query string |
+| `$env.$http_headers` | Request headers |
+| `$env.$request_auth_token` | Auth token |
+| `$env.$datasource` | Current datasource |
+| `$env.$branch` | Current branch |
+
+### Using Environment Variables
+
+```xs
+// API configuration
+api.request {
+  url = $env.EXTERNAL_API_URL
+  headers = {
+    "Authorization": "Bearer " ~ $env.EXTERNAL_API_KEY
+  }
+}
+
+// Feature flags
+conditional {
+  if ($env.FEATURE_NEW_UI == "true") {
+    // New UI logic
+  }
+}
+```
+
+---
+
+## Database Variables
+
+Reference database fields in queries:
+
+```xs
+db.query user {
+  where = $db.user.active == true
+        && $db.user.email == $input.email
+} as $users
+```
+
+### Table References
+
+```xs
+$db.user.id
+$db.user.name
+$db.product.price
+$db.order.created_at
+```
+
+### With Filters
+
+```xs
+$db.user.name|to_lower
+$db.product.price|round:2
+$db.order.created_at|timestamp_year
+```
+
+---
+
+## Loop Variables
+
+### $this
+
+Current item in loops:
+
+```xs
+foreach ($items) {
+  each as $item {
+    debug.log { value = $item }
+    // Also accessible as $this
+    debug.log { value = $this }
+  }
+}
+```
+
+### With Index
+
+```xs
+foreach ($items) {
+  each as $item {
+    var $position { value = $this.index }
+    debug.log {
+      value = "Item " ~ $position ~ ": " ~ $item.name
+    }
+  }
+}
+```
+
+### In Map/Filter
+
+```xs
+// $$ represents current item in map/filter
+$items|map:$$.name
+$items|filter:$$.active == true
+$items|find:$$.id == $target_id
+```
+
+---
+
+## Error Variables
+
+In catch blocks:
+
+```xs
+try_catch {
+  try {
+    // Risky operation
+  }
+  catch {
+    var $error_name { value = $error.name }
+    var $error_message { value = $error.message }
+    var $error_code { value = $error.code }
+
+    debug.log {
+      value = "Error: " ~ $error.message
+    }
+  }
+}
+```
+
+---
+
+## Trigger Variables
+
+In trigger handlers:
+
+```xs
+table_trigger "example" {
+  table = user
+  event = update
+
+  stack {
+    // Old record data
+    var $old_email { value = $trigger.old.email }
+
+    // New record data
+    var $new_email { value = $trigger.new.email }
+
+    // Trigger metadata
+    var $event_type { value = $trigger.event }
+    var $table_name { value = $trigger.table }
+  }
+}
+```
+
+---
+
+## Special Values
+
+### now
+
+Current timestamp:
+
+```xs
+var $current_time { value = now }
+var $today { value = now|format_timestamp:"Y-m-d":"UTC" }
+var $yesterday { value = now|transform_timestamp:"-1 day" }
+```
+
+### null
+
+Null value:
+
+```xs
+var $empty { value = null }
+
+conditional {
+  if ($value == null) {
+    // Handle null
+  }
+}
+```
+
+### true/false
+
+Boolean values:
+
+```xs
+var $enabled { value = true }
+var $disabled { value = false }
+```
+
+---
+
+## Variable Scope
+
+### Stack Scope
+
+Variables defined in stack are available within that stack:
+
+```xs
+stack {
+  var $local { value = "visible here" }
+
+  conditional {
+    if (true) {
+      // $local is accessible here
+      debug.log { value = $local }
+    }
+  }
+}
+// $local not accessible outside stack
+```
+
+### Response Scope
+
+Variables can be returned via response:
+
+```xs
+function "example" {
+  stack {
+    var $result { value = "computed value" }
+  }
+  response = $result
+}
+```
+
+---
+
+## Common Patterns
+
+### Default Values
+
+```xs
+var $limit {
+  value = $input.limit ?? 10
+}
+
+var $name {
+  value = $input.name|first_notempty:"Anonymous"
+}
+```
+
+### Accumulating Values
+
+```xs
+var $total { value = 0 }
+
+foreach ($items) {
+  each as $item {
+    var.update $total {
+      value = $total + $item.price
+    }
+  }
+}
+```
+
+### Building Objects
+
+```xs
+var $result { value = {} }
+
+var.update $result {
+  value = $result|set:"name":$input.name
+}
+
+var.update $result {
+  value = $result|set:"timestamp":now
+}
+```
+
+### Building Arrays
+
+```xs
+var $processed { value = [] }
+
+foreach ($items) {
+  each as $item {
+    function.run "process" {
+      input = {item: $item}
+    } as $processed_item
+
+    var.update $processed {
+      value = $processed|push:$processed_item
+    }
+  }
+}
+```
+
+---
+
+## Environment Variable Access
+
+### Get All Environment Variables
+
+```xs
+util.get_env {} as $all_env
+```
+
+### Get All Input Data
+
+```xs
+util.get_all_input {} as $all_input
+```
+
+### Get All Variables
+
+```xs
+util.get_vars {} as $all_vars
+```

package/dist/xanoscript_docs_auto/version.json

@@ -0,0 +1,5 @@
+{
+  "version": "1.0.0",
+  "updated": "2026-02-07",
+  "generated_from": "xs-language-server"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xano/developer-mcp",
-  "version": "1.0.21",
+  "version": "1.0.22",
   "description": "MCP server for Xano Headless API documentation and XanoScript code validation",
   "type": "module",
   "main": "dist/index.js",
@@ -14,6 +14,9 @@
     "build": "tsc && cp -r src/xanoscript_docs dist/",
     "start": "node dist/index.js",
     "dev": "tsc && node dist/index.js",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
     "prepublishOnly": "npm run build"
   },
   "keywords": [
@@ -43,6 +46,7 @@
   "devDependencies": {
     "@types/minimatch": "^5.1.2",
     "@types/node": "^22.0.0",
-    "typescript": "^5.9.0"
+    "typescript": "^5.9.0",
+    "vitest": "^3.0.0"
   }
 }