Skip to content

Commit fce0aa3

Browse files
committed
Align Codex plugin with hosted WaveSpeed MCP and Claude skill
1 parent 2613cf2 commit fce0aa3

7 files changed

Lines changed: 25 additions & 42 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A [Codex](https://developers.openai.com/codex) plugin that lets the agent genera
44

55
It bundles two things:
66

7-
- **MCP server** — [`@wavespeed/mcp`](https://github.com/WaveSpeedAI/mcp-server), started on demand with `npx`. Tools: `list_models`, `get_model_schema`, `get_price`, `upload_file`, `run_model`, `generate_image`, `edit_image`, `generate_video`, `edit_video`, `extend_video`, `get_prediction`, `get_balance`.
7+
- **Hosted MCP server** — `https://api.wavespeed.ai/mcp`, authorized once in the browser. Generate, edit and extend images and videos, run any model, inspect schemas, and check prices and balance. The hosted server cannot read files on your computer; pass public URLs or use the CLI for local files.
88
- **Skill** — the find → inspect → run workflow on the open-source [`@wavespeed/cli`](https://github.com/WaveSpeedAI/wavespeed-cli): search the live catalog, read any model's input schema, run it, upload local files with the `@path` marker, and quote prices before spending credits.
99

1010
## Install
@@ -18,15 +18,15 @@ codex plugin marketplace add WaveSpeedAI/codex-plugin-wavespeed-cli
1818
Pin a release instead of tracking `main`:
1919

2020
```bash
21-
codex plugin marketplace add WaveSpeedAI/codex-plugin-wavespeed-cli --ref v0.1.3
21+
codex plugin marketplace add WaveSpeedAI/codex-plugin-wavespeed-cli --ref v0.1.4
2222
```
2323

2424
Or, with the community CLI: `npx codex-marketplace add WaveSpeedAI/codex-plugin-wavespeed-cli --plugins`.
2525

2626
## Requirements
2727

28-
- Node.js ≥ 18 (`npx` runs the MCP server, nothing else to install)
29-
- A WaveSpeed account. Either set `WAVESPEED_API_KEY`, or install the CLI (`npm install -g @wavespeed/cli`) and run `wavespeed login` once. One login covers both the MCP server and the CLI. Keys live at [wavespeed.ai/accesskey](https://wavespeed.ai/accesskey).
28+
- A WaveSpeed account. Approve the hosted MCP connection in the browser when Codex prompts you. You can revoke the resulting `MCP · …` API key on [API Keys](https://wavespeed.ai/accesskey).
29+
- For local files, batches or scripts, install the CLI (`npm install -g @wavespeed/cli`) and run `wavespeed login`. CLI authentication is separate from the hosted MCP connection. The npm install path requires Node.js ≥ 18.
3030

3131
Helper scripts, if you prefer the CLI path:
3232

‎SECURITY.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Scope
44

5-
This repository contains a Codex plugin: a skill (`SKILL.md`), an MCP server declaration that starts the published npm package [`@wavespeed/mcp`](https://github.com/WaveSpeedAI/mcp-server) with `npx`, and two helper shell scripts that install and check the [`@wavespeed/cli`](https://github.com/WaveSpeedAI/wavespeed-cli). No secrets are stored here. Authentication is handled by the CLI's `wavespeed login` or the `WAVESPEED_API_KEY` environment variable; the skill instructs the agent never to ask a user to paste a key into the chat.
5+
This repository contains a Codex plugin: a skill (`SKILL.md`), an MCP server declaration that connects to the hosted endpoint `https://api.wavespeed.ai/mcp`, and two helper shell scripts that install and check the [`@wavespeed/cli`](https://github.com/WaveSpeedAI/wavespeed-cli). No secrets are stored here. The hosted MCP connection is authorized in the browser. CLI authentication is separate, via `wavespeed login` or the `WAVESPEED_API_KEY` environment variable; the skill instructs the agent never to ask a user to paste a key into the chat.
66

77
Vulnerabilities in the MCP server or the CLI themselves should be reported against their own repositories, linked above.
88

‎plugins/wavespeed-cli/.codex-plugin/plugin.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "wavespeed-cli",
3-
"version": "0.1.3",
4-
"description": "Generate and edit AI media (image, video, audio, 3D) on the WaveSpeed platform from Codex: live catalog search, per-model schema, local-file upload, price quotes before running.",
3+
"version": "0.1.4",
4+
"description": "Generate and edit AI media (image, video, audio, 3D) on WaveSpeed through its hosted MCP server and a CLI skill for local files, batches, live catalog search and price quotes.",
55
"author": {
66
"name": "WaveSpeedAI",
77
"email": "support@wavespeed.ai",
@@ -24,7 +24,7 @@
2424
"interface": {
2525
"displayName": "WaveSpeed",
2626
"shortDescription": "AI image, video, audio and 3D generation from Codex — every model on WaveSpeed is one call.",
27-
"longDescription": "Adds the WaveSpeed platform to Codex. The bundled MCP server exposes list_models, get_model_schema, get_price, upload_file, run_model, generate_image, edit_image, generate_video, edit_video, extend_video, get_prediction and get_balance, and the bundled skill teaches the agent the find → inspect → run workflow on the open-source wavespeed CLI, including uploading local files with the @path marker and quoting prices before spending credits. One `wavespeed login` (or WAVESPEED_API_KEY) authenticates both.",
27+
"longDescription": "Adds WaveSpeed to Codex through the hosted WaveSpeed MCP server, authorized once in the browser, and a skill for the open-source wavespeed CLI. Generate, edit and extend images and videos, run any model, inspect schemas, and check prices and balance. The hosted server accepts public URLs; use the CLI with @path for local files. CLI authentication uses wavespeed login separately.",
2828
"developerName": "WaveSpeedAI",
2929
"category": "Creativity",
3030
"capabilities": [

‎plugins/wavespeed-cli/.mcp.json‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
{
22
"mcpServers": {
33
"wavespeed": {
4-
"title": "WaveSpeed",
5-
"description": "Search the live WaveSpeed model catalog, inspect schemas, quote prices, upload files, and run image, video, audio and 3D generation.",
6-
"command": "npx",
7-
"args": ["-y", "@wavespeed/mcp@latest"]
4+
"url": "https://api.wavespeed.ai/mcp"
85
}
96
}
107
}

‎plugins/wavespeed-cli/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# WaveSpeed plugin for Codex
22

3-
Generate and edit AI media — image, video, audio, 3D — on the [WaveSpeed](https://wavespeed.ai) platform from inside Codex.
3+
Generate and edit AI media — image, video, audio, 3D — on [WaveSpeed](https://wavespeed.ai) from Codex.
44

5-
- **MCP server** `@wavespeed/mcp`, started on demand with `npx`. Tools: `list_models`, `get_model_schema`, `get_price`, `upload_file`, `run_model`, `generate_image`, `edit_image`, `generate_video`, `edit_video`, `extend_video`, `get_prediction`, `get_balance`.
6-
- **Skill** `wavespeed-cli`: the find → inspect → run workflow on the open-source `wavespeed` CLI, with `@path` local-file upload and price quotes before spending credits.
5+
- **Hosted MCP server** at `https://api.wavespeed.ai/mcp`: generate, edit and extend images and videos, run any model, inspect schemas, and check prices and balance. Approve the connection once in the browser. Use public URLs; the hosted server cannot read local files.
6+
- **Skill** `wavespeed-cli`: the find → inspect → run workflow on the open-source CLI, including `@path` local-file upload, batches and price quotes before spending credits.
77

8-
Auth: `wavespeed login` once, or set `WAVESPEED_API_KEY`. One login covers the MCP server and the CLI. See the repository root README for installation.
8+
For CLI use, install `@wavespeed/cli` and run `wavespeed login`. CLI authentication is separate from the hosted MCP connection. See the repository root README for installation.

‎plugins/wavespeed-cli/SECURITY.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Scope
44

5-
This repository contains a Codex plugin: a skill (`SKILL.md`), an MCP server declaration that starts the published npm package [`@wavespeed/mcp`](https://github.com/WaveSpeedAI/mcp-server) with `npx`, and two helper shell scripts that install and check the [`@wavespeed/cli`](https://github.com/WaveSpeedAI/wavespeed-cli). No secrets are stored here. Authentication is handled by the CLI's `wavespeed login` or the `WAVESPEED_API_KEY` environment variable; the skill instructs the agent never to ask a user to paste a key into the chat.
5+
This repository contains a Codex plugin: a skill (`SKILL.md`), an MCP server declaration that connects to the hosted endpoint `https://api.wavespeed.ai/mcp`, and two helper shell scripts that install and check the [`@wavespeed/cli`](https://github.com/WaveSpeedAI/wavespeed-cli). No secrets are stored here. The hosted MCP connection is authorized in the browser. CLI authentication is separate, via `wavespeed login` or the `WAVESPEED_API_KEY` environment variable; the skill instructs the agent never to ask a user to paste a key into the chat.
66

77
Vulnerabilities in the MCP server or the CLI themselves should be reported against their own repositories, linked above.
88

‎plugins/wavespeed-cli/skills/wavespeed-cli/SKILL.md‎

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,16 @@
11
---
22
name: wavespeed-cli
3-
description: Generate, edit, animate, upscale, or transform AI media using the WaveSpeed CLI from Codex. Use when the user asks to create image, video, audio, 3D, TTS, marketing creatives, or to inspect/run WaveSpeed models.
3+
description: Generate or edit AI media (image, video, audio, 3D) on WaveSpeed, through the WaveSpeed MCP tools when they are connected or the wavespeed CLI on the user's machine. Use whenever the user asks to create, edit, animate, extend, upscale, or transform an image or video, generate audio/TTS/music or 3D, or produce marketing creatives.
44
---
55

6-
# WaveSpeed CLI
6+
# WaveSpeed
77

8-
Use the `wavespeed` CLI to run WaveSpeed image, video, audio, and 3D models: the shortcuts for plain images and videos, and the generic run for every other model.
8+
WaveSpeed runs every model on its platform. There are two ways in, and they do the same things:
99

10-
This plugin also starts the WaveSpeed MCP server. Its tools map one-to-one onto the CLI commands below: `list_models` = `wavespeed models`, `get_model_schema` = `wavespeed schema`, `get_price` = `wavespeed price`, `upload_file` = `wavespeed upload`, `run_model` = `wavespeed run`, `generate_image` / `edit_image` / `generate_video` / `edit_video` / `extend_video` = `wavespeed generate|edit|extend`, `get_prediction` = `wavespeed show`, `get_balance` = `wavespeed balance`. Prefer the MCP tools for single generations; use the CLI when it is installed and the user wants batch or scripted runs. Both share the same login.
10+
- **MCP tools** (`generate_image`, `generate_video`, …): use them when the WaveSpeed MCP server is connected. The hosted server cannot read local files: pass public URLs, or use the CLI for files on disk.
11+
- **The `wavespeed` CLI**: use it when it is installed, for local files (`@./path`), batches and scripts.
1112

12-
## Before Running
13-
14-
Check whether the CLI is available:
15-
16-
```bash
17-
wavespeed --version
18-
```
19-
20-
If it is missing, run this plugin helper:
21-
22-
```bash
23-
./plugins/wavespeed-cli/scripts/install-wavespeed-cli.sh
24-
```
25-
26-
Check auth before generation:
27-
28-
```bash
29-
wavespeed status
30-
```
31-
32-
If the user is not signed in, ask them to run `wavespeed login`. Do not ask the user to paste an API key into chat. For CI or one-off shells, `WAVESPEED_API_KEY` may be set in the environment.
13+
For plain image and video work, use the shortcuts. For anything else (audio, 3D, upscaling, a specific endpoint, exact parameters), use the generic run.
3314

3415
## Images and videos: the shortcuts
3516

@@ -96,6 +77,11 @@ If `wavespeed.json` exists (created by `wavespeed init`):
9677
- **`defaultModel`** lets `wavespeed run -p "…"` (no model arg) work.
9778
- **Aliases** are named shortcuts that bundle model + default inputs. Run `wavespeed aliases` to see them; `wavespeed run <alias> -h` shows the resolved schema. CLI `-i k=v` overrides alias defaults.
9879

80+
## Auth
81+
82+
- CLI: `wavespeed status` shows whether the user is signed in. If not, ask them to run `wavespeed login` (opens https://wavespeed.ai/accesskey).
83+
- MCP: if the tools ask for authorization, the user approves the connection once in the Codex connection prompt.
84+
- **Never** ask the user to paste an API key into the chat.
9985

10086
## Cost and credits
10187

0 commit comments

Comments
 (0)