io.github.runapi-builder/z-image-mcp

Why This Package?

@runapi.ai/z-image-mcp is a focused Model Context Protocol server for the Z Image model line on RunAPI. It gives MCP-compatible assistants direct access to 1 endpoint and 1 model variant without loading the full RunAPI catalog.

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

Install

Add it to Claude Code:

claude mcp add z-image -s user -- npx -y @runapi.ai/z-image-mcp

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

claude mcp add z-image -s project -- npx -y @runapi.ai/z-image-mcp

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

{
  "mcpServers": {
    "z-image": {
      "command": "npx",
      "args": ["-y", "@runapi.ai/z-image-mcp"],
      "env": { "RUNAPI_API_KEY": "${RUNAPI_API_KEY}" }
    }
  }
}

Create an API key at runapi.ai and expose it as RUNAPI_API_KEY. check_pricing can run without a key; task creation and status polling require one.

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

Tools

Models

Z Image covers 1 model variant across 1 endpoint. Each tool accepts the models listed for it:

Model availability can change between releases. Use check_pricing or the Z Image 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 a Z Image text to image task with RunAPI.

The assistant can call check_pricing, then text_to_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 Z Image pricing, then create the task if it matches my request.

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

Configuration

The server reads the API key in this order:

1. RUNAPI_API_KEY environment variable
2. ~/.config/runapi/config.json

Example config file:

{
  "apiKey": "your_runapi_key"
}

Do not commit real API keys. Get one at runapi.ai.

Links

License

Licensed under the Apache License, Version 2.0.