<h1 align="center">RunAPI Ideogram V3 MCP Server</h1>

<p align="center">
  <strong>Ideogram V3 API access for AI agents: run image generation operations, poll asynchronous results, and check pricing through one focused MCP server.</strong>
</p>

<p align="center">
  <sub>Works with Claude Code, Codex, Cursor, Windsurf, VS Code, Roo Code, and any MCP-compatible host.</sub>
</p>

<p align="center">
  <a href="https://www.npmjs.com/package/@runapi.ai/ideogram-v3-mcp"><img src="https://img.shields.io/npm/v/%40runapi.ai/ideogram-v3-mcp?style=flat-square&color=blue" alt="npm version"></a>
  <a href="https://github.com/runapi-ai/ideogram-v3-mcp"><img src="https://img.shields.io/badge/GitHub-runapi--ai%2Fideogram--v3--mcp-24292f?style=flat-square" alt="GitHub repository"></a>
  <a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue?style=flat-square" alt="Apache-2.0 license"></a>
  <img src="https://img.shields.io/badge/Type-MCP_Server-blue?style=flat-square" alt="MCP Server">
  <img src="https://img.shields.io/badge/Models-7-16a34a?style=flat-square" alt="7 models">
</p>

<p align="center">
  <a href="#install">Install</a> |
  <a href="#tools">Tools</a> |
  <a href="#models">Models</a> |
  <a href="#agent-prompts">Agent Prompts</a> |
  <a href="#configuration">Configuration</a> |
  <a href="#links">Links</a>
</p>

---

## 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`](https://github.com/runapi-ai/mcp) when one assistant should discover every RunAPI model line.

---

## Install

Add it to Claude Code:

```bash
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:

```bash
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:

```json
{
  "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/`](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](https://runapi.ai/models/ideogram-v3) 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

```text
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

```text
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

```text
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](https://runapi.ai/models/ideogram-v3) for the canonical catalog entry.

---

## Configuration

The server resolves auth in this order:

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

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

```json
{
  "apiKey": "your_runapi_key"
}
```

Do not commit real API keys.

---

## Links

| Resource | URL |
|---|---|
| Ideogram V3 model page | [https://runapi.ai/models/ideogram-v3](https://runapi.ai/models/ideogram-v3) |
| npm package | [@runapi.ai/ideogram-v3-mcp](https://www.npmjs.com/package/@runapi.ai/ideogram-v3-mcp) |
| GitHub repository | [runapi-ai/ideogram-v3-mcp](https://github.com/runapi-ai/ideogram-v3-mcp) |
| RunAPI MCP overview | [runapi.ai/mcp](https://runapi.ai/mcp) |
| RunAPI docs | [runapi.ai/docs](https://runapi.ai/docs) |

---

## License

Licensed under the [Apache License, Version 2.0](LICENSE).