Skip to content

Commit 5abcbb4

Browse files
committed
docs: align README with Agent Router positioning
1 parent b776ca8 commit 5abcbb4

6 files changed

Lines changed: 57 additions & 37 deletions

File tree

‎.codex-plugin/plugin.json‎

Lines changed: 1 addition & 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 models, Social Data, Effects, and workflows from Codex.",
4+
"description": "Route Model, Data, Tool, and Workspace capabilities through BeatAPI from Codex.",
55
"author": {
66
"name": "BeatAPI",
77
"email": "support@beatapi.io",

‎.cursor-plugin/plugin.json‎

Lines changed: 1 addition & 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 models, Social Data, Effects, and workflows from Cursor and Grok Bot.",
4+
"description": "Route Model, Data, Tool, and Workspace capabilities through BeatAPI from Cursor and Grok Bot.",
55
"author": {
66
"name": "BeatAPI",
77
"email": "support@beatapi.io"

‎.grok-plugin/plugin.json‎

Lines changed: 1 addition & 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 models, Social Data, Effects, and workflows from Grok Build.",
4+
"description": "Route Model, Data, Tool, and Workspace capabilities through BeatAPI from Grok Build.",
55
"author": {
66
"name": "BeatAPI",
77
"url": "https://beatapi.io"

‎README.md‎

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,48 @@
11
<p align="center">
2-
<img src="assets/readme/cover.svg" alt="BeatAPI Agent Plugin connects Codex, Cursor, Grok Bot, and Grok Build to BeatAPI text, image, video, and workflow APIs" width="100%" />
2+
<img src="assets/readme/cover.svg" alt="BeatAPI Agent Plugin — connect Agent hosts to Model, Data, Tool, and Workspace capabilities" width="100%" />
33
</p>
44

55
<p align="center">
6+
<a href="https://beatapi.io/"><strong>Explore BeatAPI</strong></a> ·
7+
<a href="https://beatapi.io/dashboard/apikeys">Create an API key</a> ·
8+
<a href="https://docs.beatapi.io/">Docs</a> ·
69
<a href="#quick-start">Quick start</a> ·
7-
<a href="#model-coverage">Model coverage</a> ·
810
<a href="#api-key-and-secret-safety">Security</a> ·
911
<a href="#verification">Verification</a>
1012
</p>
1113

1214
# BeatAPI Agent Plugin
1315

14-
For a host-independent onboarding prompt, use
15-
`set up https://beatapi.io/SKILL.md`. The repository root [`SKILL.md`](SKILL.md)
16-
mirrors that setup contract; the detailed installable Skill remains under
17-
`skills/beatapi-video/`.
16+
BeatAPI is the **Agent Router for Everything**: one route to Model, Data, Tool,
17+
and Workspace capabilities. This plugin connects Codex, Cursor, Grok Bot, and
18+
Grok Build to BeatAPI through a bundled Skill, local MCP server, typed client,
19+
and locked public contract.
1820

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.
21+
For host-independent onboarding, give an Agent this instruction:
22+
23+
```text
24+
set up https://beatapi.io/SKILL.md
25+
```
26+
27+
The repository root [`SKILL.md`](SKILL.md) mirrors that setup contract; the
28+
detailed installable Skill remains under `skills/beatapi-video/`.
2229

2330
For hosts that support remote MCP, BeatAPI also provides the stable Hosted MCP
2431
endpoint `https://beatapi.io/mcp` with three provider-neutral tools:
2532
`capabilities_search`, `capabilities_inspect`, and `capabilities_run`. The
2633
bundled local MCP keeps focused workflow, upload, account, and task tools for
2734
host-native use; both surfaces discover model IDs dynamically.
2835

36+
## How it routes
37+
38+
```text
39+
Codex · Cursor · Grok -> Skill + local MCP -> BeatAPI -> Model · Data · Tool · Workspace
40+
```
41+
42+
The plugin exposes only capabilities supported by its current public contract
43+
and the live catalog. Tool and Workspace coverage expands through reviewed
44+
interfaces and integrations rather than README-only claims.
45+
2946
The repository packages the same canonical `beatapi-video` Skill, bundled MCP
3047
server, typed client, and locked OpenAPI contract for four agent surfaces:
3148

@@ -264,3 +281,7 @@ before opening a pull request.
264281
## License
265282

266283
MIT
284+
285+
<p align="center">
286+
Built by <a href="https://beatapi.io/"><strong>BeatAPI</strong></a> — Agent Router for Everything.
287+
</p>

‎assets/readme/cover.svg‎

Lines changed: 23 additions & 24 deletions
Loading

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "beatapi-agent-plugin",
33
"version": "0.3.0",
44
"private": true,
5-
"description": "Cross-host Agent Toolkit plugin for BeatAPI models, Social Data, and workflows.",
5+
"description": "Cross-host Agent plugin for BeatAPI, the Agent Router for Everything.",
66
"type": "module",
77
"scripts": {
88
"build": "node scripts/build-mcp.mjs",

0 commit comments

Comments
 (0)