Codex / OpenAI Image

السجل الرسمي الوسائط والتصميم

Generate, edit and make matching sets of images with the Codex CLI or the OpenAI Images API

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

NPM package codex-openai-image-mcp
Claude Code
claude mcp add codex-openai-image -e 'IMAGEGEN_PROVIDER=codex-cli' -e 'OPENAI_API_KEY=<your openai_api_key>' -e 'IMAGEGEN_OUT_DIR=<IMAGEGEN_OUT_DIR>' -- npx -y codex-openai-image-mcp@0.1.2
إعداد JSON (Claude Desktop وCursor وVS Code)
{
    "mcpServers": {
        "codex-openai-image": {
            "command": "npx",
            "args": [
                "-y",
                "codex-openai-image-mcp@0.1.2"
            ],
            "env": {
                "IMAGEGEN_PROVIDER": "codex-cli",
                "OPENAI_API_KEY": "<your openai_api_key>",
                "IMAGEGEN_OUT_DIR": "<IMAGEGEN_OUT_DIR>"
            }
        }
    }
}

متغيرات البيئة

  • IMAGEGEN_PROVIDER إلزامي Image backend: codex-cli (your ChatGPT plan via the Codex CLI), openai-api, or mock
  • OPENAI_API_KEY سري OpenAI API key, only needed for the openai-api backend
  • IMAGEGEN_OUT_DIR Folder for generated images, relative to the working folder (default generated-images)

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. codex-openai-image-mcp
  2. What makes it different
  3. Quick start
  4. Tools
  5. Backends
  6. Settings
  7. Files and safety
  8. Development
  9. License

codex-openai-image-mcp

An MCP server that lets Claude (and any other MCP client) generate images, edit them, and make matching sets, then look at the result and keep going.

It works with two image backends:

  • Codex CLI: uses the ChatGPT plan you already have through the Codex CLI. No API key, no per-image bill.
  • OpenAI Images API: uses an OPENAI_API_KEY, for people without Codex.

Not affiliated with or endorsed by OpenAI. "OpenAI" and "Codex" are trademarks of OpenAI.

Edit an image: "make it a night scene, keep the car and composition"
A matching set in one call: "cute flat stickers: coffee, cactus, moon"

Both examples are real, unretouched output from the Codex backend.

What makes it different

  • Matching sets. generate_set makes several different images that share one style, each saved under its own name.
  • Two backends, one interface. Switch between Codex and the OpenAI API with one setting.
  • Made for an agent loop. Every call returns small previews that Claude can see, reports progress during long runs, can be cancelled, and writes a .json sidecar with the prompt and settings next to each image.
  • Careful with your files. It writes only inside its output folder, never overwrites an existing file, never changes the image you edit, and runs Codex read-only in an empty temporary folder.

Quick start

You need Node.js 20.3 or newer, plus one of:

  • the Codex CLI, signed in (codex login) with a ChatGPT plan that includes Codex image generation, or
  • an OpenAI API key with credits.
Claude Code
# Codex backend (your ChatGPT plan)
claude mcp add images -e IMAGEGEN_PROVIDER=codex-cli -- npx -y codex-openai-image-mcp

# or the OpenAI API
claude mcp add images -e IMAGEGEN_PROVIDER=openai-api -e OPENAI_API_KEY=sk-... -- npx -y codex-openai-image-mcp
Claude Desktop, Cursor and other clients

Add this to the client's MCP config (for Claude Desktop, claude_desktop_config.json):

{
  "mcpServers": {
    "images": {
      "command": "npx",
      "args": ["-y", "codex-openai-image-mcp"],
      "env": { "IMAGEGEN_PROVIDER": "codex-cli" }
    }
  }
}

For the API backend use "IMAGEGEN_PROVIDER": "openai-api" and add "OPENAI_API_KEY".

Then just ask:

  • "Make a watercolour fox for my blog header, 1536x864."
  • "Edit photo.png so it looks like a sunset."
  • "Make 5 matching app icons: home, search, profile, settings, bell."

Images are saved in ./generated-images in the folder the client was started from.

Tools

generate_image
InputDefaultNotes
promptrequired
size1024x1024Any WxH from 16 to 4096 px per side
count11–4 variants, saved as -v1, -v2, …
transparentfalseAsks for a transparent background; the result says if the output has none
references[]Up to 4 images whose style to match
out_nameslug of the promptPath inside the output folder, without extension, e.g. icons/rocket
edit_image
InputDefaultNotes
imagerequiredThe image to change. It is never modified
promptrequiredThe change, e.g. "remove the person on the left", "make it watercolour"
sizethe input's sizeWxH
masknonePNG whose transparent areas mark where to edit (OpenAI API only)
count11–4 variants
transparentfalsee.g. for cutouts
references[]Up to 3 supporting images: something to insert, or a style to apply
out_name<input name>-edited
generate_set
InputDefaultNotes
stylerequiredWhat every image shares: medium, palette, rendering, background
itemsrequired1–8 { name, prompt }; each is saved as <folder>/<name>.png
size1024x1024Same for every image
transparentfalse
references[]Up to 4 images whose style the whole set matches
folderslug of styleFolder inside the output folder

All tools crop and resize the result to exactly the size you ask for, and return the saved paths with a 512 px preview of each image.

Backends

codex-cliopenai-apimock
NeedsCodex CLI, signed inOPENAI_API_KEYnothing
Costyour ChatGPT plan's usageper imagefree
Speed~30–60 s per imagedepends on model and sizeinstant
References, edits, transparencyyesyesedits only
Edit masksnoyesno
Setsone Codex session for the whole setone image at a time, first image used as a style referenceone at a time

mock draws placeholder images, for trying the server out and for tests.

Codex backend. Each call runs codex exec --json --skip-git-repo-check --sandbox read-only --cd <empty temp folder> [--image=<file>…] -- - with a prompt that asks Codex to call its built-in image_gen tool and nothing else. The server reads the session id from Codex's JSON events and collects the images from $CODEX_HOME/generated_images/<session id>/. Codex never gets write access or sees your project beyond the images you pass it. Cancelling the request, or hitting the timeout, stops Codex. Check OpenAI's terms for scripted use of the Codex CLI with your plan.

OpenAI backend. Uses the official openai SDK. The default model is gpt-image-2.5-sunburst; set IMAGEGEN_OPENAI_MODEL=gpt-image-2.5-flare for faster results. Sizes are rounded to ones the API accepts, then resized to yours. This backend is covered by automated tests against a mocked client; it has not yet had a full live test.

Settings

VariableDefault
IMAGEGEN_PROVIDERmock; set codex-cli or openai-api
OPENAI_API_KEYrequired for openai-api
IMAGEGEN_OPENAI_MODELgpt-image-2.5-sunburst
IMAGEGEN_CODEX_BINcodex
IMAGEGEN_OUT_DIRgenerated-images, relative to the working folder
IMAGEGEN_READ_ROOTthe working folder; input images must be inside it
IMAGEGEN_TIMEOUT_SEC300, per image asked for
IMAGEGEN_MAX_PER_CALL8 images
IMAGEGEN_PREVIEW_SIZE512 px

Files and safety

  • Output is written only inside IMAGEGEN_OUT_DIR. Absolute paths, .. and symlinks that lead outside are rejected.
  • Input images (to edit, or as references) must be inside IMAGEGEN_READ_ROOT.
  • Existing files are never overwritten: a new file gets -2, -3, … instead.
  • Each image gets a <name>.json sidecar with the prompt, backend, model, size, inputs and time.
  • API keys are read from the environment only and never logged or written to sidecars.
  • IMAGEGEN_MAX_PER_CALL caps how many images one call can make.

Images are AI-generated. You are responsible for how you use them, including platform rules on AI-generated content, and for not imitating real people or brands.

Development

git clone https://github.com/meet30997/codex-openai-image-mcp.git
cd codex-openai-image-mcp
npm install
npm run build
npm test          # unit and end-to-end tests; no network or API key needed
npm run inspect   # try the tools in the MCP Inspector

To run a local build from Claude Code:

claude mcp add images -e IMAGEGEN_PROVIDER=codex-cli -- node /path/to/codex-openai-image-mcp/dist/index.js

The tests run the Codex backend against a stand-in script (test/fixtures/fake-codex.mjs) and the OpenAI backend against a fake client, so they are free and quick. PLAN.md has the design notes and roadmap. Issues and pull requests are welcome.

License

MIT

الأسئلة الشائعة

ما هو Codex / OpenAI Image؟

Generate, edit and make matching sets of images with the Codex CLI or the OpenAI Images API

كيف أثبّت Codex / OpenAI Image؟

يعمل على جهازك. في Claude Code: claude mcp add codex-openai-image -e 'IMAGEGEN_PROVIDER=codex-cli' -e 'OPENAI_API_KEY=<your openai_api_key>' -e 'IMAGEGEN_OUT_DIR=<IMAGEGEN_OUT_DIR>' -- npx -y codex-openai-image-mcp@0.1.2. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج Codex / OpenAI Image إلى مفتاح API؟

نعم. يتطلب IMAGEGEN_PROVIDER, OPENAI_API_KEY، وتضبطها في إعداداته.

هل Codex / OpenAI Image مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون Codex / OpenAI Image؟

ينشره meet30997. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.