@fre4x/comfyui 1.0.60 → 1.0.62

package/README.md

@@ -4,18 +4,12 @@ An MCP server to interact with ComfyUI remotely. Probe server state, inspect nod
 
 ## Tools
 
-- `comfyui_get_system_info`: Get server hardware and software status.
-- `comfyui_list_object_info`: List available nodes and their schema (inputs/outputs).
-- `comfyui_execute_workflow`: Submit a workflow in API JSON format.
-- `comfyui_list_workflows`: List stored reusable workflows.
-- `comfyui_search_workflows`: Search stored workflows by name, tag, or description.
-- `comfyui_get_workflow`: Inspect a stored workflow and its editable inputs.
-- `comfyui_save_workflow`: Save a workflow for later reuse.
-- `comfyui_run_workflow`: Run a stored workflow with optional overrides.
-- `comfyui_get_history`: Retrieve job history and outputs.
+- `comfyui_inspect_node`: List available nodes or inspect one node schema.
+- `comfyui_discover_workflows`: Scan known workflow directories for stored JSON files.
+- `comfyui_get_workflow`: Normalize a stored workflow and list its editable inputs.
+- `comfyui_save_workflow`: Save a workflow into local `./workflows` with optional edits.
+- `comfyui_workflow_run`: Run a stored workflow with optional overrides.
 - `comfyui_wait_for_workflow`: Wait for workflow completion with a timeout.
-- `comfyui_get_queue`: Check current server queue.
-- `comfyui_get_view_url`: Get a direct URL for a generated file.
 
 **Do not assume `structuredContent` is what the model actually sees.** Many MCP clients
 surface `content.text` to the model first and treat `structuredContent` as secondary
@@ -28,7 +22,6 @@ IDs, and recovery hints.
 ### Environment Variables
 
 - `COMFYUI_SERVER_URL`: The URL of your ComfyUI server (default: `http://localhost:8188`).
-- `COMFYUI_WORKFLOWS_DIR`: Directory used for saved workflow registry files (default: `~/.fre4x-comfyui/workflows`).
 - `MOCK`: Set to `true` to use mock data instead of a real server.
 
 ### Claude Desktop Configuration
@@ -57,35 +50,60 @@ MOCK=true npx @fre4x/comfyui
 
 ## Workflow API Format
 
-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.
+`comfyui_workflow_run` and `comfyui_save_workflow` both normalize workflows into
+ComfyUI **API Format** before execution or persistence. In ComfyUI, enable
+"Developer Mode" in settings, then click "Save (API Format)" if you want the
+raw graph JSON. Standard Web UI workflow JSON is also accepted and normalized
+automatically.
 
 If you want a single call that submits and waits, pass `await: true` with a
-`timeout` value in seconds to `comfyui_execute_workflow`. For lower-level
-control, use `comfyui_wait_for_workflow` with `prompt_id`,
-`timeout_seconds`, and `poll_interval_ms`.
+`timeout` value in seconds to `comfyui_workflow_run`. For lower-level control,
+use `comfyui_wait_for_workflow` with `prompt_id` and `timeout`.
 
 ## Stored Workflow Reuse
 
-The workflow registry tools let you avoid re-sending large API JSON blobs.
+The stored-workflow tools let you avoid re-sending large API JSON blobs and give
+agents a stable local edit loop.
 
-1. Save a workflow with `comfyui_save_workflow`
-2. Inspect it with `comfyui_get_workflow`
-3. Reuse it with `comfyui_run_workflow`
+1. Save a workflow with `comfyui_save_workflow` into local `./workflows`
+2. Inspect editable paths with `comfyui_get_workflow`
+3. Persist edits with `comfyui_save_workflow` overrides
+4. Reuse it with `comfyui_workflow_run`
 
-`comfyui_run_workflow` accepts structured overrides in this form:
+`comfyui_workflow_run` and `comfyui_save_workflow` both accept dot-notation
+overrides in this form:
 
 ```json
 {
   "workflow_id": "pony-portrait-v1",
-  "overrides": [
-    {
-      "node_id": "2",
-      "input_name": "seed",
-      "value": 67890
-    }
-  ],
+  "overrides": {
+    "2.inputs.seed": 67890,
+    "6.inputs.text": "cinematic dragon portrait"
+  },
   "await": true,
-  "timeout": 90,
-  "require_images": true
+  "timeout": 90
+}
+```
+
+To inspect editable inputs and semantic hints for agent editing:
+
+```json
+{
+  "workflow_id": "pony-portrait-v1",
+  "include_prompt": false
+}
+```
+
+To save a new or edited workflow locally:
+
+```json
+{
+  "workflow_file_path": "pony-portrait-v1.json",
+  "overrides": {
+    "6.inputs.text": "studio lighting, ultra detailed",
+    "7.inputs.filename_prefix": "pony-portrait-agent"
+  },
+  "output_file_name": "pony-portrait-agent.json",
+  "overwrite": true
 }
 ```