@runapi.ai/mcp 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## 0.1.0
+
+- Initial RunAPI MCP server.
+- Added free catalog tools: `list_models`, `get_model_info`, `list_actions`, `check_pricing`.
+- Added authenticated tools: `create_task`, `get_task`, `check_balance`, `chat`.
+- Added service route normalization for authenticated media task URLs.
+- Added long-running media polling hardening for audio-like tasks.
+- Added init command for Claude Code, Cursor, Windsurf, VS Code, and Roo.
+- Added Claude Code plugin assets, manual eval scenarios, CI validation, Glama metadata, and distribution listing drafts.

package/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,367 @@
+<h1 align="center">RunAPI MCP Server</h1>
+
+<p align="center">
+  <strong>One MCP server for RunAPI model discovery, pricing lookup, media tasks, account status, and LLM chat.</strong>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@runapi.ai/mcp"><img src="https://img.shields.io/npm/v/%40runapi.ai/mcp?style=flat-square&color=blue" alt="npm version"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue?style=flat-square" alt="Apache-2.0 license"></a>
+  <img src="https://img.shields.io/badge/Type-MCP_Server-blue?style=flat-square" alt="MCP Server">
+</p>
+
+<p align="center">
+  <a href="#quick-start">Quick Start</a> |
+  <a href="#tools">Tools</a> |
+  <a href="#examples">Examples</a> |
+  <a href="#catalog-coverage">Catalog</a> |
+  <a href="#platform-setup">Platforms</a>
+</p>
+
+---
+
+## 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, check account balance, and call RunAPI LLM endpoints.
+
+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
+
+Install through your MCP host config:
+
+```json
+{
+  "mcpServers": {
+    "runapi": {
+      "command": "npx",
+      "args": ["-y", "@runapi.ai/mcp"],
+      "env": {
+        "RUNAPI_API_KEY": "${RUNAPI_API_KEY}"
+      }
+    }
+  }
+}
+```
+
+Or generate a config file:
+
+```bash
+npx @runapi.ai/mcp init claude
+```
+
+Supported init targets:
+
+```bash
+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, balance checks, and LLM chat, create an API key in the RunAPI dashboard and expose it as `RUNAPI_API_KEY`.
+
+---
+
+## Tools
+
+| Tool | Auth | Purpose |
+|---|---|---|
+| `list_models` | No | List RunAPI models from the embedded catalog. Supports `modality`, `service`, and `action` filters. |
+| `get_model_info` | No | Return service, action, modality, input constraints, and pricing snapshot for a model slug. Use `service` + `action` when a model appears in multiple endpoints. |
+| `list_actions` | No | Group endpoint action names by modality. |
+| `check_pricing` | No | Return pricing snapshot data for a `service` + `action` + `model` combination. |
+| `create_task` | Yes | Create a media task and optionally poll until completion. |
+| `get_task` | Yes | Fetch status and latest payload for an existing media task. |
+| `check_balance` | Yes | Return account balance and spending metrics. |
+| `chat` | Yes | Send messages to a RunAPI LLM endpoint and return the response with usage metadata when available. |
+
+The catalog and pricing tools are designed for funnel-top discovery inside coding tools.
+The task, balance, and chat 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
+
+```text
+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`.
+
+### Inspect A Model
+
+```text
+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
+
+```text
+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
+
+```text
+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
+
+```text
+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`.
+
+### LLM Chat
+
+```text
+Use a RunAPI LLM model to summarize this file.
+```
+
+Expected behavior:
+
+1. The assistant uses catalog tools to identify a current LLM model slug when needed.
+2. It calls `chat` rather than `create_task`.
+3. It returns the model response and usage metadata when available.
+
+---
+
+## Catalog Coverage
+
+The embedded catalog is generated from RunAPI's contract snapshot.
+It includes media models, utility endpoints, and LLM model slugs.
+
+| Modality | What To Use |
+|---|---|
+| 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"` |
+
+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.
+
+---
+
+## 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](https://runapi.ai/pricing).
+
+Free catalog tools do not create tasks and do not consume account balance.
+
+---
+
+## Platform Setup
+
+### Claude Code
+
+Run:
+
+```bash
+npx @runapi.ai/mcp init claude
+```
+
+This writes `.mcp.json` in the current directory.
+Restart Claude Code after editing MCP configuration.
+
+### Cursor
+
+Run:
+
+```bash
+npx @runapi.ai/mcp init cursor
+```
+
+This writes `.cursor/mcp.json`.
+Open Cursor settings to verify the MCP server is enabled.
+
+### VS Code
+
+Run:
+
+```bash
+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
+
+Run:
+
+```bash
+npx @runapi.ai/mcp init windsurf
+```
+
+This writes the generated config for the Windsurf target used by the init command.
+
+### Roo Code
+
+Run:
+
+```bash
+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:
+
+```bash
+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:
+
+```json
+{
+  "apiKey": "your_runapi_key"
+}
+```
+
+You can also set a custom base URL for local testing:
+
+```json
+{
+  "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:
+
+```bash
+npm run sync:data
+```
+
+Build-time data means a pricing or catalog update requires a new package release.
+
+---
+
+## Development
+
+```bash
+npm install
+npm run typecheck
+npm test
+npm pack --dry-run
+```
+
+Run the server locally:
+
+```bash
+npm run dev
+```
+
+Manual initialize smoke test:
+
+```bash
+printf '%s\n' '{"jsonrpc":"2.0","method":"initialize","params":{"protocolVersion":"2025-03-26","capabilities":{},"clientInfo":{"name":"test","version":"0.1.0"}},"id":1}' | npx tsx src/index.ts
+```
+
+---
+
+## Package Contents
+
+The npm package includes:
+
+- compiled `dist/` files
+- embedded `data/` files
+- platform examples
+- Claude Code plugin files, when generated by this repo
+- eval scenarios, when generated by this repo
+- README, changelog, license, and package metadata
+
+It does not include `node_modules`, `.env`, local config files, or API keys.
+
+---
+
+## Also Available Via CLI
+
+RunAPI also has a separate command-line client for terminal workflows.
+Use this MCP server when you want RunAPI available inside an MCP host.
+Use the CLI when you want direct shell commands, scripts, or CI integration.
+
+---
+
+## License
+
+[Apache-2.0](LICENSE)