@fre4x/comfyui 1.0.57
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -0
- package/dist/index.js +31086 -0
- package/package.json +27 -0
package/README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# ComfyUI MCP Server
|
|
2
|
+
|
|
3
|
+
An MCP server to interact with ComfyUI remotely. Probe server state, inspect node definitions, and execute workflows.
|
|
4
|
+
|
|
5
|
+
## Tools
|
|
6
|
+
|
|
7
|
+
- `comfyui_get_system_info`: Get server hardware and software status.
|
|
8
|
+
- `comfyui_list_object_info`: List available nodes and their schema (inputs/outputs).
|
|
9
|
+
- `comfyui_execute_workflow`: Submit a workflow in API JSON format.
|
|
10
|
+
- `comfyui_get_history`: Retrieve job history and outputs.
|
|
11
|
+
- `comfyui_get_queue`: Check current server queue.
|
|
12
|
+
- `comfyui_get_view_url`: Get a direct URL for a generated file.
|
|
13
|
+
|
|
14
|
+
## Setup
|
|
15
|
+
|
|
16
|
+
### Environment Variables
|
|
17
|
+
|
|
18
|
+
- `COMFYUI_SERVER_URL`: The URL of your ComfyUI server (default: `http://localhost:8188`).
|
|
19
|
+
- `MOCK`: Set to `true` to use mock data instead of a real server.
|
|
20
|
+
|
|
21
|
+
### Claude Desktop Configuration
|
|
22
|
+
|
|
23
|
+
```json
|
|
24
|
+
{
|
|
25
|
+
"mcpServers": {
|
|
26
|
+
"comfyui": {
|
|
27
|
+
"command": "npx",
|
|
28
|
+
"args": ["-y", "@fre4x/comfyui"],
|
|
29
|
+
"env": {
|
|
30
|
+
"COMFYUI_SERVER_URL": "http://your-server-ip:8188"
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Mock Mode
|
|
38
|
+
|
|
39
|
+
For development or testing without a running ComfyUI instance:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
MOCK=true npx @fre4x/comfyui
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Workflow API Format
|
|
46
|
+
|
|
47
|
+
Note: To use `comfyui_execute_workflow`, you must use the **API Format** JSON. In ComfyUI, enable "Developer Mode" in settings, then click "Save (API Format)". This format differs from the standard workflow JSON.
|