Repository navigation
docs(agent-plugin): add install guides for the Arcade agent plugin - #1175
Draft
teallarson wants to merge 27 commits into
Draft
teallarson wants to merge 27 commits into
teallarson wants to merge 27 commits into
Conversation
Adds a Get Started section for installing Arcade through the agent plugin:
an overview with the one-command install and per-agent verification in tabs,
a Claude Desktop connector guide, a tools-only guide for any MCP client, and
a page on what changes when a trial becomes a team rollout.
The existing MCP Clients guides all assume you want your own gateway and an
API key, so each one now points trial users at the plugin, and the plugin
pages point back for anyone who needs their own tool list and identities.
Every install surface resolves from two constants in lib/agent-plugin.ts.
Pages reference them as {{TOKEN}} placeholders and a remark plugin resolves
those in prose, code blocks, and link targets, so the staging gateway URL
becomes a one-line change at launch. The Cursor and VS Code one-click links
are derived from the same URL rather than pasted, and the plugin rewrites
the raw source Nextra exports so the copy-page button and the markdown the
site serves to agents get resolved values too.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
The pages implied the plugin needs no account at all, conflating "no API key" with "no signup". An Arcade account is required; what is different about this path is the timing. You install first, and the link your agent hands you on its first app task both creates the account and authorizes the app. Adds "Claude Desktop" to the Vale vocabulary so the new page title stops reading as stray capitalization. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
… rollout Corrects the sign-in story. An Arcade gateway authorizes on two layers and the pages described only one, blurred together: signing in to the gateway when your client connects, and authorizing each app when a task needs it. Both are now named, with a link to the existing server-level vs tool-level explainer, and the pages say plainly that tool calls, tokens, and secrets route through your own project, isolated from other users of the same gateway. Removes "Verify the install per agent". Checking that a plugin loaded is not something to do before trying it. The parts of that section that were real install steps (the enable flags, the one-click gateway-only links, the shared Codex/Copilot directories) moved into Install and a new Tools only section. Expands the component list into what each piece does for you, since naming six things in one paragraph explained none of them. Reframes the rollout page around the three questions a team has to answer rather than three things the reader is told they want, with a matching numbered list up front so the page survives skimming. Drops "trial" throughout in favor of personal use; nothing here is time limited. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…ools-only Claude Desktop ships as a downloadable .mcpb bundle, so the page now leads with that download and keeps the custom-connector URL as the by-hand alternative at the bottom. The bundle URL points at the latest GitHub release and derives from the repo constant; confirm the asset filename once a release publishes. Renames "any MCP client" to "tools only", which is the actual distinction. The old page sorted clients by whether they support plugins; readers care whether they want the tools alone or the whole plugin. It now says what you give up by skipping the skills, commands, and subagent, so the choice is informed rather than a fallback. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…s-only Both pages describe the same thing, the gateway as a plain MCP server with none of the plugin's skills, commands, or subagent. Sitting them beside Overview implied they were alternative full installs. They are now children of a Tools-only MCP server page that carries the shared concept, the gateway URL, what you give up, and the two-layer sign-in, so each child is just its install steps. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
torresmateo
previously requested changes
Sep 3, 2026
torresmateo
left a comment
Collaborator
There was a problem hiding this comment.
I like these docs with a small caveat.
I think we're introducing two things that look very similar to MCP gateways and if you're not deep in the weeds of what's a plugin vs a gateway vs a server things can spiral very quickly.
On the overview page, I think we need a sentence on the plugin overview page that explains what it is as clearly as possible, telling users the things that are bundled at the beginning of that page.
Co-authored-by: Mateo Torres <mateo@arcade.dev>
Co-authored-by: Mateo Torres <mateo@arcade.dev>
…de-plugin-install-guides-to-docsarcadedev # Conflicts: # public/llms.txt
… prod gateway Match arcade-plugin's marketplace-first Claude Desktop flow, drop the unreleased .mcpb path, and point all install surfaces at the production gateway URL. Co-authored-by: Cursor <cursoragent@cursor.com>
…de-plugin-install-guides-to-docsarcadedev
Keep the plugin pages in llms.txt and take the current documentation index from main. Co-authored-by: Teal Larson <LARSON.TEAL@GMAIL.COM>
Describe marketplace installs, Codex skill invocation, conditional organization identity, released fallback, and the telemetry-off build. Limit the shared gateway claim to the signed-in app connections.
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes GRO-303.
Important
DO NOT MERGE / KEEP DRAFT. The plugin repository and production gateway are live, but the GRO-309 launch and marketing gate still needs explicit verification. Keep this PR gated until that approval is confirmed and Teal authorizes removing the gate.
Adds a Get Started section for installing Arcade through the agent plugin. The install paths and support matrix are synced to the released
arcade-pluginv0.2.1 documentation.Pages
app/en/get-started/agent-plugin/sits second in Get Started as the personal-use path that needs no gateway or API-key setup before installation.The overview uses tabs because the client-specific install content is short and belongs beside the capability matrix. Existing MCP client guides continue to document a gateway you control and point personal-use readers to the plugin where applicable.
Released installation paths
The cross-client
npx plugins addcommand does not finish every supported client install in v0.2.1, so the page now uses the client-native paths from the released source:chat.plugins.enabled.copilot plugin install.The commands were source-checked against the released v0.2.1 documentation, not tested against the user's installed clients. Repository-based install commands are not release-pinned and can resolve newer repository content.
Completed fixes cover native Desktop and client-specific installation and connection guidance, Codex skill invocation, required permissions and possible reauthentication, and organization identity providers only when the organization uses one. Fallbacks require authorization and stop on sign-in or permission denial. App-connection identity wording now describes the verified connection identity rather than making unsupported absolute isolation claims.
Current plugin state
Current plugin
mainis6f4cdc7695b1953cdb2b7d207e53e5abb9738d1c, including merged #26's hard-disabled telemetry foundation; plugin package metadata remains v0.2.1. Adapter and reporting PRs #27, #28, and #29 remain unmerged, as does the proposed v0.3.0 release #30. No environment setting enables telemetry in the current build. Hosted gateway and app requests still occur.Shared values
lib/agent-plugin.tsholds the two shared values:lib/remark-substitute.tsresolves those tokens in prose, inline code, fenced code blocks, and link targets, including the raw Markdown used by copy-page and agent-facing outputs. The obsolete universal install-command token was removed.tests/broken-link-check.test.tsresolves the tokens before link validation so substituted URLs are not treated as relative paths.Generated
llms.txtpublic/llms.txtcontains current titles and useful descriptions for the install-guide and MCP-client pages changed here.During readiness work, the generator's recorded base SHA was found to be missing from repository history. The current workflow treats that Git error as zero changed pages and reports success without regeneration. Its configured OpenAI key also returned 401 when generation was forced. Those are repository-wide generator reliability issues and are intentionally not fixed in this focused documentation PR; they need a separate follow-up with tests and an explicit decision about failing versus deterministic fallback behavior.
Because of that known issue, a green Generate LLMSTXT check on this PR is not evidence that regeneration occurred. Review the committed
public/llms.txtdiff directly.Not included
.mcpbDesktop Extension. The v0.2.1 release intentionally installs Claude Desktop from the plugin marketplace and offers the production gateway as the tools-only connector path.main; the reliability fix is saved separately for follow-up review.Human review and release prerequisites
arcade-operator. His previous Changes requested review is now Dismissed, not an approval; its dismissal does not establish GRO-309 launch approval.https://api.arcade.dev/mcp/arcadeis the production endpoint.Verification
4fee3995deb7c81f7947db536863b038ae4ebb6b; conflict resolution is complete.public/llms.txtdiff directly.Preview: Vercel deployment
— Strider 🐦⬛, Teal's agent · approved by Teal.
🤖 Originally generated with Claude Code; readiness cleanup updated with Codex.