使用说明
ComfyUI_MCP
此存储库提供了一个模型上下文协议(MCP)服务器,该服务器向兼容的LLM客户端公开本地ComfyUI工作流文件和远程ComfyUI模型目录。
特性
- 发现工作流程
.json存储在workflows/目录,并将其作为MCP资源公开。 - 用于列出工作流元数据和读取工作流内容的工具。
- 递归查询ComfyUI的工具
/api/models端点,以便LLM可以检查可用的检查点、LoRA和其他资产。 - 通过CLI参数或环境变量进行配置,以便可以从JSON描述符(例如Cursor MCP定义)启动服务器。
安装
创建虚拟环境(推荐),并使用首选安装程序以可编辑模式安装软件包:
pip install -e .
该项目还与 紫外线 因此,您可以在不使用的情况下安装或运行它 pip 直接:
uv pip install -e .
# or run without installing into the current environment
uvx --from . comfyui-mcp --help
运行服务器
已安装 comfyui-mcp 入口点通过stdio启动MCP服务器。常见配置选项可以作为CLI标志或环境变量提供:
| 目的 | CLI标志 | 环境变量 | 默认值 |
|---|---|---|---|
| 工作流目录 | --workflow-dir |
COMFYUI_WORKFLOW_DIR |
<repo>/workflows |
| 令人欣慰的API基础URL | --api-base-url |
COMFYUI_API_BASE_URL |
http://127.0.0.1:8188/ |
| HTTP超时(秒) | --http-timeout |
COMFYUI_HTTP_TIMEOUT |
30 |
| 日志级别 | --log-level |
COMFYUI_MCP_LOG_LEVEL |
INFO |
Cursor MCP JSON定义的stdio启动配置示例:
如果你愿意 uvx,相同的配置可以表示为:
{
"comfyui": {
"command": "uvx",
"args": [
"--from",
".",
"comfyui-mcp",
"--workflow-dir",
"./workflows",
"--api-base-url",
"http://127.0.0.1:8188/"
]
}
}
在本地引用项目时,请使用 uvx,确保工作目录设置为
存储库根(或调整 --from 相应的路径),因此可以解析包,而无需
要求将其发布到外部索引。
将您的ComfyUI工作流文件放置在 workflows/ 目录(或您配置的任何目录),以便LLM可以使用它们。
