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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +46 -29
  2. package/package.json +9 -5
  3. package/server.json +4 -4
package/README.md CHANGED
@@ -1,7 +1,7 @@
1
- <h1 align="center">GPT Image 2 MCP Server</h1>
1
+ <h1 align="center">RunAPI GPT Image 2 MCP Server</h1>
2
2
 
3
3
  <p align="center">
4
- <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>
4
+ <strong>GPT Image 2 API access for AI agents: create image generation tasks, poll results, and check pricing through one focused MCP server.</strong>
5
5
  </p>
6
6
 
7
7
  <p align="center">
@@ -10,32 +10,33 @@
10
10
 
11
11
  <p align="center">
12
12
  <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>
13
+ <a href="https://github.com/runapi-ai/gpt-image-2-mcp"><img src="https://img.shields.io/badge/GitHub-runapi--ai%2Fgpt--image--2--mcp-24292f?style=flat-square" alt="GitHub repository"></a>
13
14
  <a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue?style=flat-square" alt="Apache-2.0 license"></a>
14
15
  <img src="https://img.shields.io/badge/Type-MCP_Server-blue?style=flat-square" alt="MCP Server">
15
- <img src="https://img.shields.io/badge/Models-1-green?style=flat-square" alt="1 models">
16
+ <img src="https://img.shields.io/badge/Models-1-16a34a?style=flat-square" alt="1 models">
16
17
  </p>
17
18
 
18
19
  <p align="center">
19
- <a href="#quick-start">Quick Start</a> |
20
+ <a href="#install">Install</a> |
20
21
  <a href="#tools">Tools</a> |
21
22
  <a href="#models">Models</a> |
22
- <a href="#examples">Examples</a> |
23
- <a href="#configuration">Configuration</a>
23
+ <a href="#agent-prompts">Agent Prompts</a> |
24
+ <a href="#configuration">Configuration</a> |
25
+ <a href="#links">Links</a>
24
26
  </p>
25
27
 
26
28
  ---
27
29
 
28
- ## What Is This?
30
+ ## Why This Package?
29
31
 
30
- `@runapi.ai/gpt-image-2-mcp` is a focused MCP server for the **GPT Image 2** model line on RunAPI.
31
- 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.
32
+ `@runapi.ai/gpt-image-2-mcp` is a focused Model Context Protocol server for the **GPT Image 2** model line on RunAPI.
33
+ It gives MCP-compatible assistants direct access to 2 endpoints and 1 model variant without loading the full RunAPI catalog.
32
34
 
33
- `check_pricing` works without a key. Task creation and status polling require `RUNAPI_API_KEY`.
34
- This package is a pure client; it does not run a local generation backend.
35
+ Use this per-model server when an agent should stay scoped to GPT Image 2. Use [`@runapi.ai/mcp`](https://github.com/runapi-ai/mcp) when one assistant should discover every RunAPI model line.
35
36
 
36
37
  ---
37
38
 
38
- ## Quick Start
39
+ ## Install
39
40
 
40
41
  Add it to Claude Code:
41
42
 
@@ -43,10 +44,13 @@ Add it to Claude Code:
43
44
  claude mcp add gpt-image-2 -s user -- npx -y @runapi.ai/gpt-image-2-mcp
44
45
  ```
45
46
 
46
- - `-s user`: global, available in all of your projects.
47
- - `-s project`: team-shared, written to `.mcp.json` in the current repo so it can be committed.
47
+ Use project scope when the server should be shared with a repository:
48
48
 
49
- For other hosts, or for manual configuration, use this JSON:
49
+ ```bash
50
+ claude mcp add gpt-image-2 -s project -- npx -y @runapi.ai/gpt-image-2-mcp
51
+ ```
52
+
53
+ Codex, Cursor, Windsurf, VS Code, Roo Code, and other MCP hosts can use the same stdio command:
50
54
 
51
55
  ```json
52
56
  {
@@ -60,8 +64,9 @@ For other hosts, or for manual configuration, use this JSON:
60
64
  }
61
65
  ```
62
66
 
63
- Create an API key at [runapi.ai](https://runapi.ai) and expose it as `RUNAPI_API_KEY`.
64
- See `examples/` for ready-made config files for Claude, Cursor, Windsurf, VS Code, and Roo.
67
+ 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.
68
+
69
+ Ready-made examples are in [`examples/`](examples/) for Claude, Cursor, Windsurf, VS Code, and Roo Code.
65
70
 
66
71
  ---
67
72
 
@@ -69,29 +74,29 @@ See `examples/` for ready-made config files for Claude, Cursor, Windsurf, VS Cod
69
74
 
70
75
  | Tool | Auth | Purpose |
71
76
  |---|---|---|
72
- | `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. |
73
- | `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. |
77
+ | `edit_image` | Yes | Create a GPT Image 2 edit image task and optionally wait for a terminal status. Returns the task id, status, output URLs, and pricing snapshot. |
78
+ | `text_to_image` | Yes | Create a GPT Image 2 text to image task and optionally wait for a terminal status. Returns the task id, status, output URLs, and pricing snapshot. |
74
79
  | `get_task` | Yes | Fetch the current status and latest payload for an existing task. |
75
- | `check_pricing` | No | Look up the current price for a GPT Image 2 model and endpoint. |
80
+ | `check_pricing` | No | Look up the current pricing snapshot for a GPT Image 2 model and endpoint. |
76
81
 
77
82
  ---
78
83
 
79
84
  ## Models
80
85
 
81
- GPT Image 2 covers 1 model across 2 endpoints. Each tool accepts the models listed for it:
86
+ GPT Image 2 covers 1 model variant across 2 endpoints. Each tool accepts the models listed for it:
82
87
 
83
88
  | Tool | Models |
84
89
  |---|---|
85
90
  | `edit_image` | `gpt-image-2` |
86
91
  | `text_to_image` | `gpt-image-2` |
87
92
 
88
- Call `check_pricing` for the current price of any model. Model availability can change between releases.
93
+ Model availability can change between releases. Use `check_pricing` or the [GPT Image 2 model page](https://runapi.ai/models/gpt-image-2) for the current catalog view.
89
94
 
90
95
  ---
91
96
 
92
- ## Examples
97
+ ## Agent Prompts
93
98
 
94
- Ask your assistant in natural language; it uses the tools to confirm pricing and run the task.
99
+ Ask your assistant in natural language; it can inspect pricing, create the task, and return the task id plus output URLs.
95
100
 
96
101
  ### Create a task
97
102
 
@@ -99,7 +104,7 @@ Ask your assistant in natural language; it uses the tools to confirm pricing and
99
104
  Run a GPT Image 2 edit image task with RunAPI.
100
105
  ```
101
106
 
102
- The assistant calls `check_pricing` to confirm the cost, then `edit_image`, and returns the task id, status, and output URLs.
107
+ The assistant can call `check_pricing`, then `edit_image`, and return the task id, status, and output URLs.
103
108
 
104
109
  ### Submit without waiting
105
110
 
@@ -109,13 +114,13 @@ Create the task but don't wait for it to finish.
109
114
 
110
115
  The assistant calls the create tool with `wait: false` and returns the task id. Check on it later with `get_task`.
111
116
 
112
- ### Check pricing
117
+ ### Check pricing before creating
113
118
 
114
119
  ```text
115
- What does GPT Image 2 cost?
120
+ Check current GPT Image 2 pricing, then create the task if it matches my request.
116
121
  ```
117
122
 
118
- The assistant calls `check_pricing` and shows the current snapshot, or links to [runapi.ai/pricing](https://runapi.ai/pricing).
123
+ The assistant calls `check_pricing` and can link to the [GPT Image 2 model page](https://runapi.ai/models/gpt-image-2) for the canonical catalog entry.
119
124
 
120
125
  ---
121
126
 
@@ -134,7 +139,19 @@ Example config file:
134
139
  }
135
140
  ```
136
141
 
137
- 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).
142
+ Do not commit real API keys. Get one at [runapi.ai](https://runapi.ai).
143
+
144
+ ---
145
+
146
+ ## Links
147
+
148
+ | Resource | URL |
149
+ |---|---|
150
+ | GPT Image 2 model page | [https://runapi.ai/models/gpt-image-2](https://runapi.ai/models/gpt-image-2) |
151
+ | npm package | [@runapi.ai/gpt-image-2-mcp](https://www.npmjs.com/package/@runapi.ai/gpt-image-2-mcp) |
152
+ | GitHub repository | [runapi-ai/gpt-image-2-mcp](https://github.com/runapi-ai/gpt-image-2-mcp) |
153
+ | RunAPI MCP overview | [runapi.ai/mcp](https://runapi.ai/mcp) |
154
+ | RunAPI docs | [runapi.ai/docs](https://runapi.ai/docs) |
138
155
 
139
156
  ---
140
157
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@runapi.ai/gpt-image-2-mcp",
3
- "version": "0.1.1",
4
- "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.",
3
+ "version": "0.1.3",
4
+ "description": "RunAPI GPT Image 2 MCP server for image generation: create tasks, poll results, and check pricing across 1 model from Claude Code, Codex, Cursor, and VS Code.",
5
5
  "type": "module",
6
6
  "main": "dist/src/index.js",
7
7
  "bin": {
@@ -25,12 +25,16 @@
25
25
  },
26
26
  "keywords": [
27
27
  "runapi",
28
+ "runapi-ai",
28
29
  "mcp",
30
+ "mcp-server",
29
31
  "model-context-protocol",
30
- "ai",
32
+ "ai-agents",
33
+ "claude-code",
34
+ "cursor",
35
+ "vscode",
31
36
  "gpt-image-2",
32
37
  "gpt-image-2-mcp",
33
- "gpt-image-2-ai",
34
38
  "gpt-image-2-api",
35
39
  "image-generation",
36
40
  "ai-image",
@@ -39,7 +43,7 @@
39
43
  ],
40
44
  "author": "RunAPI",
41
45
  "license": "Apache-2.0",
42
- "homepage": "https://runapi.ai",
46
+ "homepage": "https://runapi.ai/models/gpt-image-2",
43
47
  "repository": {
44
48
  "type": "git",
45
49
  "url": "git+https://github.com/runapi-ai/gpt-image-2-mcp.git"
package/server.json CHANGED
@@ -1,23 +1,23 @@
1
1
  {
2
2
  "$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
3
3
  "name": "io.github.runapi-builder/gpt-image-2-mcp",
4
- "description": "RunAPI MCP server for GPT Image 2: create tasks, poll status, and check pricing.",
4
+ "description": "RunAPI MCP server for GPT Image 2: create tasks, poll status, check pricing.",
5
5
  "repository": {
6
6
  "url": "https://github.com/runapi-ai/gpt-image-2-mcp",
7
7
  "source": "github"
8
8
  },
9
- "version": "0.1.1",
9
+ "version": "0.1.3",
10
10
  "packages": [
11
11
  {
12
12
  "registryType": "npm",
13
13
  "identifier": "@runapi.ai/gpt-image-2-mcp",
14
- "version": "0.1.1",
14
+ "version": "0.1.3",
15
15
  "transport": {
16
16
  "type": "stdio"
17
17
  },
18
18
  "environmentVariables": [
19
19
  {
20
- "description": "RunAPI API key. Get one at https://runapi.ai",
20
+ "description": "RunAPI API key. Create one at https://runapi.ai",
21
21
  "isRequired": true,
22
22
  "format": "string",
23
23
  "isSecret": true,