Greptimedb MCP Server

🚀 greptimedb-mcp-server

greptimedb-mcp-server 是为 GreptimeDB 实现的 Model Context Protocol (MCP) 服务器。它为 AI 助手提供了一个安全且结构化的接口，便于其探索和分析数据库。借助该服务器，AI 助手能够列出表格、读取数据并执行 SQL 查询，确保对数据库的访问是负责任的。

✨ 主要特性

• list_resources：列出表格
• read_resource：读取表数据
• list_tools：列出工具
• call_tool：执行 SQL
• list_prompts：列出提示
• get_prompt：按名称获取提示

📦 安装指南

使用以下命令进行安装：

pip install greptimedb-mcp-server

🛠️ 配置说明

你可以通过设置环境变量或使用命令行参数来配置服务器。

设置环境变量

GREPTIMEDB_HOST=localhost    # 数据库主机
GREPTIMEDB_PORT=4002         # 可选：数据库端口（未指定时默认为 4002）
GREPTIMEDB_USER=root
GREPTIMEDB_PASSWORD=
GREPTIMEDB_DATABASE=public

使用命令行参数

• --host：数据库主机
• --port：数据库端口
• --user：数据库用户名
• --password：数据库密码
• --database：数据库名称

💻 使用示例

Claude 桌面集成

在 Claude 桌面的配置文件中设置 MCP 服务器。

MacOS

配置文件位置：~/Library/Application Support/Claude/claude_desktop_config.json

Windows

配置文件位置：%APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "greptimedb": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/greptimedb-mcp-server",
        "run",
        "-m",
        "greptimedb_mcp_server.server"
      ],
      "env": {
        "GREPTIMEDB_HOST": "localhost",
        "GREPTIMEDB_PORT": "4002",
        "GREPTIMEDB_USER": "root",
        "GREPTIMEDB_PASSWORD": "",
        "GREPTIMEDB_DATABASE": "public"
      }
    }
  }
}

📄 许可证

本项目采用 MIT 许可证，详见 LICENSE.md 文件。

🤝 贡献指南

先决条件

• 带有 uv 包管理器的 Python
• 已安装 GreptimeDB
• 安装 MCP 服务器依赖项

开发步骤

# 克隆仓库
git clone https://github.com/GreptimeTeam/greptimedb-mcp-server.git
cd greptimedb-mcp-server

# 创建虚拟环境
uv venv
source venv/bin/activate  # 或 `venv\Scripts\activate` 在 Windows 上

# 安装开发依赖项
uv sync

# 运行测试
pytest

调试方法

使用 MCP Inspector 进行调试：

npx @modelcontextprotocol/inspector uv \
  --directory \
  /path/to/greptimedb-mcp-server \
  run \
  -m \
  greptimedb_mcp_server.server

🙏 致谢

此库的实现借鉴了以下两个仓库的代码，在此对其表示感谢：

• ktanaka101/mcp-server-duckdb
• designcomputer/mysql_mcp_server
• mikeskarl/mcp-prompt-templates

感谢这些项目的贡献者！