🎩 You're Invited:Meet the Socket team at Black Hat in Las Vegas, August 3-6.RSVP
Sign In

image-generation-mcp

Package Overview
Dependencies
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

image-generation-mcp

MCP server for AI image generation via OpenAI, Google GenAI, or Stable Diffusion WebUI

pipPyPI
Version
1.11.0
Weekly downloads
138
Maintainers
1

Image Generation MCP

CI codecov PyPI Python License Docker Docs llms.txt Template

Multi-provider image generation MCP server built on FastMCP. Generate images from Claude Desktop, Claude Code, or any MCP client using OpenAI, Google Gemini, Stable Diffusion (SD WebUI), or a zero-cost placeholder provider.

Documentation | Config wizard | PyPI | Docker

Features

  • Multi-provider: OpenAI (gpt-image-2, gpt-image-1.5, dall-e-3), Google Gemini (gemini-3.1-flash-image, gemini-3-pro-image, gemini-3.1-flash-lite-image), SD WebUI (Stable Diffusion / Forge / reForge), and a zero-cost placeholder for testing.
  • Per-model style metadata: every model carries a style_profile (strengths, prompt grammar, lifecycle); list_providers includes a top-level warnings array for deprecated models. See Model Catalog.
  • Keyword-based auto-selection: provider="auto" routes by prompt content (text/logo → OpenAI, photoreal/anime → SD WebUI, draft → placeholder).
  • CDN-style image transforms: image://{id}/view?format=webp&width=512&crop_x=... resizes / re-encodes / crops on demand without re-generating.
  • Hybrid background tasks: long-running SD generations run with task=True (poll for status); short OpenAI calls stream progress in the foreground.
  • MCP Apps gallery + viewer: interactive UI surfaces (browse generated images, edit / crop / rotate) for clients that support app: resources.
  • Production deployment: Docker (multi-arch), .deb/.rpm with hardened systemd, OIDC + bearer auth, persistent EventStore for HTTP session resumability.

What you can do with it

With this server mounted in an MCP client, you can ask:

  • "Generate a coffee mug product photo on a worn oak table, 16:9, no text." Routes to gpt-image-1.5 for typography-aware photorealism.
  • "Create three concept-art variations of a cyberpunk alley at dusk." Composes generate_image with provider="sd_webui" and a stylised checkpoint like dreamshaperXL.
  • "Crop this image to a 1:1 square centred on the subject and resize to 512px." Uses image://{id}/view?width=512&height=512&crop_x=... resource transforms.
  • "Show me my recent generations." Browses the gallery via the image://list resource and the MCP Apps gallery viewer.
  • "Save this style as 'cyberpunk-night' so I can apply it to future requests." Uses the style library, whose markdown briefs the LLM interprets per-provider.
  • "Replace the background of my last photo with a sunset sky." Uses transform_image with the gallery image_id as a reference (image-to-image via Gemini).

Installation

From PyPI

pip install image-generation-mcp

If you add optional extras via the PROJECT-EXTRAS-START / PROJECT-EXTRAS-END sentinels in pyproject.toml, document them below:

ExtraIncludesUse when
mcpfastmcp[tasks]>=3.0,<4Background-task support (task=True), required for long SD generations.
openaiopenai>=1.0Enables the OpenAI provider.
google-genaigoogle-genai>=1.0Enables the Gemini provider.
allfastmcp[tasks] + openai + google-genaiEverything except SD WebUI (which is HTTP-only, no extra needed).

Example: pip install image-generation-mcp[all].

From source

git clone https://github.com/pvliesdonk/image-generation-mcp.git
cd image-generation-mcp
uv sync --all-extras --all-groups

Docker

docker pull ghcr.io/pvliesdonk/image-generation-mcp:latest

A compose.yml ships at the repo root as a starting point. Copy .env.example to .env, edit, and docker compose up -d.

To attach a remote Python debugger (development only; the protocol is unauthenticated), see Remote debugging.

Linux packages (.deb / .rpm)

Download .deb or .rpm packages from the GitHub Releases page. Both install a hardened systemd unit; env configuration is sourced from /etc/image-generation-mcp/env (copy from the shipped /etc/image-generation-mcp/env.example).

Claude Desktop (.mcpb bundle)

Download the .mcpb bundle from the GitHub Releases page and double-click to install, or run:

mcpb install image-generation-mcp-<version>.mcpb

Claude Desktop prompts for required env vars via a GUI wizard, with no manual JSON editing needed.

For manual Claude Desktop configuration and setup options, see Claude Desktop deployment.

Quick start

image-generation-mcp serve                                # stdio transport
image-generation-mcp serve --transport http --port 8000   # streamable HTTP

For library usage (embedding the domain logic without the MCP transport), import from the image_generation_mcp package directly. See the project's domain modules under src/image_generation_mcp/ for entry points.

Server info

The server registers a built-in get_server_info tool (via fastmcp_pvl_core.register_server_info_tool) so operators can confirm the deployed version with a single MCP call. The default response carries server_name, server_version, and core_version. Servers that talk to a remote upstream wire upstream version reporting inside the DOMAIN-UPSTREAM-START / DOMAIN-UPSTREAM-END sentinel in src/image_generation_mcp/server.py; see CLAUDE.md for the wiring pattern.

Configuration

Core environment variables shared across all fastmcp-pvl-core-based services:

VariableDefaultDescription
FASTMCP_LOG_LEVELINFOLog level for FastMCP internals and app loggers (DEBUG / INFO / WARNING / ERROR). The -v CLI flag overrides to DEBUG.
FASTMCP_ENABLE_RICH_LOGGINGtrueSet to false for plain / structured JSON log output.
IMAGE_GENERATION_MCP_KV_STORE_URLfile:///data/statePersistent-state backend URL for pvl-core subsystems: file:///path (survives restarts), memory:// (dev/ephemeral).

Domain-specific variables go below under Domain configuration.

Authentication

Callers authenticate via a bearer token or OIDC (mutually exclusive). See the Authentication guide for setup, mapped multi-subject tokens, OIDC, and troubleshooting.

Post-scaffold checklist

After copier copy and gh repo create --push:

  • Fill in the DOMAIN blocks (every section marked with a DOMAIN sentinel comment) in this README and in CLAUDE.md.
  • Configure GitHub secrets (see below).
  • Install dev + docs tooling: uv sync --all-extras --all-groups.
  • Install pre-commit hooks: uv run pre-commit install.
  • Run the gate locally: uv run pytest -x -q && uv run ruff check --fix . && uv run ruff format . && uv run mypy src/ tests/.
  • Push the first commit. CI should be green.

GitHub secrets

CI workflows reference three repository secrets. Configure them via Settings → Secrets and variables → Actions or with gh secret set:

SecretUsed byHow to generate
RELEASE_TOKENrelease.yml, copier-update.ymlFine-grained PAT at https://github.com/settings/personal-access-tokens/new with contents: write and pull_requests: write (the copier-update cron opens PRs). Scoped to this repo.
CODECOV_TOKENci.ymlhttps://codecov.io: sign in with GitHub and add the repo. The upload token is on the repo settings page.
CLAUDE_CODE_OAUTH_TOKENclaude.yml, claude-code-review.ymlRun claude setup-token locally and paste the result.
gh secret set RELEASE_TOKEN
gh secret set CODECOV_TOKEN
gh secret set CLAUDE_CODE_OAUTH_TOKEN

GITHUB_TOKEN is auto-provided; no action needed.

Local development

The PR gate (matches CI):

uv run pytest -x -q                                  # tests
uv run ruff check --fix . && uv run ruff format .    # lint + format
uv run mypy src/ tests/                              # type-check

Pre-commit runs a subset of the gate on each commit; see .pre-commit-config.yaml for details, or CLAUDE.md for the full Hard PR Acceptance Gates.

Troubleshooting

Moving a scaffolded project

uv sync creates .venv/bin/* scripts with absolute shebangs pointing at the venv Python. If you move the repo after scaffolding (mv /old/path /new/path), uv run pytest fails with ModuleNotFoundError: No module named 'fastmcp' because the stale shebang resolves to a different interpreter than the venv's site-packages.

Fix:

rm -rf .venv
uv sync --all-extras --all-groups

uv run python -m pytest also works as a one-shot workaround (bypasses the stale entry-script shim).

uv.lock refresh after copier update

When copier update introduces new dependencies (such as a new extra added to pyproject.toml.jinja), CI runs uv sync --frozen which fails against a stale lockfile. Run uv lock locally and commit the refreshed uv.lock alongside accepting the copier-update PR.

Domain configuration

All domain environment variables use the IMAGE_GENERATION_MCP_ prefix.

Core

VariableDefaultRequiredDescription
IMAGE_GENERATION_MCP_SCRATCH_DIR~/.image-generation-mcp/images/NoDirectory for saved generated images.
IMAGE_GENERATION_MCP_READ_ONLYtrueNoHide write-tagged tools (generate_image). Set to false to enable generation.
IMAGE_GENERATION_MCP_DEFAULT_PROVIDERautoNoDefault provider: auto, openai, gemini, sd_webui, placeholder.

Providers

VariableDefaultRequiredDescription
IMAGE_GENERATION_MCP_OPENAI_API_KEY(none)NoOpenAI API key; enables OpenAI provider when set.
IMAGE_GENERATION_MCP_GOOGLE_API_KEY(none)NoGoogle API key with Gemini access; enables Gemini provider when set.
IMAGE_GENERATION_MCP_SD_WEBUI_HOST(none)NoSD WebUI URL (http://localhost:7860); enables SD WebUI provider when set. Deprecated alias: A1111_HOST.
IMAGE_GENERATION_MCP_SD_WEBUI_MODEL(none)NoSD WebUI checkpoint name for preset detection and override. Deprecated alias: A1111_MODEL.

Authentication

VariableDefaultRequiredDescription
IMAGE_GENERATION_MCP_BEARER_TOKEN(none)NoStatic bearer token; enables bearer auth when set.
IMAGE_GENERATION_MCP_BASE_URL(none)NoPublic base URL for OIDC and MCP File Exchange downloads (https://mcp.example.com).
IMAGE_GENERATION_MCP_OIDC_CONFIG_URL(none)NoOIDC discovery endpoint URL.
IMAGE_GENERATION_MCP_OIDC_CLIENT_ID(none)NoOIDC client ID.
IMAGE_GENERATION_MCP_OIDC_CLIENT_SECRET(none)NoOIDC client secret.
IMAGE_GENERATION_MCP_OIDC_JWT_SIGNING_KEYephemeralYes on Linux/DockerJWT signing key.
IMAGE_GENERATION_MCP_OIDC_AUDIENCE(none)NoExpected JWT audience claim.
IMAGE_GENERATION_MCP_OIDC_REQUIRED_SCOPESopenidNoComma-separated required scopes.
IMAGE_GENERATION_MCP_OIDC_VERIFY_ACCESS_TOKENfalseNoVerify access token as JWT instead of id token.

Cost control & performance

VariableDefaultRequiredDescription
IMAGE_GENERATION_MCP_PAID_PROVIDERSopenaiNoComma-separated paid provider names. Triggers an elicitation cost-confirmation on capable clients. Gemini is omitted by default (generous free tier); add gemini if you rely on quality="hd", which bills thinking tokens. Set to empty to disable.
IMAGE_GENERATION_MCP_TRANSFORM_CACHE_SIZE64NoMax cached transforms. Set to 0 to disable caching.

Reference image input (transform_image)

VariableDefaultRequiredDescription
IMAGE_GENERATION_MCP_ALLOW_LOCAL_FILE_INPUTfalseNoEnable local filesystem paths as transform_image reference images. Security: grants callers server-filesystem read access via path; enable only for trusted callers or local single-user deployments.
IMAGE_GENERATION_MCP_MAX_INPUT_IMAGE_BYTES20971520NoPer-reference maximum byte size for input images (default 20 MiB).

File Exchange (MCP downloads)

VariableDefaultRequiredDescription
IMAGE_GENERATION_MCP_FILE_EXCHANGE_ENABLEDtrue on http/sse, false on stdioNoMaster switch for the file-exchange producer. Set false to suppress all file_ref publishing.
IMAGE_GENERATION_MCP_FILE_EXCHANGE_TTL3600NoDefault and maximum TTL (seconds) for published files and download URLs. create_download_link's ttl_seconds is clamped to this.
IMAGE_GENERATION_MCP_FILE_EXCHANGE_CONSUMEtrueRecommended falseMaster switch for the consumer side. This server is producer-only; set false to silence the upstream "consume on, no consumer_sink wired" startup warning.

Server identity

VariableDefaultRequiredDescription
IMAGE_GENERATION_MCP_SERVER_NAMEimage-generation-mcpNoServer name shown to MCP clients.
IMAGE_GENERATION_MCP_INSTRUCTIONS(computed)NoSystem instructions for LLM context.
IMAGE_GENERATION_MCP_HTTP_PATH/mcpNoHTTP endpoint mount path.
IMAGE_GENERATION_MCP_APP_DOMAIN(auto)NoMCP Apps widget sandbox domain. Auto-computed from BASE_URL for Claude; override for other hosts.

Domain-config fields are composed inside src/image_generation_mcp/config.py between the CONFIG-FIELDS-START / CONFIG-FIELDS-END sentinels; env reads go through fastmcp_pvl_core.env(_ENV_PREFIX, "SUFFIX", default) so naming stays consistent.

For the full MCP tool / resource / prompt surface and per-provider setup notes, see the documentation site.

Key design decisions

  • Multi-provider with capability discovery, not feature flags. Each provider's discover_capabilities() reports its actual supported aspect ratios / qualities / formats / negative-prompt support at startup; routing logic asks the capability surface, not a hard-coded enum. New providers slot in by satisfying the protocol, with no router edits needed. (See docs/decisions/0001-…, 0002-…, 0007-….)
  • Per-model style_profile metadata, surfaced via list_providers. Closed-list providers (OpenAI, Gemini, placeholder) use exact-key lookup; SD WebUI uses a regex-ordered pattern table. Profiles include lifecycle flags (current / legacy / deprecated) and feed an auto-built top-level warnings array. (See docs/decisions/0009-….)
  • Hybrid background tasks. Short calls (OpenAI ~5 s) stream progress in-line; long calls (SD WebUI 30-180 s) run as background tasks with check_generation_status polling; clients pick the mode via task=True. (See docs/decisions/0005-….)
  • Image asset model: content-addressed registry + sidecar JSON metadata + on-demand transforms. Generated images keep their full-resolution original; image://{id}/view?format=webp&width=512&crop_x=… resources do format conversion / resize / crop on demand without re-generating. Transforms are cached. (See docs/decisions/0006-….)
  • Style library. User-saved markdown briefs (with YAML frontmatter for tags / aspect ratio / quality) that the LLM interprets per-provider, not copy-pasted verbatim. Distinct from per-model style_profile: style library is the brief; style_profile describes the model. (See docs/decisions/0008-… and 0009-… for disambiguation.)
  • Composes fastmcp_pvl_core.ServerConfig, never inherits. Domain config goes between CONFIG-FIELDS-START / CONFIG-FIELDS-END sentinels; env reads route through fastmcp_pvl_core.env(...) to keep prefix naming consistent.

Keywords

fastmcp

FAQs

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts