EKOSdocs
Docs / Reference Operate

API

The public interfaces: CLI, MCP, EKL, the console's HTTP API and the Rust crates.

Surface Use Reference
MCP (JSON-RPC 2.0) over stdio, TCP, HTTP agents and tools MCP Tools
MCP through the console: POST /mcp/<tenant>/<project> with an API token agents in a team deployment; role- and scope-checked, audited MCP
CLI with --json scripts CLI Reference
ekos commands --json the command catalogue: every command, its arguments and its class CLI Reference
EKL structured queries Queries
ekos graph export (JSON / NDJSON) bulk export Output Formats
ekos check refs --format sarif integrity findings for code-scanning tools Error Codes
Rust crates embedding and extension Plugin API

The ekos binary has no HTTP REST API of its own. The web console has one under /api, built for its own UI: health (GET /api/health), workspaces and their stats, runs and their events (/api/runs/<id>/events), schedules, tenants and the audit log, and POST /api/workspaces/<id>/cli, which runs a catalogue command by its class for the signed-in role — never a shell, never an unlisted argument. It is not a stable public API.

A generated API reference for the Rust workspace can be produced from the compiled ledger itself: ekos docs generate --layout curated.