comfyui-mcp: Instructions file for Claude Code

CLAUDE.md - ComfyUI MCP Server

Project Overview

This is a TypeScript MCP (Model Context Protocol) server that enables AI assistants to interact with ComfyUI for generating images, audio, and video. The server is designed to be self-configuring, automatically discovering ComfyUI instances and their capabilities.

Architecture

src/
├── index.ts                 # Main MCP server entry point
├── config.ts                # Configuration management
├── context.ts               # Server context (shared state)
├── client/
│   ├── comfyui.ts          # REST API client for ComfyUI
│   └── websocket.ts        # WebSocket client for progress tracking
├── discovery/
│   └── index.ts            # Auto-discovery of ComfyUI instances
├── capabilities/
│   └── index.ts            # Capability detection from object_info
├── workflows/
│   └── builder.ts          # Dynamic workflow generation
├── tools/
│   ├── generate.ts         # Sync workflow execution
│   ├── generate-async.ts   # Async workflow execution
│   ├── models.ts           # Model/node listing and building
│   ├── queue.ts            # Queue management tools
│   ├── install.ts          # Installation assistance
│   ├── validation.ts       # Workflow validation
│   ├── svg.ts              # SVG rendering to PNG
│   ├── fonts.ts            # Font download and management
│   └── examples/           # Example workflows and templates
│       ├── index.ts        # Main exports
│       ├── data.ts         # Aggregated example data
│       ├── types.ts        # Type definitions
│       ├── list-examples.ts # list_examples tool
│       ├── templates.ts    # Template system (search/get/save)
│       ├── recommend.ts    # Workflow recommendations
│       ├── downloads.ts    # Model download URLs
│       ├── basics.ts       # Basic workflow examples
│       ├── flux.ts         # Flux model examples
│       ├── sdxl.ts         # SDXL examples
│       ├── sd3.ts          # SD3 examples
│       ├── controlnet.ts   # ControlNet examples
│       ├── video.ts        # Video generation examples
│       ├── audio.ts        # Audio generation examples
│       ├── hunyuan.ts      # Hunyuan examples
│       ├── next-gen.ts     # Next-gen model examples
│       └── 3d.ts           # 3D generation examples
├── jobs/
│   ├── manager.ts          # Async job tracking
│   └── notifications.ts    # MCP notification handling
├── db/
│   └── index.ts            # SQLite database for notes/templates
├── handlers/
│   ├── resources.ts        # MCP resource handlers
│   └── prompts.ts          # MCP prompt handlers
├── resources/
│   └── prompting-guide.ts  # Model-specific prompting guides
├── analysis/
│   ├── outputs.ts          # User output history analysis
│   └── hash.ts             # Workflow hashing
└── utils/
    ├── image.ts            # Image processing utilities
    └── logging.ts          # MCP logging utilities