io.github.somacoffeekyoto/imgx
AI image generation and editing via CLI or MCP. Text-based editing, multi-provider.
Ask AI about io.github.somacoffeekyoto/imgx
Powered by Claude Β· Grounded in docs
I know everything about io.github.somacoffeekyoto/imgx. Ask me about installation, configuration, usage, or troubleshooting.
0/500
Reviews
Documentation
imgx-mcp
AI image generation and editing MCP server. Works with Claude Code, Gemini CLI, Cursor, Windsurf, and any MCP-compatible tool.
Generate images from text, edit existing images with text instructions, iterate on results β all from your AI coding environment.
Quick start
Add to your tool's MCP config (.mcp.json, settings.json, etc.):
{
"mcpServers": {
"imgx": {
"command": "npx",
"args": ["--package=imgx-mcp", "-y", "imgx-mcp"],
"env": { "GEMINI_API_KEY": "your-key" }
}
}
}
That's it. Your AI agent can now generate and edit images.
Windows: Replace
"command": "npx"with"command": "cmd"and prepend"/c"to the args array.
Skill (Claude Code)
For Claude Code users, imgx-mcp includes an image-generation skill β a guided prompt that teaches Claude how to use the MCP tools effectively. With the skill installed, type /image-generation to start a guided workflow.
Install the skill
Copy the skill directory from the npm package or GitHub repository to your project:
# From npm (after npx has cached the package)
cp -r $(npm root -g)/imgx-mcp/skills .claude/skills
# Or from the GitHub repository
curl -sL https://raw.githubusercontent.com/somacoffeekyoto/imgx-mcp/main/skills/image-generation/SKILL.md \
-o .claude/skills/image-generation/SKILL.md --create-dirs
curl -sL https://raw.githubusercontent.com/somacoffeekyoto/imgx-mcp/main/skills/image-generation/references/providers.md \
-o .claude/skills/image-generation/references/providers.md --create-dirs
Or place skill files manually:
your-project/
.mcp.json β MCP server config (Quick start above)
.claude/
skills/
image-generation/
SKILL.md β skill prompt
references/
providers.md β provider reference
The skill files are included in the npm package under skills/ and in the GitHub repository.
Personal skill (all projects): Place in
~/.claude/skills/image-generation/instead of.claude/skills/.
Claude Desktop
Claude Desktop supports skills via ZIP upload:
- Download
image-generation-skill.zipfrom the repository (or find it in the npm package underdist/) - In Claude Desktop: Settings > Profile > Customize > Skills > Add Skill
- Upload the ZIP
Update the skill by re-downloading and re-uploading the ZIP after new releases.
What the Skill brings
The MCP server gives the AI the ability to generate and edit images. The Skill adds the knowledge of how to use those tools well β so you don't need to learn prompt syntax, model specifications, or service-specific parameters.
- Automatic prompt construction β Say "I need a cover image." The AI builds a structured prompt using the Subject-Context-Style framework: what to show, where to place it, how it should look
- 24 editing techniques β Atmosphere adjustment, composition changes, element manipulation, style transfer. "Make it warmer" or "add depth of field" β the AI selects the right instruction for the model
- Intelligent model selection β Starts with the free model. Suggests paid upgrades only when your needs exceed free tier capabilities, and explains what changes
- Platform-aware sizing β "Twitter OGP" or "App Store screenshot" β the AI picks the correct aspect ratio and resolution. Covers social media, OGP, app stores, print, and blog platforms
- Trending style templates β Ghibli, action figure in box, 3D clay, pixel art, chibi, and more. Name the style and the AI applies the right prompt structure
- Multi-image consistency β Design tokens and character DNA templates maintain visual coherence across slide decks, social media series, and brand assets
The image generation models already have these capabilities. The Skill is what makes them accessible without specialized knowledge.
MCP server vs Skill
| MCP server | Skill | |
|---|---|---|
| What it does | Exposes image tools to AI agents | Guided prompt for using the tools |
| Works with | Any MCP-compatible tool | Claude Code, Claude Desktop |
| Install | Add to .mcp.json | Copy skill files to project |
| Team sharing | Commit .mcp.json to repo | Commit .claude/skills/ to repo |
Recommended: Set up the MCP server (Quick start) + install the skill if you use Claude Code.
MCP tools
| Tool | Description |
|---|---|
generate_image | Generate an image from a text prompt |
edit_image | Edit an existing image with text instructions |
edit_last | Edit the last generated/edited image (no input path needed) |
undo_edit | Undo the last edit, reverting to the previous image in the session |
redo_edit | Redo a previously undone edit |
edit_history | Show all sessions and their edit history with metadata |
switch_session | Switch to a different editing session |
clear_history | Clear project history (optionally delete image files) |
set_output_dir | Change the default output directory (optionally move existing files) |
list_providers | List available providers and capabilities |
The .imgx/ directory holds both edit history and default image output. Its location depends on project root detection:
| Project root | .imgx/ location | History |
|---|---|---|
| Detected | <project-root>/.imgx/ | <project-root>/.imgx/output-history.json |
| Not detected | ~/Pictures/imgx/ (images only) | ~/.config/imgx/output-history.json (global) |
All clients that resolve to the same project root share the same history. Each session gets its own subdirectory. File paths are returned in the response. Inline image preview is included in MCP responses (base64).
Iterative editing
The edit_last tool uses the output of the previous generate_image or edit_image call as input. This enables a conversational workflow:
"Generate a coffee shop interior" β generate_image
"Make the lighting warmer" β edit_last
"Add a person reading a book" β edit_last
No need to specify file paths between steps.
Session management
Each generate_image call starts a new session. Subsequent edit_last calls are added to the same session, forming an edit chain. Each session has its own output directory.
Undo / Redo β Step backward and forward through the edit chain:
generate β edit_last β edit_last β edit_last
β current
β undo_edit
β current
redo_edit β
β current
After undo, calling edit_last branches from the current position (abandoned entries and their files are deleted from disk).
File naming β edit_last generates sequential filenames based on the origin file:
generate_image β cover.png
edit_last β cover-1.png
edit_last β cover-2.png
generate_image (no output) β imgx-a1b2c3d4.png
edit_last β imgx-a1b2c3d4-1.png
Session switching β Use edit_history to see all sessions, then switch_session to resume a previous session. The edit_last tool will use the current position in the switched session.
Output directory β edit_last inherits the output directory from the session. If generate_image was called with output_dir, all subsequent edit_last calls in that session output to the same directory. The output_dir path is recorded as session metadata in output-history.json. This only affects where image files are saved β history always stays in .imgx/ (or the global config directory).
API key setup
Set up at least one provider:
Gemini β get a key from Google AI Studio (free tier available for gemini-2.5-flash-image):
imgx config set api-key YOUR_GEMINI_API_KEY --provider gemini
OpenAI β get a key from OpenAI Platform:
imgx config set api-key YOUR_OPENAI_API_KEY --provider openai
Keys are stored in ~/.config/imgx/config.json (Linux/macOS) or %APPDATA%\imgx\config.json (Windows). Alternatively, pass keys via the env section in your MCP config, or set environment variables:
export GEMINI_API_KEY="your-api-key"
export OPENAI_API_KEY="your-api-key"
Only include the API keys for providers you want to use. At least one is required.
MCP configuration by tool
Claude Code
.mcp.json in your project root:
{
"mcpServers": {
"imgx": {
"command": "npx",
"args": ["--package=imgx-mcp", "-y", "imgx-mcp"],
"env": { "GEMINI_API_KEY": "your-key", "OPENAI_API_KEY": "your-key" }
}
}
}
Gemini CLI
~/.gemini/settings.json:
{
"mcpServers": {
"imgx": {
"command": "npx",
"args": ["--package=imgx-mcp", "-y", "imgx-mcp"],
"env": { "GEMINI_API_KEY": "your-key", "OPENAI_API_KEY": "your-key" }
}
}
}
Claude Desktop
claude_desktop_config.json:
macOS / Linux:
{
"mcpServers": {
"imgx": {
"command": "npx",
"args": ["--package=imgx-mcp", "-y", "imgx-mcp"],
"env": {
"GEMINI_API_KEY": "your-key",
"OPENAI_API_KEY": "your-key",
"IMGX_PROJECT_ROOT": ""
}
}
}
}
Windows:
{
"mcpServers": {
"imgx": {
"command": "cmd",
"args": ["/c", "npx", "--package=imgx-mcp", "-y", "imgx-mcp"],
"env": {
"GEMINI_API_KEY": "your-key",
"OPENAI_API_KEY": "your-key",
"IMGX_PROJECT_ROOT": ""
}
}
}
}
IMGX_PROJECT_ROOT β Set to your project path to save images inside the project (e.g. "C:\\Users\\you\\my-project"). Leave empty to use the global default (~/Pictures/imgx).
Config file location: %APPDATA%\Claude\claude_desktop_config.json (Windows) or ~/Library/Application Support/Claude/claude_desktop_config.json (macOS). After editing, restart Claude Desktop.
Note: Claude Desktop does not support auto-detection (MCP roots / CWD-based
.imgxrcsearch). UseIMGX_PROJECT_ROOTin the config above (per-client), or runimgx config set project-root /path/to/project(shared across all clients).
Codex CLI
.codex/config.toml:
[mcp_servers.imgx]
command = "npx"
args = ["--package=imgx-mcp", "-y", "imgx-mcp"]
env = { GEMINI_API_KEY = "your-key", OPENAI_API_KEY = "your-key" }
Other tools
The same npx pattern works with Cursor, Windsurf, Continue.dev, Cline, Zed, and other MCP-compatible tools. On Windows, use cmd /c npx instead of npx directly.
Providers
| Provider | Models | Capabilities |
|---|---|---|
| Gemini | gemini-2.5-flash-image (Nano Banana β free tier, default), gemini-3-pro-image-preview (Nano Banana Pro), gemini-3.1-flash-image-preview (Nano Banana 2) | Generate, edit, aspect ratio (up to 14 ratios), resolution (up to 4K), reference images, person control |
| OpenAI | gpt-image-1, gpt-image-1.5 (faster, 20% cheaper), gpt-image-1-mini (budget) | Generate, edit, aspect ratio, multi-output, output format (PNG/JPEG/WebP), background transparency |
Architecture
imgx separates model-independent and model-dependent concerns:
MCP server (tool definitions, stdio transport) CLI (argument parsing, output formatting)
β β
Core (Capability enum, ImageProvider interface, provider registry, file I/O, history)
β
Provider (model-specific API calls, capability declarations)
MCP server and CLI are two entry points into the same core. Both call the same provider functions.
Each provider declares its supported capabilities. Adding a new provider means implementing the ImageProvider interface and registering it β no changes to the MCP or CLI layer.
Capability system
| Capability | Description |
|---|---|
TEXT_TO_IMAGE | Generate images from text prompts |
IMAGE_EDITING | Edit images with text instructions |
ASPECT_RATIO | Control output aspect ratio |
RESOLUTION_CONTROL | Control output resolution |
MULTIPLE_OUTPUTS | Generate multiple images per request |
REFERENCE_IMAGES | Use reference images for guidance |
PERSON_CONTROL | Control person generation in output |
OUTPUT_FORMAT | Choose output format (PNG, JPEG, WebP) |
CLI
imgx-mcp also works as a standalone command-line tool.
Install
npm install -g imgx-mcp
Requires Node.js 18+.
Usage
# Generate
imgx generate -p "A coffee cup on a wooden table, morning light" -o output.png
# Edit
imgx edit -i photo.png -p "Change the background to sunset" -o edited.png
# Iterative editing
imgx edit -i photo.png -p "Make the background darker"
imgx edit --last -p "Add warm lighting"
imgx edit --last -p "Crop to 16:9" -o final.png
# Undo / redo
imgx undo # Revert to previous image in session
imgx redo # Re-apply an undone edit
# History
imgx history # Show all sessions and entries
imgx history switch <session-id> # Switch to a different session
imgx history clear # Clear project history (interactive)
imgx history clear --yes # Clear without confirmation
imgx history clear --keep-files # Clear history but keep image files
imgx history clear --all # Clear ALL history across all projects
# Provider management
imgx providers # List providers and capabilities
imgx capabilities # Detailed capabilities of current provider
CLI options
| Flag | Short | Description |
|---|---|---|
--prompt | -p | Image description or edit instruction (required) |
--output | -o | Output file path (auto-generated if omitted) |
--input | -i | Input image to edit (edit command only) |
--last | -l | Use last output as input (edit command only) |
--aspect-ratio | -a | 1:1, 16:9, 9:16, 4:3, 3:4, 2:3, 3:2 + Gemini 3.x: 1:4, 1:8, 4:1, 4:5, 5:4, 8:1, 21:9 |
--resolution | -r | 1K, 2K, 4K |
--count | -n | Number of images to generate |
--format | -f | Output format: png, jpeg, webp (OpenAI only) |
--background | -b | Background: transparent, opaque, auto (OpenAI only) |
--quality | -q | Quality: low, medium, high, auto (OpenAI only) |
--model | -m | Model name |
--provider | Provider name (default: gemini) | |
--output-dir | -d | Output directory |
Configuration
imgx config set api-key <key> --provider gemini # Save Gemini API key
imgx config set api-key <key> --provider openai # Save OpenAI API key
imgx config set model <name> # Set default model
imgx config set output-dir <dir> # Set default output directory
imgx config set aspect-ratio 16:9 # Set default aspect ratio
imgx config set resolution 2K # Set default resolution
imgx config list # Show all settings
imgx config get api-key # Show a specific setting (API key is masked)
imgx config path # Show config file location
Project config (.imgxrc)
Generate a template with imgx init:
imgx init
# β creates .imgxrc in current directory
Or create manually:
{
"defaults": {
"model": "gemini-2.5-flash-image",
"outputDir": "./assets/images",
"aspectRatio": "16:9"
}
}
Project config is shared via Git. Do not put API keys in .imgxrc.
Project root configuration (3 tiers)
| Method | Scope | How to set |
|---|---|---|
IMGX_PROJECT_ROOT env var in client config | Per-client (highest priority) | Add to env in claude_desktop_config.json, .mcp.json, etc. |
Auto-detection (MCP roots / .imgxrc search) | Automatic | Works on CLI agents (Claude Code, Gemini CLI). Not available on Claude Desktop |
imgx config set project-root | All clients on the machine | Stored in user config (~/.config/imgx/config.json or %APPDATA%\imgx\config.json) |
Detection priority: env var β MCP roots β .imgxrc upward search β user config projectRoot.
History is saved to <project-root>/.imgx/output-history.json (project-scoped, not shared with other projects). Default image output goes to <project-root>/.imgx/<session-id>/. Relative paths in output and output_dir are resolved against the project root instead of the MCP server's working directory.
Settings resolution
- CLI flags (
--model,--output-dir, etc.) - Environment variables (
IMGX_MODEL,IMGX_OUTPUT_DIR, etc.) - Project config (
.imgxrcβ searched from current directory upward) - User config (
~/.config/imgx/config.jsonor%APPDATA%\imgx\config.json) - Provider defaults
Output format
All CLI commands output JSON:
{"success": true, "filePaths": ["./output.png"]}
Claude Code plugin
The plugin bundles MCP server + skill in one step. If you prefer not to configure .mcp.json and skill files manually:
/plugin marketplace add somacoffeekyoto/imgx-mcp
/plugin install imgx-mcp@somacoffeekyoto-imgx-mcp
Update: /plugin β installed β imgx-mcp β update. If the update shows no changes, uninstall and reinstall.
Uninstall: /plugin uninstall imgx-mcp@somacoffeekyoto-imgx-mcp then /plugin marketplace remove somacoffeekyoto-imgx-mcp.
Development
git clone https://github.com/somacoffeekyoto/imgx-mcp.git
cd imgx-mcp
npm install
npm run bundle # TypeScript compile + esbuild bundle
The build produces two bundles:
dist/mcp.bundle.jsβ MCP server entry pointdist/cli.bundle.jsβ CLI entry point
Uninstall
MCP server
Remove the imgx entry from your tool's MCP configuration file.
Skill
Delete the image-generation/ directory from .claude/skills/ or ~/.claude/skills/.
CLI
npm uninstall -g imgx-mcp
npm uninstall removes the package but does not delete configuration or generated files. Remove them manually if needed:
Global configuration:
# Linux / macOS
rm -rf ~/.config/imgx/
# Windows (PowerShell)
Remove-Item -Recurse -Force "$env:APPDATA\imgx"
Project history and images: Each project may have a .imgx/ directory containing edit history and generated images. Remove it from each project as needed.
rm -rf <project-root>/.imgx/
License
MIT β SOMA COFFEE KYOTO
