Apache Doris MCP Server is a Python and FastAPI-based backend service that enables clients to interact with Apache Doris databases through standardized Model Context Protocol tools. It provides capabilities for natural language to SQL conversion (NL2SQL), query execution, and metadata management, while offering enterprise-grade features including token-based authentication, real-time database validation, hot-reload configuration management, and role-based access control. The server solves the problem of securely connecting LLMs and other clients to Doris databases with multi-tenant support and zero-downtime configuration updates.
Apache Doris MCP Server exposes read-only Apache Doris capabilities to MCP
Hosts and AI agents over MCP 2026-07-28. Version 1.0 replaces a large flat
tool surface with eight stable domains and fifty-five progressively disclosed
child capabilities, while keeping runtime availability, authorization, input
schemas, output schemas, and failure behavior explicit.
The package version is 1.0.0. MCP 2026-07-28 protocol compatibility on
master is Generally Available (GA) on Streamable HTTP and stdio.
This GA statement is scoped to protocol compatibility; the Python package
classifier remains Beta, and the documented deployment limits still apply.
Before upgrading, read the 1.0 release notes, the 1.0 migration guide, and the generated 8-domain/55-child registry. The detailed release record is Issue #189.
MCP Host
-> stdio or Streamable HTTP
-> transport security and authentication
-> MCP protocol validation and authorization
-> stable domain discovery
-> route-aware Doris capability detection
-> exact child dispatch and read-only runtime
-> request-specific Doris route and RBAC
-> bounded, schema-validated result
The default hierarchical mode exposes these domains:
| Domain | Children | Responsibility |
|---|---|---|
doris_catalog | 5 | catalogs, databases, tables, table context, size |
doris_query | 7 | query, explain, profile, diagnosis, slow queries, explicit ADBC |
doris_cluster | 11 | nodes, tasks, metrics, memory, cache, compaction, workloads |
doris_pipeline | 5 | ingestion, materialized views, freshness, dependencies |
doris_search | 4 | text/vector/hybrid search, analyzers, indexes, diagnosis |
doris_governance | 8 | quality, storage, lineage, audit, UDFs, auth mapping |
doris_lakehouse | 3 | external catalogs, lakehouse tables, Variant |
doris_semantic | 12 | optional Apache Ossie grounding and MetricFlow consumption |
Call a domain with {} to discover its authorized children and exact schemas.
Call the same domain again with child_tool, arguments, and the returned
manifest_version. Hosts that cannot use progressive disclosure may set
MCP_TOOL_EXPOSURE_MODE=flat before startup; this exposes the same 55 children
under collision-free formal names and does not restore pre-1.0 aliases.
See Architecture, Request lifecycle, and Tool domains.
Requirements:
9030.Install the pinned release:
pip install doris-mcp-server==1.0.0
doris-mcp-server starts the Server. doris-mcp-client is a separate client;
the two commands are not interchangeable.
Configure a Doris route:
export DORIS_HOST=127.0.0.1
export DORIS_PORT=9030
export DORIS_USER=mcp_reader
export DORIS_PASSWORD='replace-me'
export DORIS_DATABASE=information_schema
Start Streamable HTTP on loopback:
doris-mcp-server \
--transport http \
--host 127.0.0.1 \
--port 3000
Endpoints:
POST http://127.0.0.1:3000/mcpPOST http://127.0.0.1:3000/mcp/legacyGET http://127.0.0.1:3000/liveGET http://127.0.0.1:3000/readyHosts limited to handshake-era Streamable HTTP, including Dify 1.16.1 with
MCP 2025-06-18, must set ENABLE_LEGACY_HTTP_ADAPTER=true and connect to
/mcp/legacy. The adapter changes only the protocol boundary; it preserves the
same 1.0 tools, authorization, capability gates, and read-only execution.
Or run stdio for a local Host:
doris-mcp-server --transport stdio
See the complete Quick start and Host integration guide.
doris_admin is reserved and not
registered.Read the Security and permission model and the Doris fine-grained access guide.
The Server uses deterministic manifests and errors, signed expiring cursors,
route-aware capability snapshots, bounded stale fallback, request-specific
connection routing, multi-FE failover, liveness/readiness separation, output
Schema validation, and sanitized trace propagation. Unsupported or
misconfigured capabilities remain discoverable with callable=false and fail
closed when called.
Current limits include process-local Doris-backed OAuth, explicit-only ADBC that is disabled by default and fail-closed on token-bound routes, optional read-only Ossie grounding, an optional MetricFlow compiler sidecar whose SQL must execute through the bounded MCP query runtime, and best-effort native lineage delivery. See Reliability and limits.
The root README is intentionally an entry point. The bilingual documentation system is indexed at:
Primary guides:
git clone https://github.com/apache/doris-mcp-server.git
cd doris-mcp-server
uv sync --group dev
uv run pytest
Generated artifacts must remain synchronized:
uv run python generate_tool_catalog.py --check
uv lock --check
See Contributing and verification.
Apache License 2.0. See LICENSE.txt and NOTICE.