z-image-mcp
This server provides AI agents with tools to create and monitor Z Image text-to-image generation tasks on RunAPI, and check pricing.
Generate images from text (
text_to_image): Submit a text prompt and aspect ratio (1:1, 4:3, 3:4, 16:9, 9:16) to create an image generation task. Supports optional polling until completion (wait: true/false), configurable timeout, and poll interval. Returns a task ID, status, and output image URLs.Check task status (
get_task): Retrieve the current status and latest result payload for a previously created task using its task ID.Look up pricing (
check_pricing): Fetch the current pricing snapshot for the Z Image model and its text-to-image endpoint — no API key required.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@z-image-mcp generate an image of a sunset over mountains"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
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.
Related MCP server: GPT Image MCP Server
Install
Add it to Claude Code:
claude mcp add z-image -s user -- npx -y @runapi.ai/z-image-mcpUse project scope when the server should be shared with a repository:
claude mcp add z-image -s project -- npx -y @runapi.ai/z-image-mcpCodex, 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"]
}
}
}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 |
| Yes | Create a Z Image text to image task and optionally wait for a terminal status. Returns the task id, status, and output URLs. |
| Yes | Fetch the current status and latest payload for an existing task. |
| No | Look 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:
Tool | Models |
|
|
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 resolves auth in this order:
RUNAPI_API_KEYenvironment variable, useful for headless and CI hosts~/.config/runapi/config.json, created by the MCPlogintool orrunapi loginNo 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 |
Z Image model page | |
npm package | |
GitHub repository | |
RunAPI MCP overview | |
RunAPI docs |
License
Licensed under the Apache License, Version 2.0.
Available Tools
4 toolscheck_pricingB
Look up RunAPI pricing for the z-image model line.
Inputs: model, action.
get_taskB
Fetch the current status and latest result payload for a z-image task.
Inputs: task_id (required), action.
loginA
Authenticate RunAPI by opening a browser PKCE login flow and saving the API key to ~/.config/runapi/config.json.
Inputs: force.
text_to_imageB
Create a Z Image task on RunAPI (text to image). Returns a task id, status, and output URLs.
Inputs: prompt (required), aspect_ratio (required), wait, model, +4 more.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 4 tools
Each tool targets a clearly distinct concern: authentication (login), task creation (text_to_image), task polling (get_task), and pricing lookup (check_pricing). No two tools could plausibly be confused for one another.
Three tools follow a readable verb/noun style (get_task, check_pricing, text_to_image) while 'login' is a bare verb, a minor deviation. The overall pattern is predictable enough that an agent can infer intent from names alone.
Four tools is a lean but coherent minimum for a single-model image generation service: authenticate, generate, poll, check cost. It is slightly thin but nothing feels redundant or padded.
The core create-then-poll lifecycle is covered, but there is no cancel/delete task, no list-tasks operation, and no image-to-image or edit variant for what is presumably an image model. Agents can work around these gaps but will hit dead ends for anything beyond basic text-to-image generation.
Maintenance
Related MCP Connectors
Generate images, videos and music with model discovery, cost estimates and asynchronous results.
Generate and edit images, create videos, quote credit costs, and retrieve private results.
LLM chat, text tools, image generation, editing, batch image jobs, and asynchronous video generation
Create images and videos from prompts, with options for image mixing, reference images, and start/…
Related MCP Servers
AlicenseAqualityFmaintenanceEnables AI video and image generation through the Runway API. Supports video generation from images and text prompts, image creation, video upscaling and editing, and task management.718 npm23MIT- AlicenseAqualityBmaintenanceEnables creating and managing GPT Image tasks (edit and text-to-image) via RunAPI, with options to poll status and check pricing.5136 npmApache 2.0
- AlicenseBqualityBmaintenanceEnables AI image and video generation tasks (text-to-image, image-to-video, edit, upscale, etc.) via RunAPI, with support for polling and pricing lookups.1084 npm1Apache 2.0
- AlicenseAqualityBmaintenanceEnables image editing, remixing, and text-to-image generation using Qwen 2 models via RunAPI. Supports task polling and pricing checks.5109 npmApache 2.0