Skip to content

Commit dcb729f

Browse files
committed
docs: align plugin with capability platform
1 parent ae492d4 commit dcb729f

23 files changed

Lines changed: 1691 additions & 42 deletions

File tree

‎.codex-plugin/plugin.json‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "beatapi-agent-plugin",
33
"version": "0.3.0",
4-
"description": "Create and manage BeatAPI text, image, video, Effect, workflow, and analysis APIs from Codex.",
4+
"description": "Use BeatAPI models, Social Data, Effects, and workflows from Codex.",
55
"author": {
66
"name": "BeatAPI",
77
"email": "support@beatapi.io",
@@ -12,6 +12,8 @@
1212
"license": "MIT",
1313
"keywords": [
1414
"beatapi",
15+
"agent-toolkit",
16+
"social-data",
1517
"ai-video",
1618
"music-video",
1719
"ecommerce-video",
@@ -26,8 +28,8 @@
2628
"mcpServers": "./.mcp.json",
2729
"interface": {
2830
"displayName": "BeatAPI",
29-
"shortDescription": "Manage BeatAPI text, media, and workflows",
30-
"longDescription": "Use one existing BeatAPI account and API key from Codex to discover models and Effects, create text responses, upload explicitly approved inputs, check USD balance and concurrency, create image, video, Effect, Video Analysis, Music Video, and Ecommerce Video tasks, monitor progress, retrieve hosted results, and manage existing Realtime sessions and webhooks.",
31+
"shortDescription": "Use BeatAPI models, data, and workflows",
32+
"longDescription": "Use one existing BeatAPI account and API key from Codex to discover current Model, Social Data, Effect, and Workflow capabilities; create text responses; upload explicitly approved inputs; check USD balance and concurrency; create image, video, Effect, Video Analysis, Music Video, and Ecommerce Video tasks; monitor progress; retrieve hosted results; and manage existing Realtime sessions and webhooks.",
3133
"developerName": "BeatAPI",
3234
"category": "Creativity",
3335
"capabilities": [

‎.cursor-plugin/plugin.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "beatapi-agent-plugin",
33
"version": "0.3.0",
4-
"description": "Use BeatAPI text, image, video, Effects, workflows, and analysis APIs from Cursor and Grok Bot.",
4+
"description": "Use BeatAPI models, Social Data, Effects, and workflows from Cursor and Grok Bot.",
55
"author": {
66
"name": "BeatAPI",
77
"email": "support@beatapi.io"
@@ -12,6 +12,7 @@
1212
"keywords": [
1313
"beatapi",
1414
"agent-toolkit",
15+
"social-data",
1516
"ai-video",
1617
"ai-image",
1718
"text-generation",

‎.grok-plugin/plugin.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "beatapi-agent-plugin",
33
"version": "0.3.0",
4-
"description": "Use BeatAPI text, image, video, Effects, workflows, and analysis APIs from Grok Build.",
4+
"description": "Use BeatAPI models, Social Data, Effects, and workflows from Grok Build.",
55
"author": {
66
"name": "BeatAPI",
77
"url": "https://beatapi.io"
@@ -12,6 +12,7 @@
1212
"keywords": [
1313
"beatapi",
1414
"beatapi agent toolkit",
15+
"beatapi social data",
1516
"beatapi video",
1617
"beatapi image",
1718
"beatapi workflows"

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
## Unreleased
44

5+
- Synchronized the locked public OpenAPI contract with current capability,
6+
Social Data, onboarding, model, media, Effect, Workflow, and Realtime routes.
7+
- Distinguished the stable three-tool Hosted MCP from the plugin's 26 focused
8+
local MCP tools and documented the current Model/Data/Workflow catalog shape.
9+
- Updated Skill and CLI references to the published 0.3.0 capability interface.
10+
511
- Renamed the repository and package to `beatapi-agent-plugin`.
612
- Added a Cursor/Grok Bot manifest and root `mcp.json` alongside the existing
713
Codex manifest, sharing the same Skill and MCP runtime.

‎README.md‎

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,15 @@ For a host-independent onboarding prompt, use
1616
mirrors that setup contract; the detailed installable Skill remains under
1717
`skills/beatapi-video/`.
1818

19-
A cross-host Agent Toolkit plugin for discovering live BeatAPI models and
20-
running text, image, video, Effect, analysis, and production workflow
21-
APIs through one local MCP interface.
19+
A cross-host Agent Toolkit plugin for discovering live BeatAPI Model, Social
20+
Data, and Workflow capabilities and running text, image, video, Effect,
21+
analysis, and production APIs through one local MCP interface.
22+
23+
For hosts that support remote MCP, BeatAPI also provides the stable Hosted MCP
24+
endpoint `https://beatapi.io/mcp` with three provider-neutral tools:
25+
`capabilities_search`, `capabilities_inspect`, and `capabilities_run`. The
26+
bundled local MCP keeps focused workflow, upload, account, and task tools for
27+
host-native use; both surfaces discover model IDs dynamically.
2228

2329
The repository packages the same canonical `beatapi-video` Skill, bundled MCP
2430
server, typed client, and locked OpenAPI contract for four agent surfaces:
@@ -82,13 +88,13 @@ grok plugin install .
8288
The recommended credential path is the operating-system credential manager:
8389

8490
```bash
85-
npm install --global beatapi@0.2.0
91+
npm install --global beatapi@0.3.0
8692
beatapi auth login
8793
export BEATAPI_CLI_PATH="$(command -v beatapi)"
8894
```
8995

90-
The reviewed npm integrity for `beatapi@0.2.0` is
91-
`sha512-7a7XF/tCc5u2p/ZnonSkLq1JF4OPpv3yaj7mFqnQcK9/HjOtj5hMny5bax4VcTbjgHRfDc1QlFXSbF3tzIL19Q==`.
96+
The reviewed npm integrity for `beatapi@0.3.0` is
97+
`sha512-zqWqP2CSYbbPLdy3qo8umEE4U4YiMgKrtt5pnOw14ErcaMUSTU5cmxvLw02Lkkn+7mS3w+pTvxuAHTFiqAafkA==`.
9298

9399
Alternatively, export the key only in the shell that launches Grok Build:
94100

@@ -126,6 +132,11 @@ Model IDs are discovered at runtime rather than hardcoded into the plugin:
126132
| Effects | Public list and detail endpoints | Versioned Effect task creation |
127133
| Workflows | Public `GET /v1/workflows` | Music Video, Ecommerce Video, Video Analysis, and Realtime tools |
128134

135+
The provider-neutral capability catalog unifies those surfaces with Social
136+
Data. As verified on 2026-09-22, full pagination returned 60 Model
137+
capabilities, 1,000+ Data actions, and three Workflows. These are dated catalog
138+
observations, not plugin constants; always Search and Inspect again.
139+
129140
The generic image and video tools accept a current model ID plus its
130141
model-specific `parameters`. New models can therefore appear in discovery
131142
without requiring a new plugin release. The bundled OpenAPI snapshot remains the
@@ -135,6 +146,8 @@ source for each model's supported fields and constraints.
135146

136147
- discover text models, image/video model aliases, workflows, and published
137148
Effects;
149+
- search and inspect Model, Social Data, and Workflow contracts through the
150+
Hosted MCP or official CLI when a provider-neutral catalog flow is needed;
138151
- create non-streaming text responses when the user explicitly requests
139152
BeatAPI text generation;
140153
- create image, video, Effect, Video Analysis, Music Video, and Ecommerce Video
@@ -147,8 +160,9 @@ source for each model's supported fields and constraints.
147160
- inspect USD balance, usage, and active concurrency;
148161
- inspect, update, and delete existing webhook endpoints.
149162

150-
The MCP server exposes 26 focused tools. Paid mutations are labeled as such;
151-
read-only and destructive annotations are set independently.
163+
The bundled local MCP server exposes 26 focused tools. Paid mutations are
164+
labeled as such; read-only and destructive annotations are set independently.
165+
This is intentionally distinct from the Hosted MCP's three meta-tools.
152166

153167
Realtime-session and webhook creation return one-time secrets. Those two create
154168
operations are intentionally not exposed to an agent until a host secret broker
@@ -220,6 +234,11 @@ Do not edit synchronized Skill or client files directly. Refresh them through
220234
4. **OpenAI Plugin Directory:** `npm run submission:build` creates the separate
221235
Skills-only review artifact. It does not claim a hosted HTTPS MCP server.
222236

237+
For Muse and other remote-MCP hosts, connect to the Hosted MCP endpoint rather
238+
than installing this local plugin. A runnable Muse setup guide lives in the
239+
[`beatapi-examples`](https://github.com/BeatAPI/beatapi-examples/tree/main/integrations/muse)
240+
repository. Documentation does not imply an approved directory listing.
241+
223242
See [submission/SUBMISSION.md](submission/SUBMISSION.md) for the separate public
224243
directory review boundary.
225244

0 commit comments

Comments
 (0)