ComfyUI_MCP Server(ComfyUI的ModelContextProtocol 服务端 | ModelContextProtocol Server for ComfyUI)

ComfyUI_MCP Server(ComfyUI的ModelContextProtocol 服务端 | ModelContextProtocol Server for ComfyUI)

site icon
2025.05.12 1
PythonAI 绘图AI 推理自动化工作流内容生成
ComfyUI_MCP Server 是为 ComfyUI 设计的松耦合、可扩展、配置驱动的模型上下文协议(ModelContextProtocol)服务端。它支持依据客户定制工作流可扩展MCP服务(tool) 如: txt2img、img2img,每个 MCP服务(tool)的参数和行为均可通过 JSON 配置和工具模块灵活扩展,适合 AI 绘图、推理等场景的自动化与集成。
View on GitHub

Overview

基本能力

产品定位

ComfyUI_MCP Server 是一个为 ComfyUI 设计的模型上下文协议服务端,旨在提供松耦合、可扩展、配置驱动的 AI 绘图和推理服务。

核心功能

  1. 松耦合与可扩展性:支持通过 JSON 配置和工具模块灵活扩展 MCP 服务(tool)。
  2. 配置驱动:每个 MCP 服务(tool)的参数和行为均可通过 JSON 配置定义。
  3. 自动化与集成:适合 AI 绘图、推理等场景的自动化与集成。
  4. 工具自动注册:自动注册 tools/ 目录下的所有工具模块。
  5. 多工具支持:支持 txt2img、img2img 等多种工具。

适用场景

  1. AI 绘图:如文生图(txt2img)、图生图(img2img)等。
  2. AI 推理:支持多种 AI 模型的推理任务。
  3. 自动化工作流:可与 ComfyUI 的工作流集成,实现自动化任务。

工具列表

  1. txt2img:文生图工具,支持通过 JSON 配置定义参数和行为。
  2. img2img:图生图工具,支持通过 JSON 配置定义参数和行为。
  3. 自定义工具:用户可根据需求自定义工具,通过 JSON 配置和 Python 模块实现。

常见问题解答

  1. ComfyUI 未启动或地址错误:请检查 config.ini 配置。
  2. 依赖未安装:请先执行 uv pip install -r pyproject.tomlpdm install
  3. 新增工具未生效:确认已实现 register_xxx_tool(mcp) 并放置于 tools/ 目录。
  4. 参数校验失败:请检查 JSON 模板与实际参数类型、范围。
  5. Inspector 无法连接:确认 MCP 服务已启动且端口未被占用。

使用教程

使用依赖

  1. 安装 Python >= 3.12。
  2. 安装依赖管理工具 uvpdm

安装教程

  1. 使用 uv 安装依赖: bash pip install uv uv pip install -r pyproject.toml
  2. 或使用 pdm 安装依赖: bash pip install pdm pdm install

调试方式

  1. 启动服务: bash uv run -m mcp_server.mcpserver
  2. 使用 MCP Inspector 进行调试: bash npx @modelcontextprotocol/inspector uv run -m mcp_server.mcpserver
  3. Inspector 会自动连接本地 MCP 服务,支持工具、资源、提示词等全方位交互测试。
  4. 可在 Inspector 的 Tools 面板中查看所有自动注册的 API 工具,测试参数、查看返回、调试异常。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。