Why This Package?

@runapi.ai/ideogram-v3-mcp is a focused Model Context Protocol server for the Ideogram V3 model line on RunAPI. It gives MCP-compatible assistants direct access to 4 endpoints and 7 model variants without loading the full RunAPI catalog.

Use this per-model server when an agent should stay scoped to Ideogram V3. Use @runapi.ai/mcp when one assistant should discover every RunAPI model line.

Install

Add it to Claude Code:

claude mcp add ideogram-v3 -s user -- npx -y @runapi.ai/ideogram-v3-mcp

Use project scope when the server should be shared with a repository:

claude mcp add ideogram-v3 -s project -- npx -y @runapi.ai/ideogram-v3-mcp

Codex, Cursor, Windsurf, VS Code, Roo Code, and other MCP hosts can use the same stdio command:

{
  "mcpServers": {
    "ideogram-v3": {
      "command": "npx",
      "args": ["-y", "@runapi.ai/ideogram-v3-mcp"]
    }
  }
}

check_pricing works before sign-in. For task creation and status polling, ask your assistant to call the login tool. It opens a browser login and saves credentials to ~/.config/runapi/config.json, the same file used by runapi login. Headless and CI hosts can still set RUNAPI_API_KEY before starting the MCP host.

Ready-made examples are in examples/ for Claude, Cursor, Windsurf, VS Code, and Roo Code.

Tools

Tool	Auth	Purpose
`edit_image`	Yes	Create an Ideogram V3 edit image task and optionally wait for a terminal status. Returns the task id, status, and output URLs.
`reframe_image`	Yes	Create an Ideogram V3 reframe image task and optionally wait for a terminal status. Returns the task id, status, and output URLs.
`remix_image`	Yes	Create an Ideogram V3 remix image task and optionally wait for a terminal status. Returns the task id, status, and output URLs.
`text_to_image`	Yes	Create an Ideogram V3 text to image task and optionally wait for a terminal status. Returns the task id, status, and output URLs.
`get_task`	Yes	Fetch the current status and latest payload for an existing task.
`check_pricing`	No	Look up current pricing for a Ideogram V3 model and endpoint.

Models

Ideogram V3 covers 7 model variants across 4 endpoints. Each tool accepts the models listed for it:

Tool	Models
`edit_image`	`ideogram-v3-character-edit`, `ideogram-v3-edit`
`reframe_image`	`ideogram-v3-reframe`
`remix_image`	`ideogram-v3-character-remix`, `ideogram-v3-remix`
`text_to_image`	`ideogram-v3-character`, `ideogram-v3-text-to-image`

Model availability can change between releases. Use check_pricing or the Ideogram V3 model page for the current catalog view.

Agent Prompts

Ask your assistant in natural language; it can inspect pricing, create the task, and return the task id plus output URLs.

Create a task

Run an Ideogram V3 edit image task with RunAPI.

The assistant can call check_pricing, then edit_image, and return the task id, status, and output URLs.

Submit without waiting

Create the task but don't wait for it to finish.

The assistant calls the create tool with wait: false and returns the task id. Check on it later with get_task.

Check pricing before creating

Check current Ideogram V3 pricing, then create the task if it matches my request.

The assistant calls check_pricing and can link to the Ideogram V3 model page for the canonical catalog entry.

Configuration

The server resolves auth in this order:

RUNAPI_API_KEY environment variable, useful for headless and CI hosts
~/.config/runapi/config.json, created by the MCP login tool or runapi login
No key, which still allows check_pricing

The config file is normally managed by login. A pre-provisioned headless config can use:

{
  "apiKey": "your_runapi_key"
}

Do not commit real API keys.

Links

Resource	URL
Ideogram V3 model page	https://runapi.ai/models/ideogram-v3
npm package	@runapi.ai/ideogram-v3-mcp
GitHub repository	runapi-ai/ideogram-v3-mcp
RunAPI MCP overview	runapi.ai/mcp
RunAPI docs	runapi.ai/docs

License

Licensed under the Apache License, Version 2.0.