Skip to content
Back to search

doris-mcp-server

Apache Doris MCP Server

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/apache/doris-mcp-server with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/apache/doris-mcp-server'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/apache--doris-mcp-server/badge.svg)](/listings/apache--doris-mcp-server)

HTML

<a href="/listings/apache--doris-mcp-server"><img src="/api/listings/apache--doris-mcp-server/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Requirements:

- Python 3.12 or later; - Apache Doris 2.0.0 or later; - network access to the Doris FE MySQL endpoint, normally port `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:

- MCP: `POST http://127.0.0.1:3000/mcp` - legacy MCP (opt-in): `POST http://127.0.0.1:3000/mcp/legacy` - liveness: `GET http://127.0.0.1:3000/live` - Doris-backed readiness: `GET http://127.0.0.1:3000/ready`

Hosts 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](docs/getting-started/quickstart.md) and [Host integration guide](docs/integrations/hosts.md).

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 214 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <!--
  2. Licensed to the Apache Software Foundation (ASF) under one
  3. or more contributor license agreements. See the NOTICE file
  4. distributed with this work for additional information
  5. regarding copyright ownership. The ASF licenses this file
  6. to you under the Apache License, Version 2.0 (the
  7. "License"); you may not use this file except in compliance
  8. with the License. You may obtain a copy of the License at
  9. http://www.apache.org/licenses/LICENSE-2.0
  10. Unless required by applicable law or agreed to in writing,
  11. software distributed under the License is distributed on an
  12. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  13. KIND, either express or implied. See the License for the
  14. specific language governing permissions and limitations
  15. under the License.
  16. -->
  17. # Apache Doris MCP Server
  18. [English](README.md) | [简体中文](README.zh-CN.md)
  19. Apache Doris MCP Server exposes read-only Apache Doris capabilities to MCP
  20. Hosts and AI agents over MCP `2026-07-28`. Version 1.0 replaces a large flat
  21. tool surface with eight stable domains and fifty-five progressively disclosed
  22. child capabilities, while keeping runtime availability, authorization, input
  23. schemas, output schemas, and failure behavior explicit.
  24. ## Release status
  25. The package version is `1.0.0`. MCP `2026-07-28` protocol compatibility on
  26. `master` is **Generally Available (GA)** on Streamable HTTP and stdio.
  27. This GA statement is scoped to protocol compatibility; the Python package
  28. classifier remains **Beta**, and the documented deployment limits still apply.
  29. Before upgrading, read the [1.0 release notes](docs/release-notes-1.0.0.md),
  30. the [1.0 migration guide](docs/migration-1.0.0.md), and the generated
  31. [8-domain/55-child registry](docs/tool-registry.md). The detailed release
  32. record is [Issue #189](https://github.com/apache/doris-mcp-server/issues/189).
  33. ## Architecture at a glance
  34. ```text
  35. MCP Host
  36. -> stdio or Streamable HTTP
  37. -> transport security and authentication
  38. -> MCP protocol validation and authorization
  39. -> stable domain discovery
  40. -> route-aware Doris capability detection
  41. -> exact child dispatch and read-only runtime
  42. -> request-specific Doris route and RBAC
  43. -> bounded, schema-validated result
  44. ```
  45. The default `hierarchical` mode exposes these domains:
  46. | Domain | Children | Responsibility |
  47. |---|---:|---|
  48. | `doris_catalog` | 5 | catalogs, databases, tables, table context, size |
  49. | `doris_query` | 7 | query, explain, profile, diagnosis, slow queries, explicit ADBC |
  50. | `doris_cluster` | 11 | nodes, tasks, metrics, memory, cache, compaction, workloads |
  51. | `doris_pipeline` | 5 | ingestion, materialized views, freshness, dependencies |
  52. | `doris_search` | 4 | text/vector/hybrid search, analyzers, indexes, diagnosis |
  53. | `doris_governance` | 8 | quality, storage, lineage, audit, UDFs, auth mapping |
  54. | `doris_lakehouse` | 3 | external catalogs, lakehouse tables, Variant |
  55. | `doris_semantic` | 12 | optional Apache Ossie grounding and MetricFlow consumption |
  56. Call a domain with `{}` to discover its authorized children and exact schemas.
  57. Call the same domain again with `child_tool`, `arguments`, and the returned
  58. `manifest_version`. Hosts that cannot use progressive disclosure may set
  59. `MCP_TOOL_EXPOSURE_MODE=flat` before startup; this exposes the same 55 children
  60. under collision-free formal names and does not restore pre-1.0 aliases.
  61. See [Architecture](docs/architecture/overview.md),
  62. [Request lifecycle](docs/architecture/request-lifecycle.md), and
  63. [Tool domains](docs/capabilities/tool-domains.md).
  64. ## Quick start
  65. Requirements:
  66. - Python 3.12 or later;
  67. - Apache Doris 2.0.0 or later;
  68. - network access to the Doris FE MySQL endpoint, normally port `9030`.
  69. Install the pinned release:
  70. ```bash
  71. pip install doris-mcp-server==1.0.0
  72. ```
  73. `doris-mcp-server` starts the Server. `doris-mcp-client` is a separate client;
  74. the two commands are not interchangeable.
  75. Configure a Doris route:
  76. ```bash
  77. export DORIS_HOST=127.0.0.1
  78. export DORIS_PORT=9030
  79. export DORIS_USER=mcp_reader
  80. export DORIS_PASSWORD='replace-me'
  81. export DORIS_DATABASE=information_schema
  82. ```
  83. Start Streamable HTTP on loopback:
  84. ```bash
  85. doris-mcp-server \
  86. --transport http \
  87. --host 127.0.0.1 \
  88. --port 3000
  89. ```
  90. Endpoints:
  91. - MCP: `POST http://127.0.0.1:3000/mcp`
  92. - legacy MCP (opt-in): `POST http://127.0.0.1:3000/mcp/legacy`
  93. - liveness: `GET http://127.0.0.1:3000/live`
  94. - Doris-backed readiness: `GET http://127.0.0.1:3000/ready`
  95. Hosts limited to handshake-era Streamable HTTP, including Dify 1.16.1 with
  96. MCP `2025-06-18`, must set `ENABLE_LEGACY_HTTP_ADAPTER=true` and connect to
  97. `/mcp/legacy`. The adapter changes only the protocol boundary; it preserves the
  98. same 1.0 tools, authorization, capability gates, and read-only execution.
  99. Or run stdio for a local Host:
  100. ```bash
  101. doris-mcp-server --transport stdio
  102. ```
  103. See the complete [Quick start](docs/getting-started/quickstart.md) and
  104. [Host integration guide](docs/integrations/hosts.md).
  105. ## Security boundary
  106. - The built-in 1.0 catalog is read-only; `doris_admin` is reserved and not
  107. registered.
  108. - Static tokens, JWT, external OAuth/OIDC, and Doris-backed OAuth are supported
  109. under mutually validated configuration boundaries.
  110. - Domain discovery and child execution use exact authorization identifiers.
  111. - Doris RBAC remains the final authority for visible objects and data.
  112. - SQL shape, identifiers, parameters, timeout, rows, bytes, and result schemas
  113. are bounded before data leaves the Server.
  114. - Secrets and backend errors are redacted from public results and logs.
  115. - Non-loopback HTTP requires authentication unless an explicit dangerous
  116. development override is enabled.
  117. Read the [Security and permission model](docs/security/security-model.md) and
  118. the [Doris fine-grained access guide](docs/doris-fine-grained-access-control.md).
  119. ## Reliability boundary
  120. The Server uses deterministic manifests and errors, signed expiring cursors,
  121. route-aware capability snapshots, bounded stale fallback, request-specific
  122. connection routing, multi-FE failover, liveness/readiness separation, output
  123. Schema validation, and sanitized trace propagation. Unsupported or
  124. misconfigured capabilities remain discoverable with `callable=false` and fail
  125. closed when called.
  126. Current limits include process-local Doris-backed OAuth, explicit-only ADBC
  127. that is disabled by default and fail-closed on token-bound routes, optional
  128. read-only Ossie grounding, an optional MetricFlow compiler sidecar whose SQL
  129. must execute through the bounded MCP query runtime, and best-effort native
  130. lineage delivery. See [Reliability and limits](docs/operations/reliability.md).
  131. ## Documentation
  132. The root README is intentionally an entry point. The bilingual documentation
  133. system is indexed at:
  134. - [English documentation](docs/README.md)
  135. - [简体中文文档](docs/README.zh-CN.md)
  136. Primary guides:
  137. - [Architecture](docs/architecture/overview.md)
  138. - [Request and data flow](docs/architecture/request-lifecycle.md)
  139. - [Tool domains](docs/capabilities/tool-domains.md)
  140. - [Capability availability](docs/capabilities/availability.md)
  141. - [Doris version capability matrix](docs/capabilities/doris-version-matrix.md)
  142. - [MetricFlow integration](docs/integrations/metricflow.md)
  143. - [MCP 2026-07-28 contract](docs/protocol/mcp-2026-07-28.md)
  144. - [Security model](docs/security/security-model.md)
  145. - [Deployment](docs/operations/deployment.md)
  146. - [Reliability and limits](docs/operations/reliability.md)
  147. - [Troubleshooting](docs/operations/troubleshooting.md)
  148. - [Configuration reference](docs/reference/configuration.md)
  149. - [Host integrations](docs/integrations/hosts.md)
  150. - [Custom tool providers](docs/custom-tool-providers.md)
  151. - [Contributing](docs/development/contributing.md)
  152. ## Development
  153. ```bash
  154. git clone https://github.com/apache/doris-mcp-server.git
  155. cd doris-mcp-server
  156. uv sync --group dev
  157. uv run pytest
  158. ```
  159. Generated artifacts must remain synchronized:
  160. ```bash
  161. uv run python generate_tool_catalog.py --check
  162. uv lock --check
  163. ```
  164. See [Contributing and verification](docs/development/contributing.md).
  165. ## License
  166. Apache License 2.0. See [LICENSE.txt](LICENSE.txt) and [NOTICE](NOTICE).

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.