API Reference Unavailable

The interactive docs could not load. This may be due to network restrictions blocking the Scalar CDN.

You can still access the raw OpenAPI spec: openapi.yaml

For machine consumers, see agents.md.

MCP Tools Reference

All 10 tools available via JSON-RPC 2.0 at https://api.opendistrict.org/mcp (legacy https://mcp.opendistrict.org/mcp). Free API key required — set Bearer $OD_API_KEY on every MCP call (mint after signup). These are the exact tools/list names; calling any other name returns MCP error -32602. Five scenario prompts are also exposed via prompts/list (follow-the-money, scan-the-courts, meeting-brief, thesis-watch, vendor-risk) — prompts are not tools.

run_sql

Execute a read-only SQL SELECT query over the data platform.

sql: string

vector_search

Semantic search over events using vector embeddings (Qdrant, Qwen3-Embedding-0.6B per ADR 0008, 1024-dim).

query: string top_k?: number

get_schema

Inspect the queryable schema — the tables and columns the run_sql tool can SELECT from.

no arguments

catalog

The semantic data catalog — curated descriptions of every queryable table and column, plus example questions and their SQL.

no arguments

unified_search

Federated semantic + lexical search across the whole platform (Qdrant vectors, ClickHouse events, Postgres full-text fallback).

query: string time_range?: object event_type?: string source_id?: string score_threshold?: number limit?: number

metrics

Tenant-level summary metrics: total events, events today, active sources, active pipelines.

no arguments

list_sources

List the tenant's data sources (name, connector_type, status, event_type, last_sync_at, last_error).

no arguments

list_pipelines

List the tenant's pipelines (name, status, schedule, source, destination, total_runs, failed_runs).

no arguments

get_topology

Return the tenant's flow topology graph (sources/flows nodes + edges).

no arguments

entity_path

Find how two entities are connected in the entity graph.

from: string to: string