# audio-comfyui-mcp
**Repository Path**: byebye758/audio-comfyui-mcp
## Basic Information
- **Project Name**: audio-comfyui-mcp
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-18
- **Last Updated**: 2025-05-19
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# ComfyUI MCP 服务
[](docs/README.EN.md)
[](README.md)
[](https://smithery.ai/server/@zjf2671/audio-comfyui-mcp)
这是一个基于Model Context Protocol (MCP)的ComfyUI图像生成服务，通过API调用本地ComfyUI实例生成图片。
**本项服务是基于 [https://github.com/zjf2671/audio-comfyui-mcp](https://github.com/zjf2671/audio-comfyui-mcp) 进行开发的。**
## 功能特性
- 通过MCP协议提供图像生成服务，实现自然语言生图自由
- 支持动态替换工作流中的提示词和尺寸等参数
- 自动加载workflows目录下的工作流文件作为资源
## 效果
- **Cherry Studio中使用效果**
- **Cline中使用效果**
## 安装依赖
**1. 确保已安装Python 3.12+**
**2. 使用uv管理Python环境：**
- 安装uv:
```bash
# On macOS and Linux.
$ curl -LsSf https://astral.sh/uv/install.sh | sh
# On Windows.
$ powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
# 更新uv(非必要操作):
$ uv self update
```
- 初始化项目环境（**只有当用源码构建，并用uv命令运行的时候需要进行这里的初始化动作**）：
```bash
# Clone the repository.
$ git clone https://github.com/zjf2671/audio-comfyui-mcp.git
$ cd audio-comfyui-mcp
# Initialized venv
$ uv venv
# Activate the virtual environment.
$ .venv\Scripts\activate
# Install dependencies.
$ uv lock
Resolved 30 packages in 1ms
# sync dependencies.
$ uv sync
Resolved 30 packages in 2.54s
Audited 29 package in 0.02ms
```
## 测试运行服务
- **uv方式**
```bash
$ uv --directory 你本地安装目录/audio-comfyui-mcp run audio-comfyui-mcp
INFO:__main__:Scanning for workflows in: D:\cygitproject\audio-comfyui-mcp\src\audio_mcp_comfyui\workflows
INFO:__main__:Registered resource: workflow://t2image_bizyair_flux -> t2image_bizyair_flux.json
INFO:__main__:Starting ComfyUI MCP Server...
```
- **uvx方式**
```bash
$ uvx audio-comfyui-mcp
INFO:audio_mcp_comfyui.server:Scanning for workflows in: C:\Users\tianw\AppData\Local\uv\cache\archive-v0\dp4MTo0f1qL0DdYF_BYCL\Lib\site-packages\audio_mcp_comfyui\workflows
INFO:audio_mcp_comfyui.server:Starting ComfyUI MCP Server...
```
- **pip方式**
```bash
$ pip install audio_mcp_comfyui
$ python -m audio_mcp_comfyui
INFO:audio_mcp_comfyui.server:Scanning for workflows in: F:\Python\Python313\Lib\site-packages\audio_mcp_comfyui\workflows
INFO:audio_mcp_comfyui.server:Starting ComfyUI MCP Server...
```
**出现上面的信息表示服务启动成功**
## 样例工作流copy到指定工作流目录：
- **uv**
```bash
# 进入项目目录
$ cd audio-comfyui-mcp
# 创建工作流没有这个目录执行下面进行创建（这个目录位置不能动）
$ mkdir workflows
#复制样例工作的工作流目录
$ cp .\example\workflows\* .\workflows\
```
（**特别注意**：如果是使用的下面的uvx或者pip方式启动的话，请找你本地对应的安装目录把样例工作流添加进去，然后重启你的MCP服务，可以使用如下图方式找到你的安装目录的位置）
- **uvx**
```bash
$ uvx audio-comfyui-mcp
```
- **pip**
```bash
#首先安装依赖
$ pip install audio_mcp_comfyui
$ python -m audio_mcp_comfyui
```
## 使用方法
> **必须确保本地ComfyUI实例正在运行(默认地址: http://127.0.0.1:8188) [ComfyUI安装地址](https://github.com/comfyanonymous/ComfyUI.git)**
### Cherry Studio、Cline、Cursor等客户端的使用方式
uv MCP服务配置
```bash
{
"mcpServers": {
"audio-comfyui-mcp": {
"command": "uv",
"args": [
"--directory",
"项目绝对路径（例如：D:/audio-comfyui-mcp）",
"run",
"audio-comfyui-mcp"
],
"env": {
"COMFYUI_API_BASE": "http://127.0.0.1:8188",
"COMFYUI_WORKFLOWS_DIR": "/path/audio-comfyui-mcp/workflows"
}
}
}
}
```
uvx MCP服务配置
```bash
{
"mcpServers": {
"audio-comfyui-mcp": {
"command": "uvx",
"args": [
"audio-comfyui-mcp"
],
"env": {
"COMFYUI_API_BASE": "http://127.0.0.1:8188",
"COMFYUI_WORKFLOWS_DIR": "/path/audio-comfyui-mcp/workflows"
}
}
}
}
```
pip MCP服务配置
**需要先执行命令窗口先执行：pip install audio_mcp_comfyui**
```bash
{
"mcpServers": {
"audio-comfyui-mcp": {
"command": "python",
"args": [
"-m",
"audio_mcp_comfyui"
],
"env": {
"COMFYUI_API_BASE": "http://127.0.0.1:8188",
"COMFYUI_WORKFLOWS_DIR": "/path/audio-comfyui-mcp/workflows"
}
}
}
}
```
docker MCP服务配置
**前提是已安装docker**
```bash
{
"mcpServers": {
"audio-comfyui-mcp": {
"command": "docker",
"args": [
"run",
"--net=host",
"-v",
"/path/audio-comfyui-mcp/workflows:/app/workflows",
"-i",
"--rm",
"zjf2671/audio-comfyui-mcp"
],
"env": {
"COMFYUI_API_BASE": "http://127.0.0.1:8188"
}
}
}
}
```
## 测试
> **使用MCP Inspector测试服务端工具**
- **uv方式**
```bash
$ npx @modelcontextprotocol/inspector uv --directory 你本地安装目录/audio-comfyui-mcp run audio-comfyui-mcp
```
- **uvx方式**
```bash
$ npx @modelcontextprotocol/inspector uvx audio-comfyui-mcp
```
- **pip方式**
```bash
$ pip install audio_mcp_comfyui
$ npx @modelcontextprotocol/inspector python -m audio_mcp_comfyui
```
- **docker方式**
```bash
$ npx @modelcontextprotocol/inspector docker run --net=host -i --rm zjf2671/audio-comfyui-mcp
```
然后点击连接如图即可调试：
## 扩展
### 添加新工作流
1. 将工作流JSON文件放入`/path/audio_mcp_comfyui/workflows`目录中
如果是uvx和pip启动方式请看上面 **样例工作流copy到指定工作流目录** 的使用方式
2. 重启服务自动加载新工作流
### 开发者自定义参数
修改`server.py`中的`generate_image`工具定义来添加新参数
## 项目结构
```
.
├── .gitignore
├── .python-version
├── pyproject.toml
├── README.md
├── uv.lock
├── example/ # 示例工作流目录
│ └── workflows/
│ ├── i2image_bizyair_sdxl.json
│ ├── t2image_bizyair_flux.json
│ ├── i2image_cogview4.json
│ └── t2image_sd1.5.json
├── src/ # 源代码目录
│ └── audio_mcp_comfyui/
│ ├── comfyui_client.py # ComfyUI客户端实现
│ ├── server.py # MCP服务主文件
│ └── workflows/ # 工作流文件目录
```
## 使用注意事项（针对没有用过comfyui的特别注意）
- 默认工作流为`t2image_bizyair_flux`
- 图片尺寸默认为1024x1024
- 服务启动时会自动加载workflows目录下的所有JSON工作流文件
- 如果你使用的是本项目中的**样例工作流**需要在comfyui中下载个插件，详细操作请查看：[样例工作流插件安装教程](https://ziitefe2yxn.feishu.cn/wiki/PlSmwBbBWiA0iDkc07scb4EEnHc)
- 如果使用你本地的comfyui工作流的话，先要保证你的工作流能在comfyui正常运行，然后需要导出(API)的JSON格式，并放入src/workflows目录中
## 贡献
1. Fork项目
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 打开Pull Request
---