@runapi.ai/topaz-mcp - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

package.json

 {
   "name": "@runapi.ai/topaz-mcp",
-  "version": "0.1.1",
-  "description": "Topaz MCP server for RunAPI — create Topaz AI tasks (upscale image, upscale video), poll status, and check pricing across 2 models with one API key.",
+  "version": "0.1.2",
+  "description": "RunAPI Topaz MCP server for image and video generation: create tasks, poll results, and check pricing across 2 model variants from Claude Code, Codex, Cursor, and VS Code.",
   "type": "module",
@@ -28,8 +28,12 @@ "main": "dist/src/index.js",
     "runapi",
+    "runapi-ai",
     "mcp",
+    "mcp-server",
     "model-context-protocol",
-    "ai",
+    "ai-agents",
+    "claude-code",
+    "cursor",
+    "vscode",
     "topaz",
     "topaz-mcp",
-    "topaz-ai",
     "topaz-api",
@@ -46,3 +50,3 @@ "video-generation",
   "license": "Apache-2.0",
-  "homepage": "https://runapi.ai",
+  "homepage": "https://runapi.ai/models/topaz",
   "repository": {
@@ -49,0 +53,0 @@ "type": "git",

README.md

@@ -1,5 +0,5 @@
-<h1 align="center">Topaz MCP Server</h1>
+<h1 align="center">RunAPI Topaz MCP Server</h1>
 
 <p align="center">
-  <strong>Create Topaz AI tasks through RunAPI — 2 endpoints, 2 models — then poll status and check pricing. One MCP server, one API key.</strong>
+  <strong>Topaz API access for AI agents: create image and video generation tasks, poll results, and check pricing through one focused MCP server.</strong>
 </p>
@@ -13,13 +13,15 @@
   <a href="https://www.npmjs.com/package/@runapi.ai/topaz-mcp"><img src="https://img.shields.io/npm/v/%40runapi.ai/topaz-mcp?style=flat-square&color=blue" alt="npm version"></a>
+  <a href="https://github.com/runapi-ai/topaz-mcp"><img src="https://img.shields.io/badge/GitHub-runapi--ai%2Ftopaz-mcp-24292f?style=flat-square" alt="GitHub repository"></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">
-  <img src="https://img.shields.io/badge/Models-2-green?style=flat-square" alt="2 models">
+  <img src="https://img.shields.io/badge/Models-2-16a34a?style=flat-square" alt="2 models">
 </p>
 
 <p align="center">
-  <a href="#quick-start">Quick Start</a> |
+  <a href="#install">Install</a> |
   <a href="#tools">Tools</a> |
   <a href="#models">Models</a> |
-  <a href="#examples">Examples</a> |
-  <a href="#configuration">Configuration</a>
+  <a href="#agent-prompts">Agent Prompts</a> |
+  <a href="#configuration">Configuration</a> |
+  <a href="#links">Links</a>
 </p>
@@ -29,13 +31,12 @@
 
-## What Is This?
+## Why This Package?
 
-`@runapi.ai/topaz-mcp` is a focused MCP server for the **Topaz** model line on RunAPI.
-It lets an MCP-compatible assistant create Topaz tasks, poll their status, and check current pricing — all through a single RunAPI API key.
+`@runapi.ai/topaz-mcp` is a focused Model Context Protocol server for the **Topaz** model line on RunAPI.
+It gives MCP-compatible assistants direct access to 2 endpoints and 2 model variants without loading the full RunAPI catalog.
 
-`check_pricing` works without a key. Task creation and status polling require `RUNAPI_API_KEY`.
-This package is a pure client; it does not run a local generation backend.
+Use this per-model server when an agent should stay scoped to Topaz. Use [`@runapi.ai/mcp`](https://github.com/runapi-ai/mcp) when one assistant should discover every RunAPI model line.
 
 ---
 
-## Quick Start
+## Install
 
@@ -48,7 +49,10 @@ Add it to Claude Code:
 
-- `-s user`: global, available in all of your projects.
-- `-s project`: team-shared, written to `.mcp.json` in the current repo so it can be committed.
+Use project scope when the server should be shared with a repository:
 
-For other hosts, or for manual configuration, use this JSON:
+```bash
+claude mcp add topaz -s project -- npx -y @runapi.ai/topaz-mcp
+```
 
+Codex, Cursor, Windsurf, VS Code, Roo Code, and other MCP hosts can use the same stdio command:
+
 ```json
@@ -66,5 +70,6 @@ {
 
-Create an API key at [runapi.ai](https://runapi.ai) and expose it as `RUNAPI_API_KEY`.
-See `examples/` for ready-made config files for Claude, Cursor, Windsurf, VS Code, and Roo.
+Create an API key at [runapi.ai](https://runapi.ai) and expose it as `RUNAPI_API_KEY`. `check_pricing` can run without a key; task creation and status polling require one.
 
+Ready-made examples are in [`examples/`](examples/) for Claude, Cursor, Windsurf, VS Code, and Roo Code.
+
 ---
@@ -76,6 +81,6 @@
 |---|---|---|
-| `upscale_image` | Yes | Create a Topaz task (upscale image) and optionally poll until it reaches a terminal status. Returns the task id, status, output URLs, and a price snapshot. |
-| `upscale_video` | Yes | Create a Topaz task (upscale video) and optionally poll until it reaches a terminal status. Returns the task id, status, output URLs, and a price snapshot. |
+| `upscale_image` | Yes | Create a Topaz upscale image task and optionally wait for a terminal status. Returns the task id, status, output URLs, and pricing snapshot. |
+| `upscale_video` | Yes | Create a Topaz upscale video task and optionally wait for a terminal status. Returns the task id, status, output URLs, and pricing snapshot. |
 | `get_task` | Yes | Fetch the current status and latest payload for an existing task. |
-| `check_pricing` | No | Look up the current price for a Topaz model and endpoint. |
+| `check_pricing` | No | Look up the current pricing snapshot for a Topaz model and endpoint. |
 
@@ -86,3 +91,3 @@ ---
 
-Topaz covers 2 models across 2 endpoints. Each tool accepts the models listed for it:
+Topaz covers 2 model variants across 2 endpoints. Each tool accepts the models listed for it:
 
@@ -94,9 +99,9 @@ | Tool | Models |
 
-Call `check_pricing` for the current price of any model. Model availability can change between releases.
+Model availability can change between releases. Use `check_pricing` or the [Topaz model page](https://runapi.ai/models/topaz) for the current catalog view.
 
 ---
 
-## Examples
+## Agent Prompts
 
-Ask your assistant in natural language; it uses the tools to confirm pricing and run the task.
+Ask your assistant in natural language; it can inspect pricing, create the task, and return the task id plus output URLs.
 
@@ -109,3 +114,3 @@ ### Create a task
 
-The assistant calls `check_pricing` to confirm the cost, then `upscale_image`, and returns the task id, status, and output URLs.
+The assistant can call `check_pricing`, then `upscale_image`, and return the task id, status, and output URLs.
 
@@ -120,9 +125,9 @@ ### Submit without waiting
 
-### Check pricing
+### Check pricing before creating
 
 ```text
-What does Topaz cost?
+Check current Topaz pricing, then create the task if it matches my request.
 ```
 
-The assistant calls `check_pricing` and shows the current snapshot, or links to [runapi.ai/pricing](https://runapi.ai/pricing).
+The assistant calls `check_pricing` and can link to the [Topaz model page](https://runapi.ai/models/topaz) for the canonical catalog entry.
 
@@ -146,8 +151,20 @@ ---
 
-Do not commit real API keys. Get one at [runapi.ai](https://runapi.ai); pricing is listed at [runapi.ai/pricing](https://runapi.ai/pricing).
+Do not commit real API keys. Get one at [runapi.ai](https://runapi.ai).
 
 ---
 
+## Links
+
+| Resource | URL |
+|---|---|
+| Topaz model page | [https://runapi.ai/models/topaz](https://runapi.ai/models/topaz) |
+| npm package | [@runapi.ai/topaz-mcp](https://www.npmjs.com/package/@runapi.ai/topaz-mcp) |
+| GitHub repository | [runapi-ai/topaz-mcp](https://github.com/runapi-ai/topaz-mcp) |
+| RunAPI MCP overview | [runapi.ai/mcp](https://runapi.ai/mcp) |
+| RunAPI docs | [runapi.ai/docs](https://runapi.ai/docs) |
+
+---
+
 ## License
 
 Licensed under the [Apache License, Version 2.0](LICENSE).

server.json

 {
   "$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
   "name": "io.github.runapi-builder/topaz-mcp",
-  "description": "RunAPI MCP server for Topaz: create tasks, poll status, and check pricing.",
+  "description": "RunAPI MCP server for Topaz: create tasks, poll status, check pricing.",
   "repository": {
@@ -9,3 +9,3 @@ "url": "https://github.com/runapi-ai/topaz-mcp",
   },
-  "version": "0.1.1",
+  "version": "0.1.2",
   "packages": [
@@ -15,3 +15,3 @@ {
       "identifier": "@runapi.ai/topaz-mcp",
-      "version": "0.1.1",
+      "version": "0.1.2",
       "transport": {
@@ -22,3 +22,3 @@ "type": "stdio"
         {
-          "description": "RunAPI API key. Get one at https://runapi.ai",
+          "description": "RunAPI API key. Create one at https://runapi.ai",
           "isRequired": true,
@@ -25,0 +25,0 @@ "format": "string",

No alert changes

Improved metrics

Total package byte prevSize

35900

2.79%

Number of lines in readme file

161

11.81%

No dependency changes