使用说明

项目简介

Bloomy MCP 是一个 Model Context Protocol (MCP) 服务器,专为 Bloom Growth 的 GraphQL API 设计。它允许 AI 助手通过标准化的 MCP 协议与 Bloom Growth 平台进行交互,从而实现数据查询、操作和功能调用。

主要功能点

  • GraphQL API 桥梁:将 Bloom Growth 的 GraphQL API 转化为 MCP 协议,使得 AI 助手能够理解和利用。
  • 数据查询与操作:通过 MCP 资源和工具,AI 助手可以查询 Bloom Growth 平台的数据,并执行 GraphQL 突变操作。
  • 工具注册与执行:提供了一系列预定义的 MCP 工具,例如获取查询/突变详情、执行查询/突变、获取用户信息等,方便 AI 助手调用。
  • 动态 Schema 获取:支持自动化的 GraphQL Schema 内省,确保 MCP 服务器始终与最新的 API 保持同步。
  • 资源管理:暴露了可用的 GraphQL 查询和突变作为 MCP 资源,方便 AI 助手发现和使用。

安装步骤

  1. 克隆仓库

    git clone https://github.com/franccesco/bloomy-mcp.git
    cd bloomy-mcp
  2. 创建并激活虚拟环境

    python -m venv .venv
    source .venv/bin/activate  # 或 .venv\Scripts\activate (Windows)
  3. 安装项目依赖 推荐使用 'uv' (更快速):

    uv pip install -e .

    或者使用 'pip':

    pip install -e .
  4. 配置环境变量 创建 '.env' 文件,并填入 Bloom Growth API 的 URL 和 Token:

    BLOOM_API_URL=<Your Bloom API URL>
    BLOOM_API_TOKEN=<Your Bloom API Token>

    请替换 '<Your Bloom API URL>' 和 '<Your Bloom API Token>' 为您实际的 API 地址和访问令牌。

服务器配置 (MCP 客户端)

要将此 MCP 服务器集成到 MCP 客户端(例如 Cursor),您需要配置服务器连接信息。以下是一个 JSON 格式的配置示例,您需要将其添加到您的 MCP 客户端配置中。

{
  "serverName": "Bloom Growth",
  "command": "uv run",
  "args": [
    "--project",
    "/path/to/your/repo/",
    "--env-file",
    "/path/to/your/repo/.env",
    "bloomy-server"
  ]
}

配置参数说明

  • '"serverName"': 服务器名称,您可以自定义,例如 "Bloom Growth" 或 "BG"。
  • '"command"': 启动服务器的命令,这里使用 'uv run',假设您已安装 'uv' 并将其添加到环境变量。如果您使用 'pip' 安装,并且 'bloomy-server' 命令已在您的环境中可用,则可以直接使用 '"command": "bloomy-server"'。但为了确保环境一致性,推荐使用 'uv run' 并在 'args' 中指定项目路径和启动脚本。
  • '"args"': 传递给 'uv run' 命令的参数列表:
    • '"--project"': 指向您的 'bloomy-mcp' 仓库根目录的路径,请务必将 '/path/to/your/repo/' 替换为实际的仓库路径,例如 '/Users/username/workspace/bloomy-mcp/'。
    • '"--env-file"': 指向包含环境变量的 '.env' 文件的路径,同样需要替换为实际路径。
    • '"bloomy-server"': 要执行的启动脚本名称,对应 'setup.py' 中定义的 'bloomy-mcp' 入口点。

重要提示:请根据您的实际环境,修改 '"command"' 和 '"args"' 中的路径。确保 MCP 客户端能够正确执行配置的命令,启动 Bloomy MCP 服务器。

基本使用方法

  1. 启动服务器 在项目根目录下,激活虚拟环境后,运行以下命令启动 Bloomy MCP 服务器:

    bloomy-server

    或者使用 'uv run' (更推荐,与客户端配置一致):

    uv run bloomy-server
  2. 在 MCP 客户端中使用 配置完成后,您的 MCP 客户端(如 Cursor)应该能够连接到 Bloomy MCP 服务器。您可以使用客户端提供的界面或指令,通过 MCP 协议调用 Bloomy MCP 服务器提供的资源和工具,从而与 Bloom Growth 的 GraphQL API 进行交互。

    例如,您可以请求资源 'bloom://queries' 获取可用的查询列表,或者调用工具 'get_query_details' 获取特定查询的详细信息。具体的使用方式取决于您使用的 MCP 客户端的功能和界面。

信息

分类

网页与API