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

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 +123 -26
  2. package/dist/src/meta.d.ts +1 -1
  3. package/dist/src/meta.js +1 -1
  4. package/package.json +18 -3
  5. package/server.json +2 -2
package/README.md CHANGED
@@ -1,41 +1,52 @@
1
- # @runapi.ai/grok-imagine-mcp
1
+ <h1 align="center">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>Create Grok Imagine AI tasks through RunAPI — 6 endpoints, 4 models — then poll status and check pricing. One MCP server, one API key.</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="LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue?style=flat-square" alt="Apache-2.0 license"></a>
14
+ <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
+ </p>
16
17
 
17
- ## Configuration
18
+ <p align="center">
19
+ <a href="#quick-start">Quick Start</a> |
20
+ <a href="#tools">Tools</a> |
21
+ <a href="#models">Models</a> |
22
+ <a href="#examples">Examples</a> |
23
+ <a href="#configuration">Configuration</a>
24
+ </p>
18
25
 
19
- Set a RunAPI API key via the `RUNAPI_API_KEY` environment variable, or write
20
- it to `~/.config/runapi/config.json`:
26
+ ---
21
27
 
22
- ```bash
23
- mkdir -p ~/.config/runapi
24
- echo '{"api_key":"YOUR_KEY"}' > ~/.config/runapi/config.json
25
- ```
28
+ ## What Is This?
29
+
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
+
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.
26
35
 
27
- Get an API key at https://runapi.ai. Pricing is listed at
28
- https://runapi.ai/pricing.
36
+ ---
29
37
 
30
- ## Usage
38
+ ## Quick Start
31
39
 
32
- Run the server over stdio:
40
+ Add it to Claude Code:
33
41
 
34
42
  ```bash
35
- npx -y @runapi.ai/grok-imagine-mcp
43
+ claude mcp add grok-imagine -s user -- npx -y @runapi.ai/grok-imagine-mcp
36
44
  ```
37
45
 
38
- Add it to an MCP client (see `examples/` for per-client configs):
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.
48
+
49
+ For other hosts, or for manual configuration, use this JSON:
39
50
 
40
51
  ```json
41
52
  {
@@ -49,6 +60,92 @@ Add it to an MCP client (see `examples/` for per-client configs):
49
60
  }
50
61
  ```
51
62
 
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.
65
+
66
+ ---
67
+
68
+ ## Tools
69
+
70
+ | Tool | Auth | Purpose |
71
+ |---|---|---|
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. |
78
+ | `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. |
80
+
81
+ ---
82
+
83
+ ## Models
84
+
85
+ Grok Imagine covers 4 models across 6 endpoints. Each tool accepts the models listed for it:
86
+
87
+ | Tool | Models |
88
+ |---|---|
89
+ | `edit_image` | `grok-imagine-edit-image` |
90
+ | `extend_video` | _no model parameter_ |
91
+ | `image_to_video` | `grok-imagine-image-to-video` |
92
+ | `text_to_image` | `grok-imagine-text-to-image` |
93
+ | `text_to_video` | `grok-imagine-text-to-video` |
94
+ | `upscale_image` | _no model parameter_ |
95
+
96
+ Call `check_pricing` for the current price of any model. Model availability can change between releases.
97
+
98
+ ---
99
+
100
+ ## Examples
101
+
102
+ Ask your assistant in natural language; it uses the tools to confirm pricing and run the task.
103
+
104
+ ### Create a task
105
+
106
+ ```text
107
+ Run a Grok Imagine edit image task with RunAPI.
108
+ ```
109
+
110
+ The assistant calls `check_pricing` to confirm the cost, then `edit_image`, and returns the task id, status, and output URLs.
111
+
112
+ ### Submit without waiting
113
+
114
+ ```text
115
+ Create the task but don't wait for it to finish.
116
+ ```
117
+
118
+ The assistant calls the create tool with `wait: false` and returns the task id. Check on it later with `get_task`.
119
+
120
+ ### Check pricing
121
+
122
+ ```text
123
+ What does Grok Imagine cost?
124
+ ```
125
+
126
+ The assistant calls `check_pricing` and shows the current snapshot, or links to [runapi.ai/pricing](https://runapi.ai/pricing).
127
+
128
+ ---
129
+
130
+ ## Configuration
131
+
132
+ The server reads the API key in this order:
133
+
134
+ 1. `RUNAPI_API_KEY` environment variable
135
+ 2. `~/.config/runapi/config.json`
136
+
137
+ Example config file:
138
+
139
+ ```json
140
+ {
141
+ "apiKey": "your_runapi_key"
142
+ }
143
+ ```
144
+
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).
146
+
147
+ ---
148
+
52
149
  ## License
53
150
 
54
- Apache-2.0
151
+ 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.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.",
5
5
  "type": "module",
6
6
  "main": "dist/src/index.js",
7
7
  "bin": {
@@ -27,7 +27,22 @@
27
27
  "runapi",
28
28
  "mcp",
29
29
  "model-context-protocol",
30
- "ai"
30
+ "ai",
31
+ "grok-imagine",
32
+ "grok-imagine-mcp",
33
+ "grok-imagine-ai",
34
+ "grok-imagine-api",
35
+ "video-generation",
36
+ "ai-video",
37
+ "image-generation",
38
+ "ai-image",
39
+ "ai-upscaling",
40
+ "edit-image",
41
+ "extend-video",
42
+ "image-to-video",
43
+ "text-to-image",
44
+ "text-to-video",
45
+ "upscale-image"
31
46
  ],
32
47
  "author": "RunAPI",
33
48
  "license": "Apache-2.0",
package/server.json CHANGED
@@ -6,12 +6,12 @@
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.1",
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.1",
15
15
  "transport": {
16
16
  "type": "stdio"
17
17
  },