mcp

What Is This?

RunAPI MCP Server connects MCP-compatible coding tools to RunAPI. It lets an assistant browse the RunAPI catalog, inspect model inputs, check current pricing snapshots, create media tasks, poll task status, and check account balance.

The discovery tools work without an API key because they use the embedded build-time catalog. Authenticated operations require RUNAPI_API_KEY.

This package is a pure client. It does not run a local generation backend and does not require changes to your RunAPI account beyond creating an API key for authenticated tools.

Quick Start

For Claude Code, Cursor, Windsurf, and VS Code, install RunAPI with Claude Code's MCP command:

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

The scope flag controls where the MCP server is stored:

• -s user: global, available in all projects for your user.
• -s project: team-shared, written to .mcp.json in the current repo so it can be committed.

Use project scope when you want the whole team to share the same server config:

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

Compatibility fallback for non-Claude Code platforms or manual JSON config:

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

If your host needs a generated config file, use the legacy init command as a fallback:

npx @runapi.ai/mcp init claude
npx @runapi.ai/mcp init cursor
npx @runapi.ai/mcp init vscode
npx @runapi.ai/mcp init windsurf
npx @runapi.ai/mcp init roo

Free catalog tools work even when RUNAPI_API_KEY is not configured. For task creation and balance checks, create an API key in the RunAPI dashboard and expose it as RUNAPI_API_KEY.

Tools

The catalog, pricing, and prompt search tools are designed for funnel-top discovery inside coding tools. The task and balance tools are designed for authenticated workflows.

Examples

Ask your assistant natural-language questions. The assistant should use the tools to discover current model slugs and pricing instead of relying on memorized names.

Browse The Catalog

What RunAPI image models are available?

Expected behavior:

1. The assistant calls list_models with modality: "image".
2. It summarizes the returned model slugs, services, actions, and required fields.
3. It avoids quoting stale prices unless it calls check_pricing.

Search Prompt Examples

Find image prompt examples for a logo.

Expected behavior:

1. The assistant calls search_prompts with modality: "image" and q: "logo".
2. It summarizes returned titles, prompt text, model slugs, categories, and tags.
3. It uses the selected prompt with get_model_info before creating a task.

Inspect A Model

Show me the required parameters for this model slug: <model-slug>

Expected behavior:

1. The assistant calls get_model_info.
2. If the response is ambiguous, it chooses the relevant service/action from the returned matches and calls get_model_info again with service and action.
3. It shows required fields, enum constraints, range constraints, conditional input rules, supported action, and pricing snapshot if present.
4. It tells you to choose another slug with list_models if the slug is not found.

Create A Media Task

Generate a square product image with RunAPI. Pick a suitable image model.

Expected behavior:

1. The assistant calls list_models to choose a compatible image model.
2. It calls get_model_info with the selected service/action/model to validate parameters and any conditional input rules.
3. It asks for confirmation if the request is expensive, long-running, or a batch.
4. It calls create_task.
5. It returns task ID, status, output URLs, and cost fields when available.

Submit Without Waiting

Create the task but do not wait for completion.

Expected behavior:

1. The assistant calls create_task with wait: false.
2. It returns the task ID.
3. You can later ask for status with get_task.

Check Account Balance

Check my RunAPI balance.

Expected behavior:

1. The assistant calls check_balance.
2. If no key is configured, it explains how to set RUNAPI_API_KEY.

Catalog Coverage

The embedded catalog is generated from RunAPI's contract snapshot. It includes media models, utility endpoints, and LLM model slugs for discovery.

Catalog contents can change between releases. Use list_models for current service/action/model slugs and get_model_info for each model's current constraints. For LLM inference, connect through the RunAPI API or SDK directly.

Pricing

RunAPI pricing is exposed through the check_pricing tool and the public pricing page. Do not rely on examples in README files for exact prices.

Useful flows:

1. Call list_models to find a candidate model.
2. Call check_pricing with service, action, and model.
3. Show the returned pricing snapshot or link to runapi.ai/pricing.

Free catalog tools do not create tasks and do not consume account balance.

Platform Setup

Claude Code, Cursor, Windsurf, And VS Code

Run:

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

Use -s user for a global install available in all projects. Use -s project when you want Claude Code to write .mcp.json in the repo for team-shared config.

Restart or reload your MCP host after changing MCP configuration.

Compatibility Fallback: Generated Config

Use init only when a host needs a platform-specific JSON file or cannot use the Claude Code MCP command.

Claude Code fallback:

npx @runapi.ai/mcp init claude

This writes .mcp.json in the current directory.

Cursor fallback:

npx @runapi.ai/mcp init cursor

This writes .cursor/mcp.json. Open Cursor settings to verify the MCP server is enabled.

VS Code fallback:

npx @runapi.ai/mcp init vscode

This writes .vscode/mcp.json. VS Code uses a top-level servers key and type: "stdio" in generated config.

Windsurf fallback:

npx @runapi.ai/mcp init windsurf

This writes the generated config for the Windsurf target used by the init command.

Roo Code

Run:

npx @runapi.ai/mcp init roo

This writes .roo/mcp.json.

Manual Configuration

Use the example files in examples/ as starting points. Each platform has slightly different wrapper keys and file paths, but all run the same command:

npx -y @runapi.ai/mcp

Configuration

The server reads configuration in this order:

1. RUNAPI_API_KEY environment variable
2. ~/.config/runapi/config.json
3. No key, which still allows free catalog tools

Example config file:

{
  "apiKey": "your_runapi_key"
}

You can also set a custom base URL for local testing:

{
  "apiKey": "your_runapi_key",
  "baseUrl": "https://runapi.ai"
}

Do not commit real API keys.

Data Sync

This package ships build-time data files:

• data/contract.json: catalog, actions, model slugs, and input constraints
• data/pricing.json: pricing snapshot used by check_pricing

Refresh data from the RunAPI source tree before a release:

npm run sync:data

Build-time data means a pricing or catalog update requires a new package release.

Development

npm install
npm run typecheck
npm test
npm pack --dry-run

Run the server locally: