@runapi.ai/mcp
v0.1.10
Published
RunAPI MCP server for model discovery, pricing lookup, media task creation, and balance checks.
Maintainers
Readme
这是什么?
RunAPI MCP Server 让 Claude Code、Cursor、VS Code、Windsurf、Roo 等 MCP Host 可以直接使用 RunAPI。 它支持浏览模型目录、查看模型输入参数、查询价格快照、创建媒体任务、轮询任务状态和查询账户余额。
目录发现工具不需要 API Key,因为它们使用包内嵌的构建时目录数据。
创建任务和查询余额需要 RUNAPI_API_KEY。
快速开始
Claude Code、Cursor、Windsurf 和 VS Code 推荐使用 Claude Code 的 MCP 命令安装:
claude mcp add runapi -s user -- npx -y @runapi.ai/mcpscope 参数决定 MCP Server 配置保存在哪里:
-s user:全局配置,对当前用户的所有项目可用。-s project:团队共享配置,写入当前仓库的.mcp.json,可以提交到 repo。
如果希望团队共享同一份配置,使用 project scope:
claude mcp add runapi -s project -- npx -y @runapi.ai/mcp非 Claude Code 平台或手动 JSON 配置的兼容 fallback:
{
"mcpServers": {
"runapi": {
"command": "npx",
"args": ["-y", "@runapi.ai/mcp"],
"env": {
"RUNAPI_API_KEY": "${RUNAPI_API_KEY}"
}
}
}
}如果你的 MCP Host 需要生成平台专用配置文件,可以把旧的 init 命令作为 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免费目录工具即使没有 RUNAPI_API_KEY 也可用。
认证工具需要先在 RunAPI Dashboard 创建 API Key,并把它设置为 RUNAPI_API_KEY。
工具
| Tool | 认证 | 用途 |
|---|---|---|
| list_models | 否 | 从内嵌目录列出 RunAPI 模型,支持 modality、service、action 过滤。 |
| get_model_info | 否 | 返回某个模型 slug 的 service、action、modality、输入约束和价格快照。模型出现在多个 endpoint 时,带上 service + action 精确查询。 |
| list_actions | 否 | 按 modality 分组列出 endpoint action 名称。 |
| check_pricing | 否 | 查询 service + action + model 组合的价格快照。 |
| search_prompts | 否 | 按 modality、category、tags、q、model、featured 和分页搜索可复用 prompt 示例。 |
| create_task | 是 | 创建媒体任务,并可选择轮询到完成。 |
| get_task | 是 | 查询已有媒体任务的状态和最新 payload。 |
| check_balance | 是 | 查询账户余额和消费指标。 |
示例
你可以用自然语言让助手调用工具。 助手应该通过工具发现当前模型 slug 和价格,而不是依赖记忆里的模型名。
浏览目录
RunAPI 有哪些图片模型?预期行为:
- 调用
list_models,传入modality: "image"。 - 总结返回的 model slug、service、action 和 required fields。
- 除非调用
check_pricing,否则不直接报价。
搜索 Prompt 示例
找一些 logo 图片 prompt 示例。预期行为:
- 调用
search_prompts,传入modality: "image"和q: "logo"。 - 总结返回的 title、prompt text、model slug、category 和 tags。
- 创建任务前,先用
get_model_info检查选中模型的参数约束。
查看模型参数
查看这个模型 slug 的必填参数:<model-slug>预期行为:
- 调用
get_model_info。 - 如果返回 ambiguous,从 matches 里选择相关 service/action,并带上
service和action再调用一次get_model_info。 - 展示 required fields、enum、range、条件输入规则、支持的 action 和价格快照。
- 如果 slug 不存在,提示先用
list_models选择有效 slug。
创建媒体任务
用 RunAPI 生成一张方形产品图,帮我选合适的图片模型。预期行为:
- 调用
list_models选择兼容的图片模型。 - 带上选定的 service/action/model 调用
get_model_info验证参数和条件输入规则。 - 如果请求昂贵、耗时或批量,先确认。
- 调用
create_task。 - 返回 task ID、status、output URLs 和可用的 cost 字段。
只提交不等待
创建任务,但不要等待完成。预期行为:
- 调用
create_task,传入wait: false。 - 返回 task ID。
- 之后可以用
get_task查询状态。
查询余额
查询我的 RunAPI 余额。预期行为:
- 调用
check_balance。 - 如果没有配置 key,说明如何设置
RUNAPI_API_KEY。
Catalog Coverage
内嵌目录来自 RunAPI 的 contract 快照。 它包含媒体模型、工具类 endpoint 和用于发现的 LLM model slugs。
| Modality | 使用方式 |
|---|---|
| Image | list_models with modality: "image" |
| Video | list_models with modality: "video" |
| Audio and music | list_models with modality: "audio" |
| LLM | list_models with modality: "llm" |
| Utility | list_models with modality: "utility" |
目录内容会随着版本变化。
请用 list_models 获取当前 service/action/model slugs,用 get_model_info 查看当前约束。
LLM 推理请直接通过 RunAPI API 或 SDK 接入。
Pricing
价格通过 check_pricing 工具和公开 pricing 页面查询。
不要依赖 README 示例里的固定数字。
推荐流程:
- 调用
list_models找候选模型。 - 调用
check_pricing,传入service、action和model。 - 展示返回的价格快照,或链接到 runapi.ai/pricing。
免费目录工具不会创建任务,也不会消耗余额。
平台配置
Claude Code、Cursor、Windsurf 和 VS Code
运行:
claude mcp add runapi -s user -- npx -y @runapi.ai/mcp-s user 表示全局安装,对所有项目可用。
-s project 表示让 Claude Code 在仓库里写入 .mcp.json,用于团队共享配置。
修改 MCP 配置后,重启或重新加载你的 MCP Host。
兼容 Fallback:生成配置文件
只有当 Host 需要平台专用 JSON 文件,或无法使用 Claude Code MCP 命令时,才使用 init。
Claude Code fallback:
npx @runapi.ai/mcp init claude会在当前目录写入 .mcp.json。
Cursor fallback:
npx @runapi.ai/mcp init cursor会写入 .cursor/mcp.json。
VS Code fallback:
npx @runapi.ai/mcp init vscode会写入 .vscode/mcp.json。
VS Code 生成配置使用顶层 servers 和 type: "stdio"。
Windsurf fallback:
npx @runapi.ai/mcp init windsurfRoo Code
npx @runapi.ai/mcp init roo会写入 .roo/mcp.json。
配置
Server 按以下顺序读取配置:
RUNAPI_API_KEY环境变量~/.config/runapi/config.json- 无 key,仅允许免费目录工具
示例配置:
{
"apiKey": "your_runapi_key"
}不要提交真实 API Key。
Data Sync
包内包含构建时数据:
data/contract.json:目录、action、model slug 和输入约束data/pricing.json:check_pricing使用的价格快照
发布前刷新数据:
npm run sync:data开发
npm install
npm run typecheck
npm test
npm pack --dry-run本地启动:
npm run devPackage Contents
npm 包包含:
- 编译后的
dist/ - 内嵌
data/ - 平台示例
- eval scenarios
- README、CHANGELOG、LICENSE、package metadata
不包含 node_modules、.env、本地配置文件或 API Key。
License
Licensed under the Apache License, Version 2.0.
