项目简介
ComfyUI MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端,它将流行的图像生成工具 ComfyUI 包装成一个标准的 MCP 服务。通过此服务,LLM 客户端可以方便地调用本地 ComfyUI 实例,实现文本到图像、图像到图像等多种图像生成功能。本服务旨在为 LLM 应用提供一个即插即用的图像生成能力,并遵循 MCP 协议,保证了良好的互操作性和标准化。
主要功能点
- MCP 协议支持: 完全兼容 Model Context Protocol,可以通过标准的 JSON-RPC 协议与各种 MCP 客户端通信。
- ComfyUI 集成: 无缝对接本地 ComfyUI 实例,利用 ComfyUI 强大的节点式工作流系统,提供灵活多样的图像生成能力。
- 工作流资源管理: 自动加载 'workflows' 目录下预设的 ComfyUI 工作流文件,作为可被 LLM 客户端发现和使用的资源。
- 动态参数调整: 支持在调用图像生成工具时,动态调整工作流中的关键参数,例如提示词、图像尺寸和种子等,实现高度定制化的图像生成。
- 预置 Prompt 模板: 提供 'Generate Image with ComfyUI' Prompt 模板,方便用户通过自然语言指令引导 LLM 调用图像生成工具。
安装步骤
-
环境准备: 确保已安装 Python 3.13 或更高版本,并已安装并运行 ComfyUI (默认地址: http://127.0.0.1:8188)。ComfyUI 安装地址
-
安装 uv: 按照仓库 README.md 中的指引,安装 uv 包管理器。
-
克隆仓库: 使用 git 克隆 'hh-mcp-comfyui' 仓库到本地。
git clone https://github.com/zjf2671/hh-mcp-comfyui.git cd hh-mcp-comfyui -
初始化 Python 虚拟环境: 使用 uv 创建并激活虚拟环境。
uv venv .venv\Scripts\activate # Windows source .venv/bin/activate # macOS 和 Linux -
安装依赖: 使用 uv 安装项目依赖。
uv lock uv sync -
复制示例工作流: 将示例工作流复制到指定目录,确保服务启动时可以加载。
mkdir src\hh\workflows cp .\example\workflows\* .\src\hh\workflows\
服务器配置
为了让 MCP 客户端(如 Cherry Studio、Cline、Cursor 等)连接到 ComfyUI MCP 服务器,您需要在客户端中配置服务器信息。以下是一个 JSON 格式的配置示例,您需要根据实际情况修改 '项目绝对路径' 为您本地仓库的绝对路径。
{ "mcpServers": { "hh-mcp-comfyui": { "command": "uv", "args": [ "--directory", "项目绝对路径(例如:D:/hh-mcp-comfyui/src/hh)", "run", "server.py" ] } } }
配置参数说明:
- 'server name': 'hh-mcp-comfyui' (服务器名称,可以自定义)
- 'command': 'uv' (启动命令,使用 uv 运行服务器)
- 'args': 启动参数,包括:
- '--directory': 指定服务器代码所在的目录,请务必替换为您的项目绝对路径,指向仓库中 'src/hh' 目录。
- 'run': uv 的子命令,表示运行指定的 Python 脚本。
- 'server.py': 服务器主程序脚本。
基本使用方法
-
启动 ComfyUI MCP 服务器: 在终端中,使用 uv 启动服务器。请将命令中的 '你本地目录安装/hh-mcp-comfyui/src/hh' 替换为实际路径。
uv --directory 你本地目录安装/hh-mcp-comfyui/src/hh run server.py如果看到 'INFO:main:Starting ComfyUI MCP Server...' 等类似信息,表示服务器启动成功。
-
配置 MCP 客户端: 将上面提供的服务器配置 JSON 代码添加到您的 MCP 客户端(如 Cherry Studio、Cline、Cursor 或 MCP Inspector)的服务器配置中。
-
使用客户端与服务器交互: 在 MCP 客户端中,您应该能够发现 ComfyUI MCP 服务器提供的资源(工作流)和工具('generate_image')。您可以:
- 浏览资源: 查看已加载的工作流列表。
- 调用工具: 使用 'generate_image' 工具生成图像,并指定提示词、尺寸等参数。
- 使用 Prompt 模板: 使用 'Generate Image with ComfyUI' Prompt 模板,通过自然语言指令引导 LLM 调用图像生成工具。
-
查看生成结果: 图像生成成功后,服务器会返回一个 URL,您可以通过此 URL 在浏览器中查看生成的图像。
扩展功能
- 添加新的 ComfyUI 工作流: 只需将新的工作流 JSON 文件放入 'src/hh/workflows' 目录,重启服务器即可自动加载。
- 自定义工具参数: 您可以修改 'src/hh/server.py' 中的 'generate_image' 工具定义,添加或修改工具的参数,以满足更复杂的需求。
信息
分类
AI与计算