docs(agent-plugin): add install guides for the Arcade agent plugin by teallarson · Pull Request #1175 · ArcadeAI/docs

teallarson · 2026-09-03T16:14:48Z

Adds Get Started guides for installing the Arcade agent plugin and understanding client support. Existing MCP client guides point readers to the plugin when they want Arcade's hosted gateway.

Documents client installation and gateway sign-in, including Codex sessions in the CLI or ChatGPT desktop app and Cursor team marketplace imports with optional automatic refresh.
Explains app authorization and provider secrets in the default Arcade project. Removes the unsupported ChatGPT ZIP route and internal routing and telemetry details.
Uses literal repository and gateway values, removes the substitution transform and six unpublished-route redirects, and preserves the page-title escaping regression test.

The branch includes current main with its merge conflict resolved. The support table was checked against plugin v0.4.0; repository install commands can fetch newer content. Live client installation and authentication were not run.

Validation: production build, lint, typecheck, all 897 tests, metadata validation, and redirect checks pass locally. Both plugin pages pass Vale with zero alerts. The full Vale command stops on an existing MDX parser error in app/en/build/arcade-deploy/page.mdx, which matches main. The committed public/llms.txt descriptions were checked directly.

Publication remains subject to GRO-309 release approval. No release approval is claimed here.

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

Note

Low Risk
Documentation and a small test fix only; no runtime product or auth logic changes.

Overview
Adds a new Get Started → Agent Plugin section with install steps for Cursor, Claude Code, VS Code, GitHub Copilot CLI, Codex, Claude Desktop, and generic HTTP MCP clients, plus a What's included page covering the hosted MCP gateway, skills, subagent, client support matrix, commands, and default-project secrets.

Existing MCP client guides now steer readers toward the plugin for Arcade's hosted gateway (info callouts and a section on the MCP clients index), while keeping self-configured gateway setup as the focus of those pages. public/llms.txt and the spellcheck vocab gain the new routes; the MDX page-title metadata test compares HTML-escaped titles so apostrophes in frontmatter don't fail the check.

^{Reviewed by Cursor Bugbot for commit 68760df. Bugbot is set up for automated code reviews on this repo. Configure here.}

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 · 2026-09-03T16:14:55Z

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

Project	Deployment	Actions	Updated
docs	Ready	Preview	Oct 19, 2026 9:10pm UTC

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

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>

…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

teallarson · 2026-10-19T18:56:43Z

+        const escapedTitle = renderToStaticMarkup(
+          createElement("title", null, frontmatterTitle)
+        ).match(HTML_TITLE_RE)?.[1];
+        if (!(escapedTitle && renderedTitle.includes(escapedTitle))) {


thanks to a title having an apostrophe in it now.

laughnan · 2026-10-19T18:55:45Z

+
+## Use the hosted gateway
+
+To connect your agent to apps through Arcade's hosted gateway, [install the Arcade agent plugin](/get-started/agent-plugin). These client guides connect to a gateway you configure.


[nit] match the other CTAs and rephrase for clarity

Suggested change

To connect your agent to apps through Arcade's hosted gateway, [install the Arcade agent plugin](/get-started/agent-plugin). These client guides connect to a gateway you configure.

To connect your agent to apps through Arcade's hosted gateway, [install the Arcade agent plugin](/get-started/agent-plugin). This guide connects your client to a gateway you configure.

Co-authored-by: Alex Laughnan <alex@alexlaughnan.com>

Ports the agent plugin install guides (#1175): the new Agent Plugin section under Get started, the links to it from the MCP client pages, the llms.txt entries and the Vale vocabulary. Two things the new pages needed: - Nextra's Code and Table (with Table.Tr, Table.Th, Table.Td) are available in every page, as the What's included page uses them. - The page heading gets the same curly quotes, dashes and ellipses as the body, as it did when the heading was part of the MDX. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

🤖 Regenerate LLMs.txt

b7ecaab

vercel Bot deployed to Preview September 3, 2026 16:20

View deployment

vercel Bot deployed to Preview September 3, 2026 16:25

View deployment

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

vercel Bot deployed to Preview September 3, 2026 16:57

View deployment

teallarson and others added 2 commits September 3, 2026 13:10

🤖 Regenerate LLMs.txt

4f7d2ce

vercel Bot deployed to Preview September 3, 2026 17:14

View deployment

teallarson and others added 2 commits September 3, 2026 13:22

🤖 Regenerate LLMs.txt

ea2cbc3

vercel Bot deployed to Preview September 3, 2026 17:26

View deployment

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

continue to iterate

d6d785d

vercel Bot deployed to Preview September 3, 2026 18:59

View deployment

torresmateo previously requested changes Sep 3, 2026

View reviewed changes

teallarson and others added 2 commits September 3, 2026 19:48

Update app/en/get-started/agent-plugin/page.mdx

94b8415

Co-authored-by: Mateo Torres <mateo@arcade.dev>

Update app/en/get-started/agent-plugin/tools-only/page.mdx

9fa0f85

Co-authored-by: Mateo Torres <mateo@arcade.dev>

vercel Bot deployed to Preview September 3, 2026 23:52

View deployment

docs(agent-plugin): apply review feedback

b4286c1

vercel Bot deployed to Preview September 8, 2026 21:12

View deployment

Merge remote-tracking branch 'origin/main' into teal/gro-303-add-arca…

fe207e2

…de-plugin-install-guides-to-docsarcadedev # Conflicts: # public/llms.txt

vercel Bot deployed to Preview September 9, 2026 21:16

View deployment

vercel Bot deployed to Preview September 11, 2026 20:20

View deployment

teallarson added 2 commits October 2, 2026 09:45

Merge remote-tracking branch 'origin/main' into teal/gro-303-add-arca…

d8eb0f0

…de-plugin-install-guides-to-docsarcadedev

docs(agent-plugin): sync released install paths

9c7c8fa

teallarson commented Oct 19, 2026

View reviewed changes

Comment thread app/en/get-started/agent-plugin/whats-included/page.mdx

teallarson added 5 commits October 19, 2026 11:44

Merge main into plugin documentation branch

ccc9fe0

Remove plugin substitutions and unpublished redirects

ee58ea8

docs: clarify plugin installation and project secrets

24e9b8e

Update plugin guide descriptions in llms index

ad86a95

Clarify hook runtime and Cursor refresh requirements

757f784

vercel Bot deployed to Preview October 19, 2026 15:59

View deployment

teallarson added 2 commits October 19, 2026 14:51

artisinal edits from teal the human herself

a057fae

🧹

795deb5

teallarson commented Oct 19, 2026

View reviewed changes

vercel Bot deployed to Preview October 19, 2026 19:01

View deployment

laughnan reviewed Oct 19, 2026

View reviewed changes

Update app/en/get-started/mcp-clients/page.mdx

e6c10da

Co-authored-by: Alex Laughnan <alex@alexlaughnan.com>

laughnan approved these changes Oct 19, 2026

View reviewed changes

teallarson enabled auto-merge (squash) October 19, 2026 19:10

auto-merge was automatically disabled October 19, 2026 19:11
Head branch was modified

teallarson enabled auto-merge (squash) October 19, 2026 19:27

auto-merge was automatically disabled October 19, 2026 19:28
Head branch was modified

teallarson enabled auto-merge (squash) October 19, 2026 21:03

teallarson marked this pull request as draft October 19, 2026 21:04

auto-merge was automatically disabled October 19, 2026 21:04
Pull request was converted to draft

teallarson marked this pull request as ready for review October 19, 2026 21:04

teallarson enabled auto-merge (squash) October 19, 2026 21:04

auto-merge was automatically disabled October 19, 2026 21:05
Head branch was modified

chore: rerun docs checks

68760df

vercel Bot deployed to Preview October 19, 2026 21:10

View deployment

teallarson enabled auto-merge (squash) October 19, 2026 21:11

teallarson merged commit a193638 into main Oct 19, 2026
10 checks passed

sdserranog mentioned this pull request Oct 19, 2026

Move the docs from Nextra to Fumadocs #1250

Merged

Navigation Menu

Repository navigation

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

docs(agent-plugin): add install guides for the Arcade agent plugin#1175
teallarson merged 46 commits into
mainfrom
teal/gro-303-add-arcade-plugin-install-guides-to-docsarcadedev

teallarson commented Sep 3, 2026 •

edited by cursor Bot

Loading

Uh oh!

vercel Bot commented Sep 3, 2026 •

edited

Loading

Uh oh!

torresmateo left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

teallarson Oct 19, 2026

Uh oh!

laughnan Oct 19, 2026

Uh oh!

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants


		## Use the hosted gateway

		To connect your agent to apps through Arcade's hosted gateway, [install the Arcade agent plugin](/get-started/agent-plugin). These client guides connect to a gateway you configure.

Conversation

teallarson commented Sep 3, 2026 • edited by cursor Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel Bot commented Sep 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

torresmateo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

teallarson Oct 19, 2026

Choose a reason for hiding this comment

Uh oh!

laughnan Oct 19, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

teallarson commented Sep 3, 2026 •

edited by cursor Bot

Loading

vercel Bot commented Sep 3, 2026 •

edited

Loading