ComfyUI-AnimaTool MCP 服务端

使用说明(Markdown格式)

  • 项目简介

    • 这是一个把 AnimaModel 与 ComfyUI 有效对接的 MCP 服务端实现,核心通过 MCP Protocol 提供标准化的请求/响应接口,支持生成图片、列出模型、查询知识库等能力。提供原生图片输出能力,便于在聊天窗口中直接显示。
  • 主要功能点

    • 实现 MCP 服务器核心接口:支持列出工具(list_tools)和执行工具(call_tool),并在需要时返回文本或图片内容(TextContent、ImageContent)。
    • 与 ComfyUI 深度集成:通过 /prompt 等接口向 ComfyUI 发送结构化请求,等待历史任务完成并拉取输出图片。
    • 模型管理与注入:支持在 UNET 与 KSampler 之间注入多 LoRA,支持读取 LoRA 的 sidecar 元数据。
    • 图像输出与格式化:输出包含原始 base64、URL、本地路径等多种格式,方便 MCP 客户端在聊天窗口中原生显示图片。
    • 提示文本拼接:按照 Anima 规范拼接正向提示文本,支持自定义质量、画师、作品名、风格、环境等字段。
    • 多种服务器模式:内置 MCP 服务端、独立 HTTP API 服务,以及命令行工具,灵活部署。
    • 模型健康检查与远程部署友好性:支持 COMFYUI_MODELS_DIR 以进行模型文件预检查,适应本地或远程场景。
  • 安装步骤

    • 准备环境
      • 确保 Python 3.10+ 已安装。
      • 安装依赖库:mcp(MCP Server 库),以及其他运行时需要的包。
    • 运行 MCP 服务端
      • 在项目目录下运行 mcp 服务器脚本,或通过 Python -m 方式启动,确保与 ComfyUI 实例在同一网络可访问(ComfyUI 通常运行在 http://127.0.0.1:8188)。
    • 另外的访问方式
      • 也提供独立 HTTP API 服务(FastAPI),直接访问 http://127.0.0.1:8000/docs 查看接口文档。
    • 兼容性与依赖
      • 如需在 Cursor MCP 中使用,需要在 Cursor 配置中指定 MCP 服务器的 command 与 args,确保路径为绝对路径。
      • 可选:设置 COMFYUI_MODELS_DIR 以进行模型文件预检查,确保 anima 模型(unet/clip/vae)就绪。
  • 服务器配置(MCP 客户端需要的最小信息)

    • 注意:以下为示例配置,实际路径请替换为你本机的真实路径。配置需放在客户端的 MCP 设置中,MCP 客户端不需要你改动服务器端代码。
    • JSON 说明:
      • server name: anima-tool
      • command: 绝对路径的 Python 可执行文件
      • args: 服务器脚本的绝对路径,例如 ComfyUI-AnimaTool/servers/mcp_server.py
      • env(可选): 运行所需环境变量,如 COMFYUI_URL 指向本地 ComfyUI 实例的地址
    • 示例(文本呈现,不作为代码块): { "mcpServers": { "anima-tool": { "command": "<PATH_TO_PYTHON_EXECUTABLE>", "args": ["<PATH_TO>/ComfyUI-AnimaTool/servers/mcp_server.py"], "env": { "COMFYUI_URL": "http://127.0.0.1:8188" } // 还可按需添加:COMFYUI_MODELS_DIR(如果本地需要进行模型预检查) } } }
  • 基本使用方法

    • 启动与连接
      • 启动 MCP 服务端,确保 ComfyUI 已在 127.0.0.1:8188 正常工作。
      • 在 MCP 客户端(如 Cursor)中配置 anima-tool 服务器,确保 command 为绝对路径、args 指向 mcp_server.py,并设置必要的环境变量(如 COMFYUI_URL)。
    • 调用与输出
      • 通过 MCP 客户端调用 generate_anima_image 工具,传入结构化 JSON,包括 quality_meta_year_safe、count、artist、tags、neg 等字段(以及可选的 width、height、aspect_ratio、loras 等)。
      • 服务端返回包含生成信息与图片数据(base64、URL、data_url 等)的响应,客户端可直接在对话中展示图片。
    • 调试与排错
      • 若 MCP 客户端无法加载路由,请检查服务器是否已正确启动、路径为绝对路径、以及环境变量设置是否正确。
      • 如 ComfyUI 的模型未就绪,会返回相应的提示信息,按照提示放置模型到 COMFYUI_MODELS_DIR 指定位置。
  • 额外说明

    • 本实现还提供了独立的 HTTP API 服务(FastAPI),便于本地测试、调试和集成到不使用 MCP 的场景。
    • 提供完整的工具列表、知识库接口,以及健康检查等接口,便于监控与运维。

关键词 图像生成, ComfyUI, LoRA, 模型注入, 工具集成

分类ID 6

服务器信息