🚀 greptimedb-mcp-server
greptimedb-mcp-server 是为 GreptimeDB 实现的 Model Context Protocol (MCP) 服务器。它为 AI 助手提供了一个安全且结构化的接口，用于探索和分析数据库。通过该服务器，AI 助手能够列出表格、读取数据并执行 SQL 查询，确保对数据库的负责任访问。
🚀 快速开始
本服务器为 AI 助手与 GreptimeDB 之间搭建了桥梁，助力 AI 助手安全、高效地与数据库交互。下面为你详细介绍如何安装、配置和使用该服务器。
✨ 主要特性
list_resources：列出数据库中的表格。read_resource：读取指定表的数据。list_tools：列出可用的工具。call_tool：执行 SQL 查询。list_prompts：列出所有提示。get_prompt：按名称获取特定提示。
📦 安装指南
使用以下命令安装 greptimedb-mcp-server：
pip install greptimedb-mcp-server
💻 使用示例
配置
你可以通过设置环境变量或使用命令行参数来配置服务器与 GreptimeDB 的连接。
环境变量配置
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
🙏 致谢
此库的实现借鉴了以下仓库的代码，在此向这些项目的贡献者表示感谢：