Z Image Mcp

io.github.runapi-builderPublished by GitHub account runapi-builderv0.2.1Updated Oct 29, 2026

RunAPI MCP server for Z Image: create tasks, poll status, check pricing.

VerifiedSTDIODesktop onlyMedia & DesignAI & ML

Overview

AI-generated overview

RunAPI's Z Image MCP server lets an assistant generate images from text prompts, poll task status, and check pricing for the z-image model line.

What you can do
  • Create text-to-image tasks on RunAPI's Z Image model, optionally waiting for completion, and get back task IDs, status and output URLs
  • Fetch the current status and latest result payload of an existing image task
  • Look up RunAPI pricing for the z-image model line before submitting work
  • Authenticate through a browser login flow that saves the RunAPI API key to a shared config file
When to use it
Use it when an assistant should be able to generate images through RunAPI's Z Image model and stay scoped to that single model line rather than the full RunAPI catalog. Also useful for checking pricing before running a task, or for submitting a task and polling it later.
Requirements
Runs locally over stdio, typically launched with npx from the npm package, so Node.js is needed. A RunAPI account is required for task creation and status polling: either the login tool (browser PKCE flow writing to the RunAPI config file) or the RUNAPI_API_KEY environment variable for headless and CI hosts. Pricing lookup works without a key. Network access to RunAPI is required.
Before you install
Task creation spends money on RunAPI, so confirm cost and scope before expensive or batch requests. The login tool writes an API key to a shared config file on disk; keep that file and any RUNAPI_API_KEY value out of version control. Prompts and task data are sent to RunAPI's service. Generated media is returned as URLs and is not inspected by the assistant.

Installation

In SourceWeft

  1. Open Z Image Mcp in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

README

RunAPI Z Image MCP Server

Z Image API access for AI agents: run image generation operations, poll asynchronous results, and check pricing through one focused MCP server.

Works with Claude Code, Codex, Cursor, Windsurf, VS Code, Roo Code, and any MCP-compatible host.

[npm version] [GitHub repository] [Apache-2.0 license] [MCP Server] [1 models]

Install | Tools | Models | Agent Prompts | Configuration | Links


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:

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

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

json
{  "mcpServers": {    "z-image": {      "command": "npx",      "args": ["-y", "@runapi.ai/z-image-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

ToolAuthPurpose
text_to_imageYesCreate a Z Image text to image task and optionally wait for a terminal status. Returns the task id, status, and output URLs.
get_taskYesFetch the current status and latest payload for an existing task.
check_pricingNoLook up current pricing for a Z Image model and endpoint.

Models

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

ToolModels
text_to_imagez-image

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

text
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

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

ResourceURL
Z Image model pagehttps://runapi.ai/models/z-image
npm package@runapi.ai/z-image-mcp
GitHub repositoryrunapi-ai/z-image-mcp
RunAPI MCP overviewrunapi.ai/mcp
RunAPI docsrunapi.ai/docs

License

Licensed under the Apache License, Version 2.0.

Source: README.md at commit bd8d57f

Tools

4

login

Authenticate RunAPI by opening a browser PKCE login flow and saving the API key to ~/.config/runapi/config.json.

Parametersforce

text_to_image

Create a Z Image task on RunAPI (text to image). Returns a task id, status, and output URLs.

Parameterswaitmodelpromptrequiredtimeout_msaspect_ratiorequiredcallback_urlpoll_interval_msenable_safety_checker

get_task

Fetch the current status and latest result payload for a z-image task.

Parametersactiontask_idrequired

check_pricing

Look up RunAPI pricing for the z-image model line.

Parametersmodelaction

Version history

3
  1. v0.2.1LatestOct 22, 2026
  2. v0.2.0Sep 30, 2026
  3. v0.1.7Sep 16, 2026

Score

90% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts
  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listedRequired15 pts
  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts