项目简介

Coze MCP 服务器是一个实现了 Model Context Protocol (MCP) 的应用后端,旨在帮助用户通过 Claude.app 或 Zed 编辑器等 MCP 客户端,便捷地访问和管理 Coze 平台上的机器人 (Bots) 和工作流 (Workflows)。它充当 MCP 客户端与 Coze 平台之间的桥梁,将 Coze 的功能以标准化的 MCP 协议形式提供出来。

主要功能点

  • 用户身份获取:允许 MCP 客户端获取当前 Coze 用户的个人信息。
  • 工作区管理:支持列出用户在 Coze 平台上的所有工作区,方便用户定位和选择工作环境。
  • 机器人管理
    • 列出指定工作区下的所有机器人。
    • 获取指定机器人的详细信息。
    • 在指定工作区创建新的机器人。
    • 更新现有机器人的信息(名称、描述、Prompt)。
    • 发布机器人,使其可以通过 API 渠道访问。
  • 工作流交互:支持与 Coze 平台上的工作流进行对话。
  • 机器人对话:支持与 Coze 平台上的机器人进行对话。
  • 语音列表获取:允许用户获取 Coze 平台提供的语音列表。

安装步骤

  1. 使用 uv (推荐): 如果使用 'uv',则无需额外安装。可以直接使用 'uvx' 运行 'coze-mcp-server'。 确保已安装 'uvx'。

  2. 使用 PIP: 或者,您可以使用 pip 安装 'coze-mcp-server':

    pip install coze-mcp-server

    安装完成后,可以使用以下命令作为脚本运行:

    python -m coze_mcp_server

服务器配置

MCP 服务器需要配置 Coze 平台的 API Token 才能正常工作。您可以通过以下方式配置:

  • 环境变量: 设置 'COZE_API_TOKEN' 环境变量为您的 Coze API Token。如果需要使用中国境外的 Coze API,可以设置 'COZE_API_BASE' 环境变量。
  • 命令行参数: 在运行命令时,通过 '--coze-api-token' 和 '--coze-api-base' 参数指定 API Token 和 API Base URL。

以下是针对 Claude.app 和 Zed 编辑器的 MCP 客户端配置示例,您需要将这些配置添加到您的 MCP 客户端设置中。

Claude.app 配置

使用 uvx:

{
  "mcpServers": {
    "coze-mcp-server": {  // 服务器名称,可以自定义
      "command": "uvx",  // 启动命令,这里使用 uvx
      "args": ["coze-mcp-server"] // 命令参数,这里指定运行 coze-mcp-server
    }
  }
}

使用 docker:

{
  "mcpServers": {
    "coze-mcp-server": {  // 服务器名称,可以自定义
      "command": "docker", // 启动命令,这里使用 docker
      "args": ["run", "-i", "--rm", "ghcr.io/coze-dev/coze-mcp-server"] // 命令参数,运行 docker 镜像
    }
  }
}

使用 pip 安装:

{
  "mcpServers": {
    "coze-mcp-server": {  // 服务器名称,可以自定义
      "command": "python", // 启动命令,这里使用 python
      "args": ["-m", "coze_mcp_server"] // 命令参数,以模块方式运行 coze_mcp_server
    }
  }
}

Zed 编辑器 配置

使用 uvx:

{
  "context_servers": [
    {
      "coze-mcp-server": {  // 服务器名称,必须与配置名一致
        "command": "uvx",  // 启动命令,这里使用 uvx
        "args": ["coze-mcp-server"] // 命令参数,这里指定运行 coze-mcp-server
      }
    }
  ]
}

使用 pip 安装:

{
  "context_servers": [
    {
      "coze-mcp-server": {  // 服务器名称,必须与配置名一致
        "command": "python", // 启动命令,这里使用 python
        "args": ["-m", "coze_mcp_server"] // 命令参数,以模块方式运行 coze_mcp_server
      }
    }
  ]
}

注意: 请根据您的实际安装方式和环境选择合适的配置,并将 '<YOUR_COZE_API_TOKEN>' 替换为您的 Coze API Token。

基本使用方法

  1. 启动服务器: 根据您的安装方式,选择上述 "服务器配置" 中对应的命令启动 Coze MCP 服务器。确保在启动服务器前已配置好 Coze API Token。
  2. 配置 MCP 客户端: 在您的 MCP 客户端 (如 Claude.app 或 Zed 编辑器) 中,根据上述 "服务器配置" 示例,添加 Coze MCP 服务器的配置。确保服务器名称 ('coze-mcp-server') 与客户端配置中的名称一致。
  3. 在 MCP 客户端中使用: 配置完成后,您就可以在 MCP 客户端中连接到 Coze MCP 服务器,并使用其提供的功能,例如列出 Coze 机器人、与机器人对话等。具体使用方式请参考您的 MCP 客户端的文档。

信息

分类

开发者工具