Quick links

Features

Query DSL, cursor pagination, auth, projections, MCP, and more.

API Reference

Interactive Scalar docs for every REST endpoint.

Error Reference

All RFC 9457 error types with examples and extension fields.

Changelog

Release history and what changed in each version.

MCP setup

Kaiban exposes a Model Context Protocol endpoint at /mcp. Connect any MCP-compatible client to get full access to boards, cards, agents, teams, and more — directly from your AI environment.

Add this to your Claude Desktop configuration file:

claude_desktop_config.json

{
  "mcpServers": {
    "kaiban-api": {
      "type": "http",
      "url": "https://gcp-dev.kaiban.io/api/v2/mcp",
      "headers": {
        "x-tenant": "<your-tenant>",
        "x-api-key": "<your-api-key>",
        "x-actor": "agent:<your-agent-alias>"
      }
    }
  }
}
Config file location: ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) · %APPDATA%\Claude\claude_desktop_config.json (Windows)

Add this to your project's .cursor/mcp.json or global Cursor MCP config:

.cursor/mcp.json

{
  "mcpServers": {
    "kaiban-api": {
      "type": "http",
      "url": "https://gcp-dev.kaiban.io/api/v2/mcp",
      "headers": {
        "x-tenant": "<your-tenant>",
        "x-api-key": "<your-api-key>",
        "x-actor": "agent:<your-agent-alias>"
      }
    }
  }
}
Open Cursor → Settings → MCP → Add server, or drop the file in your project root at .cursor/mcp.json.

Add this to your Windsurf MCP config:

~/.codeium/windsurf/mcp_config.json

{
  "mcpServers": {
    "kaiban-api": {
      "type": "http",
      "url": "https://gcp-dev.kaiban.io/api/v2/mcp",
      "headers": {
        "x-tenant": "<your-tenant>",
        "x-api-key": "<your-api-key>",
        "x-actor": "agent:<your-agent-alias>"
      }
    }
  }
}
Config file location: ~/.codeium/windsurf/mcp_config.json. Restart Windsurf after saving.

Create or update .vscode/mcp.json in your project root (requires VS Code 1.99+):

.vscode/mcp.json

{
  "servers": {
    "kaiban-api": {
      "type": "http",
      "url": "https://gcp-dev.kaiban.io/api/v2/mcp",
      "headers": {
        "x-tenant": "<your-tenant>",
        "x-api-key": "<your-api-key>",
        "x-actor": "agent:<your-agent-alias>"
      }
    }
  }
}
Alternatively add under the "mcp" key in your settings.json. Enable the MCP feature via Settings → MCP → Enable if not already active.

Add the context_servers entry to your Zed settings. Requires npx in your PATH:

~/.config/zed/settings.json

{
  "context_servers": {
    "kaiban-api": {
      "source": "custom",
      "command": {
        "path": "npx",
        "args": [
          "-y",
          "mcp-remote",
          "https://gcp-dev.kaiban.io/api/v2/mcp",
          "--header",
          "x-tenant:<your-tenant>",
          "--header",
          "x-api-key:<your-api-key>",
          "--header",
          "x-actor:agent:<your-agent-alias>"
        ]
      }
    }
  }
}
Zed routes HTTP MCP servers via mcp-remote (auto-installed via npx). Reload the assistant panel after saving the config.

Use this endpoint with any client that supports HTTP MCP transport (Streamable HTTP):

Streamable HTTP endpoint

POST https://gcp-dev.kaiban.io/api/v2/mcp
Content-Type: application/json
x-tenant: <your-tenant>
x-api-key: <your-api-key>
x-actor: agent:<your-agent-alias>
The /mcp endpoint uses Streamable HTTP transport as defined by the MCP spec. Each request is stateless — no session management required.