相似查询的 SQL | `random_string` (string, 必填), `current_query` (string, 必填), `similar_query` (string, 必填), `db_name` (string, 可选) | | `get_metadata` | 获取数据库或表元数据信息 | `random_string` (string, 必填), `db_name` (string, 可选), `table_name` (string, 可选), `business_overview_only` (boolean, 可选, 默认 false) | | `save_metadata` | 保存元数据到数据库 | `random_string` (string, 必填), `metadata` (string, 必填, JSON 字符串), `metadata_type` (string, 可选), `table_name` (string, 可选), `db_name` (string, 可选) | | `get_schema_list` | 获取数据库表列表或指定表的结构信息 (DDL) | `random_string` (string, 必填), `table_name` (string, 可选), `db_name` (string, 可选) | **注意:** 所有工具都需要一个 `random_string` 参数作为调用标识符，这通常由 MCP 客户端自动处理或生成。参数描述中的"可选"和"必填"是针对工具本身的逻辑而言，客户端调用时可能都需要提供（具体取决于客户端实现）。 ### 4. 运行服务 ```bash ./start_server.sh ``` 该命令会启动 FastAPI 应用，默认同时提供 SSE 和 Streamable HTTP 两种 MCP 服务。 **服务端口:** * **SSE 初始化**: `http://:/mcp-sse-init` * **SSE 通信**: `http://:/mcp/messages` (POST) * **Streamable HTTP**: `http://:/mcp` (支持 GET, POST, DELETE, OPTIONS) * **健康检查**: `http://:/health` * **状态检查**: `http://:/status` ## 使用方法与 Doris MCP Server 的交互需要通过 **MCP 客户端** 进行。客户端连接到服务器的 SSE 或 Streamable HTTP 端点，并按照 MCP 协议规范发送请求（如 `tool_call`）来调用服务器提供的工具。 **主要交互流程:** 1. **客户端初始化**: 连接到 `/mcp-sse-init` (SSE) 或发送 `initialize` 方法到 `/mcp` (Streamable)。 2. **(可选) 发现工具**: 客户端可以调用 `mcp/listTools` 或 `mcp/listOfferings` 来获取服务器支持的工具列表及其描述和参数模式。 3. **调用工具**: 客户端发送 `tool_call` 消息/请求，指定 `tool_name` 和 `arguments`。 * **示例：执行 NL2SQL 查询 (流式)** * `tool_name`: `nl2sql_query_stream` (或其他相关工具名，需通过发现确认) * `arguments`: 包含 `query` (自然语言问题), `db_name` (数据库名) 等参数。 * **示例：获取表结构** * `tool_name`: `explain_table` (或其他相关工具名) * `arguments`: 包含 `table_name`, `db_name` 等参数。 4. **处理响应**: * **非流式**: 客户端收到包含 `result` 或 `error` 的响应。 * **流式**: 客户端会收到一系列 `tools/progress` 通知，最后收到包含最终 `result` 或 `error` 的响应。具体的工具名称和参数需要参考 `src/tools/` 下的代码或通过 MCP 的发现机制获取。 ## 目录结构 ``` doris-mcp-server/ ├── data/ # 数据文件目录 (示例, 历史记录等) ├── docs/ # 文档 ├── logs/ # 日志文件目录 ├── mlx_models/ # (可选) MLX 本地模型存储目录 ├── src/ # 源代码 │ ├── main.py # 主程序入口, FastAPI 应用定义 │ ├── mcp_adapter.py # MCP 协议适配与流式处理逻辑 │ ├── prompts/ # LLM 提示词定义 (prompts.py, metadata_schema.py) │ ├── resources/ # 静态资源 │ ├── sse_server.py # SSE 服务器实现 │ ├── stdio_server.py # Std

Doris MCP Server

Comments