使用说明

项目简介

ComfyDeploy MCP服务器是 ComfyDeploy API 的 MCP (Model Context Protocol) 服务端实现，它将 ComfyDeploy API 提供的功能以工具 (Tools) 的形式暴露出来，使得支持 MCP 协议的 LLM 客户端（如 Claude, Cursor 等）可以方便地调用 ComfyDeploy 的各项能力。

主要功能点

工作流部署: 通过 'run-deployment-queue' 工具，LLM 客户端可以触发 ComfyDeploy 上预定义的工作流部署任务。
运行状态查询: 使用 'run-get' 工具，客户端可以获取指定运行ID的工作流运行状态和详细信息。
运行取消: 利用 'run-cancel' 工具，客户端可以取消正在运行的工作流任务。
基于 SDK 构建: 服务器基于 ComfyDeploy 官方提供的 Typescript SDK 构建，保证了功能实现的完整性和可靠性。
多种传输协议支持: 支持 Stdio 和 SSE 两种 MCP 服务器常用的传输协议，可以灵活适配不同的 LLM 客户端和应用场景。

安装步骤

安装 Node.js: 确保你的环境中安装了 Node.js v20 或更高版本。
安装 ComfyDeploy SDK: 使用 npm, pnpm, bun 或 yarn 等包管理器安装 'comfydeploy' 包。
- 例如使用 npm:
```
npm add comfydeploy
```

服务器配置

MCP 服务器需要配置在 MCP 客户端中，以下分别提供了 Claude 和 Cursor 的配置示例。

Claude 配置示例 (添加到 'claude_desktop_config.json'):

{
  "mcpServers": {
    "ComfyDeploy": {
      "command": "npx",
      "args": [
        "-y", "--package", "comfydeploy",
        "--",
        "mcp", "start",
        "--bearer", "YOUR_API_KEY"  //  替换为你的 ComfyDeploy API 密钥
      ]
    }
  }
}

Cursor 配置示例 (创建 '.cursor/mcp.json' 文件):

{
  "mcpServers": {
    "ComfyDeploy": {
      "command": "npx",
      "args": [
        "-y", "--package", "comfydeploy",
        "--",
        "mcp", "start",
        "--bearer", "YOUR_API_KEY"  //  替换为你的 ComfyDeploy API 密钥
      ]
    }
  }
}

配置参数说明:

'server name': 'ComfyDeploy' (服务器名称，可自定义)
'command': 'npx' (Node.js 包执行器)
'args': 启动 MCP 服务器的参数列表
- '-y', '--package', 'comfydeploy': 自动安装并使用 'comfydeploy' 包
- '--': 分隔 npx 参数和 comfydeploy mcp server 参数
- 'mcp', 'start': 指定运行 'comfydeploy' 包的 'mcp' 命令及其子命令 'start'，启动 MCP 服务器
- '--bearer', 'YOUR_API_KEY': 必须配置，用于 ComfyDeploy API 鉴权的 Bearer Token，请替换为你在 ComfyDeploy 账户中生成的 API 密钥。

更多启动参数: 可以使用以下命令查看更多服务器启动参数和帮助信息：

npx -y --package comfydeploy -- mcp start --help

基本使用方法

启动 MCP 服务器: 按照上述配置，在 MCP 客户端中启用 'ComfyDeploy' MCP 服务器。
LLM 客户端调用工具: 在支持 MCP 协议的 LLM 客户端中，即可发现并调用 'ComfyDeploy' MCP 服务器提供的工具，例如：
- 使用 'run-deployment-queue' 工具部署新的工作流。
- 使用 'run-get' 工具查询指定 'runId' 的运行状态。
- 使用 'run-cancel' 工具取消不需要的运行任务。
API 密钥配置: 请务必将 'YOUR_API_KEY' 替换为你真实的 ComfyDeploy API 密钥，以确保 MCP 服务器可以成功连接和操作 ComfyDeploy API。

关键词