Skip to content
Xavier

Quick Start

Quick Start Guide

Section titled “Quick Start Guide”

Get Xavier running and make your first authenticated HTTP call in under 5 minutes.

The recommended local path is HTTP with curl. MCP is optional and should only be enabled when your IDE specifically needs it.

Start the Server

Section titled “Start the Server”

Run Xavier directly:

Terminal window
cargo run

Or start the container stack:

Terminal window
docker compose up -d

Then verify health:

Terminal window
curl http://localhost:8006/health

Prepare Auth

Section titled “Prepare Auth”

Non-secret runtime settings belong in config/xavier.config.json. Secrets belong in .env.

Terminal window
export XAVIER_URL="${XAVIER_URL:-http://localhost:8006}"
export XAVIER_TOKEN="${XAVIER_TOKEN:?set-a-long-random-token-first}"

Your First API Calls

Section titled “Your First API Calls”

1. Add Memory

Section titled “1. Add Memory”
Terminal window
curl -X POST "$XAVIER_URL/memory/add" \
  -H "X-Xavier-Token: $XAVIER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Xavier is a cognitive memory system for AI agents",
    "path": "test/intro",
    "metadata": {"tags": ["ai", "memory"]}
  }'

Response:

{
  "status": "ok",
  "message": "Document added to memory"
}

2. Search Memory

Section titled “2. Search Memory”
Terminal window
curl -X POST "$XAVIER_URL/memory/search" \
  -H "X-Xavier-Token: $XAVIER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "cognitive memory system",
    "limit": 5
  }'

Response:

{
  "status": "ok",
  "query": "cognitive memory system",
  "results": [
    {
      "id": "memory_abc123",
      "content": "Xavier is a cognitive memory system for AI agents",
      "path": "test/intro",
      "metadata": {"tags": ["ai", "memory"]}
    }
  ]
}

3. Query Through the Runtime

Section titled “3. Query Through the Runtime”
Terminal window
curl -X POST "$XAVIER_URL/memory/query" \
  -H "X-Xavier-Token: $XAVIER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "What is Xavier?",
    "limit": 5
  }'

4. Inspect Code Index Stats

Section titled “4. Inspect Code Index Stats”
Terminal window
curl -H "X-Xavier-Token: $XAVIER_TOKEN" \
  "$XAVIER_URL/code/stats"

Optional MCP Integration

Section titled “Optional MCP Integration”

Only use this when a local IDE or tool host requires MCP transport. For local automation and validation, stay on HTTP/curl.

Add to your OpenClaw config:

{
  "tools": {
    "mcp": {
      "servers": {
        "xavier": {
          "enabled": true,
          "url": "http://localhost:8006/mcp"
        }
      }
    }
  }
}

Next Steps

Section titled “Next Steps”