@runapi.ai/grok-imagine-mcp 0.1.0 → 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 (5) hide show
  1. package/README.md +140 -26
  2. package/dist/src/meta.d.ts +1 -1
  3. package/dist/src/meta.js +1 -1
  4. package/package.json +20 -4
  5. package/server.json +4 -4
package/README.md CHANGED
@@ -1,41 +1,56 @@
1
- # @runapi.ai/grok-imagine-mcp
1
+ <h1 align="center">RunAPI Grok Imagine MCP Server</h1>
2
2
 
3
- RunAPI MCP server for the **Grok Imagine** model line. Create tasks,
4
- poll their status, and check pricing through a single RunAPI API key.
3
+ <p align="center">
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
+ </p>
5
6
 
6
- ## Tools
7
+ <p align="center">
8
+ <sub>Works with Claude Code, Codex, Cursor, Windsurf, VS Code, Roo Code, and any MCP-compatible host.</sub>
9
+ </p>
7
10
 
8
- - `edit_image` — 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. Models: `grok-imagine-edit-image`, `grok-imagine-image-to-video`, `grok-imagine-text-to-image`, `grok-imagine-text-to-video`.
9
- - `extend_video` — 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. Models: `grok-imagine-edit-image`, `grok-imagine-image-to-video`, `grok-imagine-text-to-image`, `grok-imagine-text-to-video`.
10
- - `image_to_video` — 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. Models: `grok-imagine-edit-image`, `grok-imagine-image-to-video`, `grok-imagine-text-to-image`, `grok-imagine-text-to-video`.
11
- - `text_to_image` — 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. Models: `grok-imagine-edit-image`, `grok-imagine-image-to-video`, `grok-imagine-text-to-image`, `grok-imagine-text-to-video`.
12
- - `text_to_video` — 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. Models: `grok-imagine-edit-image`, `grok-imagine-image-to-video`, `grok-imagine-text-to-image`, `grok-imagine-text-to-video`.
13
- - `upscale_image` — 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. Models: `grok-imagine-edit-image`, `grok-imagine-image-to-video`, `grok-imagine-text-to-image`, `grok-imagine-text-to-video`.
14
- - `get_task` — fetch the current status and latest payload for a task.
15
- - `check_pricing` — look up pricing for a model in this line.
11
+ <p align="center">
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>
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>
15
+ <img src="https://img.shields.io/badge/Type-MCP_Server-blue?style=flat-square" alt="MCP Server">
16
+ <img src="https://img.shields.io/badge/Models-4-16a34a?style=flat-square" alt="4 models">
17
+ </p>
16
18
 
17
- ## Configuration
19
+ <p align="center">
20
+ <a href="#install">Install</a> |
21
+ <a href="#tools">Tools</a> |
22
+ <a href="#models">Models</a> |
23
+ <a href="#agent-prompts">Agent Prompts</a> |
24
+ <a href="#configuration">Configuration</a> |
25
+ <a href="#links">Links</a>
26
+ </p>
18
27
 
19
- Set a RunAPI API key via the `RUNAPI_API_KEY` environment variable, or write
20
- it to `~/.config/runapi/config.json`:
28
+ ---
21
29
 
22
- ```bash
23
- mkdir -p ~/.config/runapi
24
- echo '{"api_key":"YOUR_KEY"}' > ~/.config/runapi/config.json
25
- ```
30
+ ## Why This Package?
26
31
 
27
- Get an API key at https://runapi.ai. Pricing is listed at
28
- https://runapi.ai/pricing.
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.
29
34
 
30
- ## Usage
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.
31
36
 
32
- Run the server over stdio:
37
+ ---
38
+
39
+ ## Install
40
+
41
+ Add it to Claude Code:
33
42
 
34
43
  ```bash
35
- npx -y @runapi.ai/grok-imagine-mcp
44
+ claude mcp add grok-imagine -s user -- npx -y @runapi.ai/grok-imagine-mcp
36
45
  ```
37
46
 
38
- Add it to an MCP client (see `examples/` for per-client configs):
47
+ Use project scope when the server should be shared with a repository:
48
+
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:
39
54
 
40
55
  ```json
41
56
  {
@@ -49,6 +64,105 @@ Add it to an MCP client (see `examples/` for per-client configs):
49
64
  }
50
65
  ```
51
66
 
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.
70
+
71
+ ---
72
+
73
+ ## Tools
74
+
75
+ | Tool | Auth | Purpose |
76
+ |---|---|---|
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. |
83
+ | `get_task` | Yes | Fetch the current status and latest payload for an existing task. |
84
+ | `check_pricing` | No | Look up the current pricing snapshot for a Grok Imagine model and endpoint. |
85
+
86
+ ---
87
+
88
+ ## Models
89
+
90
+ Grok Imagine covers 4 model variants across 6 endpoints. Each tool accepts the models listed for it:
91
+
92
+ | Tool | Models |
93
+ |---|---|
94
+ | `edit_image` | `grok-imagine-edit-image` |
95
+ | `extend_video` | _no model parameter_ |
96
+ | `image_to_video` | `grok-imagine-image-to-video` |
97
+ | `text_to_image` | `grok-imagine-text-to-image` |
98
+ | `text_to_video` | `grok-imagine-text-to-video` |
99
+ | `upscale_image` | _no model parameter_ |
100
+
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.
102
+
103
+ ---
104
+
105
+ ## Agent Prompts
106
+
107
+ Ask your assistant in natural language; it can inspect pricing, create the task, and return the task id plus output URLs.
108
+
109
+ ### Create a task
110
+
111
+ ```text
112
+ Run a Grok Imagine edit image task with RunAPI.
113
+ ```
114
+
115
+ The assistant can call `check_pricing`, then `edit_image`, and return the task id, status, and output URLs.
116
+
117
+ ### Submit without waiting
118
+
119
+ ```text
120
+ Create the task but don't wait for it to finish.
121
+ ```
122
+
123
+ The assistant calls the create tool with `wait: false` and returns the task id. Check on it later with `get_task`.
124
+
125
+ ### Check pricing before creating
126
+
127
+ ```text
128
+ Check current Grok Imagine pricing, then create the task if it matches my request.
129
+ ```
130
+
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.
132
+
133
+ ---
134
+
135
+ ## Configuration
136
+
137
+ The server reads the API key in this order:
138
+
139
+ 1. `RUNAPI_API_KEY` environment variable
140
+ 2. `~/.config/runapi/config.json`
141
+
142
+ Example config file:
143
+
144
+ ```json
145
+ {
146
+ "apiKey": "your_runapi_key"
147
+ }
148
+ ```
149
+
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) |
163
+
164
+ ---
165
+
52
166
  ## License
53
167
 
54
- Apache-2.0
168
+ Licensed under the [Apache License, Version 2.0](LICENSE).
package/dist/src/meta.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export declare const META: {
2
2
  readonly name: "@runapi.ai/grok-imagine-mcp";
3
- readonly version: "0.1.0";
3
+ readonly version: "0.1.1";
4
4
  readonly lineSlug: "grok-imagine";
5
5
  };
package/dist/src/meta.js CHANGED
@@ -1,6 +1,6 @@
1
1
  export const META = {
2
2
  name: "@runapi.ai/grok-imagine-mcp",
3
- version: "0.1.0",
3
+ version: "0.1.1",
4
4
  lineSlug: "grok-imagine"
5
5
  };
6
6
  //# sourceMappingURL=meta.js.map
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@runapi.ai/grok-imagine-mcp",
3
- "version": "0.1.0",
4
- "description": "RunAPI MCP server for one model line: create tasks, poll status, and check pricing 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,13 +25,29 @@
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",
36
+ "grok-imagine",
37
+ "grok-imagine-mcp",
38
+ "grok-imagine-api",
39
+ "video-generation",
40
+ "ai-video",
41
+ "image-generation",
42
+ "ai-image",
43
+ "ai-upscaling",
44
+ "edit-image",
45
+ "extend-video",
46
+ "image-to-video"
31
47
  ],
32
48
  "author": "RunAPI",
33
49
  "license": "Apache-2.0",
34
- "homepage": "https://runapi.ai",
50
+ "homepage": "https://runapi.ai/models/grok-imagine",
35
51
  "repository": {
36
52
  "type": "git",
37
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.0",
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.0",
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,