使用说明

项目简介

mcp-doris 是一个基于 Model Context Protocol (MCP) 的服务器实现，它允许大型语言模型 (LLM) 通过标准化的 MCP 协议与 Apache Doris 数据库进行交互。该服务器提供了一组工具，使 LLM 能够查询 Doris 数据库的元数据（如数据库列表、表列表）以及执行 SQL 查询，从而获取 Doris 中存储的数据信息，为 LLM 应用提供强大的数据访问能力。

主要功能点

查询数据库列表: 允许 LLM 获取 Apache Doris 实例中所有数据库的名称。
查询表列表: 允许 LLM 获取指定数��库中的所有表的详细信息，包括表名、注释、列信息以及建表语句。支持模糊匹配表名。
执行 SQL 查询: 允许 LLM 执行 SELECT SQL 查询语句，并返回查询结果。为了安全考虑，目前仅支持 SELECT 查询，并设置了查询超时时间。

安装步骤

安装 uv: 按照 uv 官方文档安装 uv 包管理器。uv 用于项目依赖管理和运行。
同步依赖: 克隆仓库代码到本地后，在仓库根目录下运行 'uv sync' 安装项目依赖。
激活虚拟环境: 运行 'source .venv/bin/activate' 激活虚拟环境。
设置 PYTHONPATH: 将仓库根目录添加到 'PYTHONPATH' 环境变量中，例如 'export PYTHONPATH=/path/to/mcp-doris:$PYTHONPATH'，请将 '/path/to/mcp-doris' 替换为您的实际仓库路径。

服务器配置

MCP 客户端需要以下 JSON 格式的配置信息来连接 mcp-doris 服务器。请根据您的 Doris 数据库连接信息进行配置：

{
  "serverName": "doris",
  "command": "uv run --with mcp-doris --python 3.13 mcp-doris",
  "args": {
    "DORIS_HOST": "<doris-host>",  // Apache Doris 服务器主机名或 IP 地址，请替换为您的 Doris Host
    "DORIS_PORT": "<port>",      // Apache Doris 服务器端口号，默认为 9030，请替换为您的 Doris Port
    "DORIS_USER": "<doris-user>",  // 连接 Doris 数据库的用户名，请替换为您的 Doris 用户名
    "DORIS_PASSWORD": "<doris-pwd>" // 连接 Doris 数据库的密码，请替换为您的 Doris 密码
  }
}

注意:

请将 '<doris-host>'、'<port>'、'<doris-user>'、'<doris-pwd>' 替换为您的实际 Apache Doris 数据库连接信息。
'command' 字段指定了启动 mcp-doris 服务器的命令，使用了 'uv run' 运行方式。
'args' 字段中的参数将作为环境变量传递给 mcp-doris 服务器，用于配置 Doris 数据库连接。

基本使用方法

启动 MCP 服务器: 在配置好环境变量后，按照上述 "服务器配置" 中的 'command' 字段，在仓库根目录下运行命令启动 mcp-doris 服务器。
配置 MCP 客户端: 在您的 MCP 客户端中，配置上述 JSON 格式的服务器配置信息。
调用工具: 通过 MCP 客户端，您可以调用 mcp-doris 服务器提供的工具，例如：
- 调用 'show_databases' 工具，获取 Doris 数据库列表。
- 调用 'show_tables' 工具，并指定 'database' 参数，获取指定数据库中的表列表。
- 调用 'execute_query' 工具，并指定 'query' 参数，执行 SQL 查询并获取结果。

具体工具的调用方式和参数请参考 MCP 客户端的文档和 mcp-doris 服务器的代码定义。

关键词