@runapi.ai/gpt-image-2-mcp 0.1.0 → 0.1.1

package/README.md

@@ -1,37 +1,52 @@
-# @runapi.ai/gpt-image-2-mcp
+<h1 align="center">GPT Image 2 MCP Server</h1>
 
-RunAPI MCP server for the **GPT Image 2** model line. Create tasks,
-poll their status, and check pricing through a single RunAPI API key.
+<p align="center">
+  <strong>Create GPT Image 2 AI tasks through RunAPI — 2 endpoints, 1 model — then poll status and check pricing. One MCP server, one API key.</strong>
+</p>
 
-## Tools
+<p align="center">
+  <sub>Works with Claude Code, Codex, Cursor, Windsurf, VS Code, Roo Code, and any MCP-compatible host.</sub>
+</p>
 
-- `edit_image` — create a GPT Image 2 task (edit image) and (optionally) poll until it reaches a terminal status. Returns the task id, status, output URLs, and a price snapshot. Models: `gpt-image-2`.
-- `text_to_image` — create a GPT Image 2 task (text to image) and (optionally) poll until it reaches a terminal status. Returns the task id, status, output URLs, and a price snapshot. Models: `gpt-image-2`.
-- `get_task` — fetch the current status and latest payload for a task.
-- `check_pricing` — look up pricing for a model in this line.
+<p align="center">
+  <a href="https://www.npmjs.com/package/@runapi.ai/gpt-image-2-mcp"><img src="https://img.shields.io/npm/v/%40runapi.ai/gpt-image-2-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">
+  <img src="https://img.shields.io/badge/Models-1-green?style=flat-square" alt="1 models">
+</p>
 
-## Configuration
+<p align="center">
+  <a href="#quick-start">Quick Start</a> |
+  <a href="#tools">Tools</a> |
+  <a href="#models">Models</a> |
+  <a href="#examples">Examples</a> |
+  <a href="#configuration">Configuration</a>
+</p>
 
-Set a RunAPI API key via the `RUNAPI_API_KEY` environment variable, or write
-it to `~/.config/runapi/config.json`:
+---
 
-```bash
-mkdir -p ~/.config/runapi
-echo '{"api_key":"YOUR_KEY"}' > ~/.config/runapi/config.json
-```
+## What Is This?
+
+`@runapi.ai/gpt-image-2-mcp` is a focused MCP server for the **GPT Image 2** model line on RunAPI.
+It lets an MCP-compatible assistant create GPT Image 2 tasks, poll their status, and check current pricing — all through a single RunAPI API key.
+
+`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.
 
-Get an API key at https://runapi.ai. Pricing is listed at
-https://runapi.ai/pricing.
+---
 
-## Usage
+## Quick Start
 
-Run the server over stdio:
+Add it to Claude Code:
 
 ```bash
-npx -y @runapi.ai/gpt-image-2-mcp
+claude mcp add gpt-image-2 -s user -- npx -y @runapi.ai/gpt-image-2-mcp
 ```
 
-Add it to an MCP client (see `examples/` for per-client configs):
+- `-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.
+
+For other hosts, or for manual configuration, use this JSON:
 
 ```json
 {
@@ -45,6 +60,84 @@ Add it to an MCP client (see `examples/` for per-client configs):
 }
 ```
 
+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.
+
+---
+
+## Tools
+
+| Tool | Auth | Purpose |
+|---|---|---|
+| `edit_image` | Yes | Create a GPT Image 2 task (edit image) and optionally poll until it reaches a terminal status. Returns the task id, status, output URLs, and a price snapshot. |
+| `text_to_image` | Yes | Create a GPT Image 2 task (text to image) and optionally poll until it reaches a terminal status. Returns the task id, status, output URLs, and a price 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 GPT Image 2 model and endpoint. |
+
+---
+
+## Models
+
+GPT Image 2 covers 1 model across 2 endpoints. Each tool accepts the models listed for it:
+
+| Tool | Models |
+|---|---|
+| `edit_image` | `gpt-image-2` |
+| `text_to_image` | `gpt-image-2` |
+
+Call `check_pricing` for the current price of any model. Model availability can change between releases.
+
+---
+
+## Examples
+
+Ask your assistant in natural language; it uses the tools to confirm pricing and run the task.
+
+### Create a task
+
+```text
+Run a GPT Image 2 edit image task with RunAPI.
+```
+
+The assistant calls `check_pricing` to confirm the cost, then `edit_image`, and returns the task id, status, and output URLs.
+
+### Submit without waiting
+
+```text
+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
+
+```text
+What does GPT Image 2 cost?
+```
+
+The assistant calls `check_pricing` and shows the current snapshot, or links to [runapi.ai/pricing](https://runapi.ai/pricing).
+
+---
+
+## Configuration
+
+The server reads the API key in this order:
+
+1. `RUNAPI_API_KEY` environment variable
+2. `~/.config/runapi/config.json`
+
+Example config file:
+
+```json
+{
+  "apiKey": "your_runapi_key"
+}
+```
+
+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).
+
+---
+
 ## License
 
-Apache-2.0
+Licensed under the [Apache License, Version 2.0](LICENSE).

package/dist/src/meta.d.ts

@@ -1,5 +1,5 @@
 export declare const META: {
     readonly name: "@runapi.ai/gpt-image-2-mcp";
-    readonly version: "0.1.0";
+    readonly version: "0.1.1";
     readonly lineSlug: "gpt-image-2";
 };

package/dist/src/meta.js

@@ -1,6 +1,6 @@
 export const META = {
     name: "@runapi.ai/gpt-image-2-mcp",
-    version: "0.1.0",
+    version: "0.1.1",
     lineSlug: "gpt-image-2"
 };
 //# sourceMappingURL=meta.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@runapi.ai/gpt-image-2-mcp",
-  "version": "0.1.0",
-  "description": "RunAPI MCP server for one model line: create tasks, poll status, and check pricing with one API key.",
+  "version": "0.1.1",
+  "description": "GPT Image 2 MCP server for RunAPI — create GPT Image 2 AI tasks (edit image, text to image), poll status, and check pricing across 1 model with one API key.",
   "type": "module",
   "main": "dist/src/index.js",
   "bin": {
@@ -27,7 +27,15 @@
     "runapi",
     "mcp",
     "model-context-protocol",
-    "ai"
+    "ai",
+    "gpt-image-2",
+    "gpt-image-2-mcp",
+    "gpt-image-2-ai",
+    "gpt-image-2-api",
+    "image-generation",
+    "ai-image",
+    "edit-image",
+    "text-to-image"
   ],
   "author": "RunAPI",
   "license": "Apache-2.0",

package/server.json

@@ -6,12 +6,12 @@
     "url": "https://github.com/runapi-ai/gpt-image-2-mcp",
     "source": "github"
   },
-  "version": "0.1.0",
+  "version": "0.1.1",
   "packages": [
     {
       "registryType": "npm",
       "identifier": "@runapi.ai/gpt-image-2-mcp",
-      "version": "0.1.0",
+      "version": "0.1.1",
       "transport": {
         "type": "stdio"
       },