@runapi.ai/grok-imagine-mcp 0.1.1 → 0.1.2

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 +50 -33
  2. package/package.json +10 -9
  3. package/server.json +4 -4
package/README.md CHANGED
@@ -1,7 +1,7 @@
1
- <h1 align="center">Grok Imagine MCP Server</h1>
1
+ <h1 align="center">RunAPI Grok Imagine MCP Server</h1>
2
2
 
3
3
  <p align="center">
4
- <strong>Create Grok Imagine AI tasks through RunAPI — 6 endpoints, 4 models — then poll status and check pricing. One MCP server, one API key.</strong>
4
+ <strong>Grok Imagine API access for AI agents: create image and video 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/grok-imagine-mcp"><img src="https://img.shields.io/npm/v/%40runapi.ai/grok-imagine-mcp?style=flat-square&color=blue" alt="npm version"></a>
13
+ <a href="https://github.com/runapi-ai/grok-imagine-mcp"><img src="https://img.shields.io/badge/GitHub-runapi--ai%2Fgrok-imagine-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-4-green?style=flat-square" alt="4 models">
16
+ <img src="https://img.shields.io/badge/Models-4-16a34a?style=flat-square" alt="4 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/grok-imagine-mcp` is a focused MCP server for the **Grok Imagine** model line on RunAPI.
31
- It lets an MCP-compatible assistant create Grok Imagine tasks, poll their status, and check current pricing — all through a single RunAPI API key.
32
+ `@runapi.ai/grok-imagine-mcp` is a focused Model Context Protocol server for the **Grok Imagine** model line on RunAPI.
33
+ It gives MCP-compatible assistants direct access to 6 endpoints and 4 model variants 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 Grok Imagine. 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 grok-imagine -s user -- npx -y @runapi.ai/grok-imagine-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 grok-imagine -s project -- npx -y @runapi.ai/grok-imagine-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,20 +74,20 @@ 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 Grok Imagine task (edit image) and optionally poll until it reaches a terminal status. Returns the task id, status, output URLs, and a price snapshot. |
73
- | `extend_video` | Yes | Create a Grok Imagine task (extend video) and optionally poll until it reaches a terminal status. Returns the task id, status, output URLs, and a price snapshot. |
74
- | `image_to_video` | Yes | Create a Grok Imagine task (image to video) and optionally poll until it reaches a terminal status. Returns the task id, status, output URLs, and a price snapshot. |
75
- | `text_to_image` | Yes | Create a Grok Imagine task (text to image) and optionally poll until it reaches a terminal status. Returns the task id, status, output URLs, and a price snapshot. |
76
- | `text_to_video` | Yes | Create a Grok Imagine task (text to video) and optionally poll until it reaches a terminal status. Returns the task id, status, output URLs, and a price snapshot. |
77
- | `upscale_image` | Yes | Create a Grok Imagine task (upscale 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 Grok Imagine edit image task and optionally wait for a terminal status. Returns the task id, status, output URLs, and pricing snapshot. |
78
+ | `extend_video` | Yes | Create a Grok Imagine extend video task and optionally wait for a terminal status. Returns the task id, status, output URLs, and pricing snapshot. |
79
+ | `image_to_video` | Yes | Create a Grok Imagine image to video task and optionally wait for a terminal status. Returns the task id, status, output URLs, and pricing snapshot. |
80
+ | `text_to_image` | Yes | Create a Grok Imagine text to image task and optionally wait for a terminal status. Returns the task id, status, output URLs, and pricing snapshot. |
81
+ | `text_to_video` | Yes | Create a Grok Imagine text to video task and optionally wait for a terminal status. Returns the task id, status, output URLs, and pricing snapshot. |
82
+ | `upscale_image` | Yes | Create a Grok Imagine upscale image task and optionally wait for a terminal status. Returns the task id, status, output URLs, and pricing snapshot. |
78
83
  | `get_task` | Yes | Fetch the current status and latest payload for an existing task. |
79
- | `check_pricing` | No | Look up the current price for a Grok Imagine model and endpoint. |
84
+ | `check_pricing` | No | Look up the current pricing snapshot for a Grok Imagine model and endpoint. |
80
85
 
81
86
  ---
82
87
 
83
88
  ## Models
84
89
 
85
- Grok Imagine covers 4 models across 6 endpoints. Each tool accepts the models listed for it:
90
+ Grok Imagine covers 4 model variants across 6 endpoints. Each tool accepts the models listed for it:
86
91
 
87
92
  | Tool | Models |
88
93
  |---|---|
@@ -93,13 +98,13 @@ Grok Imagine covers 4 models across 6 endpoints. Each tool accepts the models li
93
98
  | `text_to_video` | `grok-imagine-text-to-video` |
94
99
  | `upscale_image` | _no model parameter_ |
95
100
 
96
- Call `check_pricing` for the current price of any model. Model availability can change between releases.
101
+ Model availability can change between releases. Use `check_pricing` or the [Grok Imagine model page](https://runapi.ai/models/grok-imagine) for the current catalog view.
97
102
 
98
103
  ---
99
104
 
100
- ## Examples
105
+ ## Agent Prompts
101
106
 
102
- Ask your assistant in natural language; it uses the tools to confirm pricing and run the task.
107
+ Ask your assistant in natural language; it can inspect pricing, create the task, and return the task id plus output URLs.
103
108
 
104
109
  ### Create a task
105
110
 
@@ -107,7 +112,7 @@ Ask your assistant in natural language; it uses the tools to confirm pricing and
107
112
  Run a Grok Imagine edit image task with RunAPI.
108
113
  ```
109
114
 
110
- The assistant calls `check_pricing` to confirm the cost, then `edit_image`, and returns the task id, status, and output URLs.
115
+ The assistant can call `check_pricing`, then `edit_image`, and return the task id, status, and output URLs.
111
116
 
112
117
  ### Submit without waiting
113
118
 
@@ -117,13 +122,13 @@ Create the task but don't wait for it to finish.
117
122
 
118
123
  The assistant calls the create tool with `wait: false` and returns the task id. Check on it later with `get_task`.
119
124
 
120
- ### Check pricing
125
+ ### Check pricing before creating
121
126
 
122
127
  ```text
123
- What does Grok Imagine cost?
128
+ Check current Grok Imagine pricing, then create the task if it matches my request.
124
129
  ```
125
130
 
126
- The assistant calls `check_pricing` and shows the current snapshot, or links to [runapi.ai/pricing](https://runapi.ai/pricing).
131
+ The assistant calls `check_pricing` and can link to the [Grok Imagine model page](https://runapi.ai/models/grok-imagine) for the canonical catalog entry.
127
132
 
128
133
  ---
129
134
 
@@ -142,7 +147,19 @@ Example config file:
142
147
  }
143
148
  ```
144
149
 
145
- 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).
150
+ Do not commit real API keys. Get one at [runapi.ai](https://runapi.ai).
151
+
152
+ ---
153
+
154
+ ## Links
155
+
156
+ | Resource | URL |
157
+ |---|---|
158
+ | Grok Imagine model page | [https://runapi.ai/models/grok-imagine](https://runapi.ai/models/grok-imagine) |
159
+ | npm package | [@runapi.ai/grok-imagine-mcp](https://www.npmjs.com/package/@runapi.ai/grok-imagine-mcp) |
160
+ | GitHub repository | [runapi-ai/grok-imagine-mcp](https://github.com/runapi-ai/grok-imagine-mcp) |
161
+ | RunAPI MCP overview | [runapi.ai/mcp](https://runapi.ai/mcp) |
162
+ | RunAPI docs | [runapi.ai/docs](https://runapi.ai/docs) |
146
163
 
147
164
  ---
148
165
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@runapi.ai/grok-imagine-mcp",
3
- "version": "0.1.1",
4
- "description": "Grok Imagine MCP server for RunAPI — create Grok Imagine AI tasks (edit image, extend video, image to video), poll status, and check pricing across 4 models with one API key.",
3
+ "version": "0.1.2",
4
+ "description": "RunAPI Grok Imagine MCP server for image and video generation: create tasks, poll results, and check pricing across 4 model variants 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
  "grok-imagine",
32
37
  "grok-imagine-mcp",
33
- "grok-imagine-ai",
34
38
  "grok-imagine-api",
35
39
  "video-generation",
36
40
  "ai-video",
@@ -39,14 +43,11 @@
39
43
  "ai-upscaling",
40
44
  "edit-image",
41
45
  "extend-video",
42
- "image-to-video",
43
- "text-to-image",
44
- "text-to-video",
45
- "upscale-image"
46
+ "image-to-video"
46
47
  ],
47
48
  "author": "RunAPI",
48
49
  "license": "Apache-2.0",
49
- "homepage": "https://runapi.ai",
50
+ "homepage": "https://runapi.ai/models/grok-imagine",
50
51
  "repository": {
51
52
  "type": "git",
52
53
  "url": "git+https://github.com/runapi-ai/grok-imagine-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/grok-imagine-mcp",
4
- "description": "RunAPI MCP server for Grok Imagine: create tasks, poll status, and check pricing.",
4
+ "description": "RunAPI MCP server for Grok Imagine: create tasks, poll status, check pricing.",
5
5
  "repository": {
6
6
  "url": "https://github.com/runapi-ai/grok-imagine-mcp",
7
7
  "source": "github"
8
8
  },
9
- "version": "0.1.1",
9
+ "version": "0.1.2",
10
10
  "packages": [
11
11
  {
12
12
  "registryType": "npm",
13
13
  "identifier": "@runapi.ai/grok-imagine-mcp",
14
- "version": "0.1.1",
14
+ "version": "0.1.2",
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,