Skip to content

docs(agent-plugin): add install guides for the Arcade agent plugin - #1175

Draft
teallarson wants to merge 27 commits into
mainfrom
teal/gro-303-add-arcade-plugin-install-guides-to-docsarcadedev
Draft

teallarson wants to merge 27 commits into
mainfrom
teal/gro-303-add-arcade-plugin-install-guides-to-docsarcadedev

Conversation

@teallarson

@teallarson teallarson commented Sep 3, 2026 •

Copy link
Copy Markdown
Contributor

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-plugin v0.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.

  • Overview — client-native installation for Claude Code, Codex and ChatGPT local, Cursor, VS Code, Copilot CLI, and Claude Desktop; the released support matrix; sign-in; and sample prompts
  • Claude Desktop — plugin marketplace and tools-only connector options, plus the Chat versus Cowork and Code capability split
  • Any MCP client — the production Streamable HTTP gateway URL for OpenCode and other MCP clients
  • From trial to team rollout — the path to a dedicated gateway, curated tools, and organization-managed end-user identities

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 add command does not finish every supported client install in v0.2.1, so the page now uses the client-native paths from the released source:

  • Claude Code and Codex use their native marketplace commands.
  • Cursor individual installs clone into Cursor's local plugin directory; Teams and Enterprise use a team marketplace import.
  • VS Code uses Chat: Install Plugin From Source and chat.plugins.enabled.
  • Copilot CLI uses copilot plugin install.
  • Claude Desktop uses Customize → Plugins → Add marketplace.

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 main is 6f4cdc7695b1953cdb2b7d207e53e5abb9738d1c, 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.ts holds the two shared values:

export const AGENT_PLUGIN_GATEWAY_URL = "https://api.arcade.dev/mcp/arcade";
export const AGENT_PLUGIN_REPO = "ArcadeAI/arcade-plugin";

lib/remark-substitute.ts resolves 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.ts resolves the tokens before link validation so substituted URLs are not treated as relative paths.

Generated llms.txt

public/llms.txt contains 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.txt diff directly.

Not included

  • A .mcpb Desktop 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.
  • Automatic installation. The docs describe and verify official commands but do not modify a reviewer's local client configuration.
  • Generator infrastructure changes. The workflow and generator source match main; the reliability fix is saved separately for follow-up review.

Human review and release prerequisites

  • Mateo's review asked for a plain-language explanation of what the plugin bundles. The opening paragraph now names the hosted gateway, two skills, three commands, and arcade-operator. His previous Changes requested review is now Dismissed, not an approval; its dismissal does not establish GRO-309 launch approval.
  • GRO-309 launch and marketing approval remains the release gate even though the repository is public and https://api.arcade.dev/mcp/arcade is the production endpoint.
  • Keep the PR draft until GRO-309 approval is confirmed and Teal authorizes removing the body launch gate.

Verification

  • Current head: 4fee3995deb7c81f7947db536863b038ae4ebb6b; conflict resolution is complete.
  • Independently verified exact-head GitHub job: lint, typecheck, build, and tests pass. Schema validation, redirects, external URL checks, and Vale also pass.
  • Exact-head Vercel deployment completed successfully at 19:34 UTC.
  • Independent source review found no blocking P1/P2 issues.
  • Cloud desktop preview checks passed all six install tabs, the support table, privacy and fallback guidance, the Desktop link, and substituted commands. Clipboard verification was inconclusive.
  • Cursor reported local tests with 885 passed and 2 skipped, a build with 303 pages, and mobile checks at 390 × 844 with no horizontal overflow. These are Cursor's reported results, not independently verified local or mobile results.
  • No completed current-head Bugbot result was visible; no Bugbot pass is claimed.
  • Generate LLMSTXT is green, but its log shows a bad base SHA and zero changed pages. This is not evidence that regeneration occurred; review the committed public/llms.txt diff directly.

Preview: Vercel deployment

— Strider 🐦‍⬛, Teal's agent · approved by Teal.

🤖 Originally generated with Claude Code; readiness cleanup updated with Codex.

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>
@vercel

vercel Bot commented Sep 3, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Oct 12, 2026 7:34pm UTC

Request Review

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>
@teallarson teallarson changed the title docs(agent-plugin): add install guides for the Arcade agent plugin DO NOT MERGE ME docs(agent-plugin): add install guides for the Arcade agent plugin Sep 3, 2026
… 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>
teallarson and others added 2 commits September 3, 2026 13:10
…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>
teallarson and others added 2 commits September 3, 2026 13:22
…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>
@teallarson teallarson changed the title DO NOT MERGE ME docs(agent-plugin): add install guides for the Arcade agent plugin [GRO-303] DO NOT MERGE ME docs(agent-plugin): add install guides for the Arcade agent plugin Sep 3, 2026

@torresmateo torresmateo left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread app/en/get-started/agent-plugin/tools-only/any-mcp-client/page.mdx Outdated
Comment thread app/en/get-started/agent-plugin/page.mdx Outdated
Comment thread app/en/get-started/agent-plugin/page.mdx Outdated
Comment thread app/en/get-started/agent-plugin/page.mdx Outdated
Comment thread app/en/get-started/agent-plugin/page.mdx Outdated
Comment thread app/en/get-started/agent-plugin/page.mdx Outdated
Comment thread app/en/get-started/agent-plugin/tools-only/page.mdx Outdated
teallarson and others added 2 commits September 3, 2026 19:48
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>
cursoragent and others added 2 commits October 12, 2026 18:53
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.
@teallarson teallarson changed the title [GRO-303] DO NOT MERGE ME docs(agent-plugin): add install guides for the Arcade agent plugin docs(agent-plugin): add install guides for the Arcade agent plugin Oct 12, 2026

This branch was successfully deployed

1 active deployment
Preview — 4fee3995 Deployed Oct 12, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants