项目简介

GreptimeDB MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,专为 AI 助手设计,使其能够安全、结构化地探索和分析 GreptimeDB 数据库。通过此服务器,AI 助手可以列出数据库中的表,读取表数据,并执行 SQL 查询,从而实现对数据库的有效访问和数据分析。

主要功能点

  • 资源管理: 将 GreptimeDB 中的表作为资源暴露给 MCP 客户端,允许 AI 助手浏览和访问数据库表。
  • 数据访问: 提供读取表数据的能力,使 AI 助手能够获取表中的内容用于分析或上下文理解。
  • SQL 查询工具: 集成 'execute_sql' 工具,允许 AI 助手通过执行 SQL 查询来检索和操作 GreptimeDB 中的数据。
  • 安全控制: 内置安全门禁,防止执行危险的 SQL 操作(如 DROP, DELETE 等),保障数据库安全。
  • 配置灵活: 支持通过环境变量或命令行参数配置数据库连接信息。

安装步骤

  1. 确保你的 Python 环境已安装 'pip'。
  2. 执行以下命令安装 'greptimedb-mcp-server':
    pip install greptimedb-mcp-server

服务器配置

为了让 MCP 客户端(例如 Claude Desktop)连接到 GreptimeDB MCP Server,你需要在客户端的配置文件中添加服务器配置信息。以下是 Claude Desktop 客户端的配置示例,你需要根据实际情况进行调整。

在 Claude Desktop 的配置文件 ('claude_desktop_config.json') 中,添加如下 'mcpServers' 配置:

{
  "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"
      }
    }
  }
}

配置参数说明:

  • 'server name': 'greptimedb' (服务器名称,可以自定义)
  • 'command': 'uv' (建议使用 'uv' 运行 Python 应用,确保性能。如果未安装 'uv',可以替换为 'python3' 或 'python')
  • 'args': 启动服务器的参数列表
    • '--directory': '/path/to/greptimedb-mcp-server' (需要替换为 'greptimedb-mcp-server' 库的安装路径或项目根目录。 如果使用 'pip install' 安装,并且在全局 Python 环境中,可以尝试省略此参数,或者设置为 Python 包的安装路径。 如果不确定路径,可以先尝试省略 '--directory' 参数。)
    • 'run': uv 命令的子命令,用于运行模块
    • '-m': 表示运行模块
    • 'greptimedb_mcp_server.server': 指定要运行的 Python 模块为 'greptimedb_mcp_server.server'
  • 'env': 环境变量配置
    • 'GREPTIMEDB_HOST': GreptimeDB 数据库主机地址 (默认为 'localhost')
    • 'GREPTIMEDB_PORT': GreptimeDB 数据库端口 (默认为 '4002')
    • 'GREPTIMEDB_USER': GreptimeDB 数据库用户名 (默认为 'root')
    • 'GREPTIMEDB_PASSWORD': GreptimeDB 数据库密码 (默认为空)
    • 'GREPTIMEDB_DATABASE': GreptimeDB 数据库名称 (默认为 'public')

注意: 你需要根据你的 GreptimeDB 数据库的实际连接信息,修改 'env' 中的环境变量。

基本使用方法

  1. 确保 GreptimeDB 数据库已启动并可访问。
  2. 安装 'greptimedb-mcp-server' 并配置 MCP 客户端。
  3. 启动 MCP 客户端 (例如 Claude Desktop)。
  4. 在 MCP 客户端中,选择配置的 'greptimedb' 服务器。
  5. AI 助手将能够通过 MCP 协议与 GreptimeDB MCP Server 通信,列出数据库表,读取表数据,并执行 SQL 查询,从而利用 GreptimeDB 中的数据进行更深入的分析和应用。

信息

分类

数据库与文件