docs(build-mcp-server, quickstart): swap Reddit demo for GitHub star#979
Closed
thierrypdamiba wants to merge 1 commit into
Closed
docs(build-mcp-server, quickstart): swap Reddit demo for GitHub star#979thierrypdamiba wants to merge 1 commit into
thierrypdamiba wants to merge 1 commit into
Conversation
Mirror the scaffold change in ArcadeAI/arcade-mcp (replacing the Reddit posts demo with a GitHub star_repo demo) so the build-mcp-server guide and mcp-server-quickstart stop dead-ending at the broken Reddit OAuth authorize flow. Reddit's authorize endpoint currently returns "bad request: invalid client id" against the managed OAuth client the Arcade Engine uses for the reddit provider, so readers who follow these pages today can't get past the "authorize the tool" step. Changes: build-mcp-server/page.mdx - server.py snippet: from arcade_mcp_server.auth import Reddit → GitHub, get_posts_in_subreddit → star_repo using GitHub(scopes=["public_repo"]) and PUT https://api.github.com/user/starred/{owner}/{repo}. - Also fixes a stale "finally-mcp-server" User-Agent left over from someone's local project name (the real template uses "{{ toolkit_name }}-mcp-server", which renders to "my_server-mcp-server" for the tutorial's app name). - Updates the "Since the Reddit tool…" prose to GitHub equivalent. - Updates the sample log-output line: "Added tool: get_posts_in_subreddit" → "Added tool: star_repo". mcp-server-quickstart/page.mdx - Updates the get_posts_in_subreddit bullet to describe star_repo. - Updates the sample log-output line. - Updates the "Since the Reddit tool…" prose. - Updates the example prompt list to "Star the ArcadeAI/arcade-mcp repository on GitHub". - Updates the troubleshooting header "The Reddit tool is not working" → "The GitHub tool is not working". Pairs with: ArcadeAI/arcade-mcp PR (swap minimal scaffold template). Not run locally: - pnpm install + ultracite + vale (heavy dep tree for a prose-only swap; relying on CI). Co-authored-by: Cursor <cursoragent@cursor.com>
|
@thierrypdamiba is attempting to deploy a commit to the Arcade AI Team on Vercel. A member of the Team first needs to authorize it. |
Author
|
Reopening from upstream branch so CI (Vale, LLMSTXT, Vercel) can access repo secrets that fork PRs don't receive. Same diff, same body, same draft state. New PR will be linked below once opened. |
Author
|
Continued in #980 (same diff + body, opened from upstream branch so CI gets secrets). |
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.
Important
Depends on ArcadeAI/arcade-mcp#850 — do not merge before #850 lands.
This PR updates the public docs to describe a tool that doesn't exist in the scaffold until #850 ships. Merging in the wrong order would leave the guides describing a tool tutorial readers can't generate. Opened as draft to make the ordering enforceable; will flip to ready-for-review the moment #850 merges.
Summary
Updates the
build-mcp-serverguide and the MCP server quickstart so they describe the new GitHubstar_repodemo from the minimal scaffold instead of the broken Redditget_posts_in_subredditdemo.Today, a tutorial reader runs through either page, hits the consent URL Arcade prints, and Reddit's authorize endpoint returns:
…which is unfixable in this repo (or on the Arcade Engine side without Reddit's manual re-approval under their November 2025 Responsible Builder Policy). Issue #976 (filed by
@naganowl) captures the bug in detail.The scaffold fix lands in ArcadeAI/arcade-mcp#850. This PR is its paired docs update so the guides match the scaffold the moment that lands.
Resolves: #976 (docs side; the auth-provider reference page rewrite is separate)
Design decisions
arcade new <name>→ run server → invoke the auth-required tool. Other docs that mention Reddit (the auth-provider reference, blog posts, thearcade-tdkREADME) describe Reddit-the-provider as a concept, not the scaffold demo, so they don't break under [AUTO] Adding MCP Servers docs update #850 and aren't in scope here.ArcadeAI/arcade-mcpas the target repo is on-brand and gives the reader a satisfying visible side effect (their star lands on the repo they're learning to use).Added tool: get_posts_in_subreddittoAdded tool: star_repo. The reader copy-pastes the run command and checks their terminal against this exact line; if it doesn't match, the guide loses credibility.User-Agentstring in the code snippet fromfinally-mcp-servertomy_server-mcp-serverso it matches whatarcade new my_serveractually renders (the scaffold uses{{ toolkit_name }}-mcp-server, which expands tomy_server-mcp-serverfor the guide's example name). Pre-existing drift, caught while updating the snippet.Scope
In scope:
app/en/guides/create-tools/tool-basics/build-mcp-server/page.mdx— the main tutorialapp/en/get-started/quickstarts/mcp-server-quickstart/page.mdx— the quickstart that mirrors the same flowNot in scope (separate decisions):
app/en/references/auth-providers/reddit/page.mdx— the Reddit auth-provider reference page itself. The provider entry can stay (it describes how to integrate Reddit auth if/when Reddit re-approves Arcade); only the tutorial needed pivoting.arcade-tdkREADME in thearcade-mcprepo, or example MCP servers underexamples/mcp_servers/authorization/. Those describe Reddit-as-a-provider conceptually, not as the scaffolded demo, and don't break under [AUTO] Adding MCP Servers docs update #850.Test plan
pnpm run lint(or repo equivalent) on the two changed.mdxfiles — cleanget_posts_in_subredditremain in either fileUser-Agentstring, the tool name (star_repo), and the example invocation match the rendered output ofarcade new my_serverfrom fix(arcade-cli): swap minimal scaffold demo from Reddit to GitHub star arcade-mcp#850's branch — verified by runningarcade new my_serveragainst that branch and diffingRisk note
Pure docs change. Zero runtime impact. The only real risk is merge-order — if this lands before #850, the guides describe a tool that the scaffold doesn't produce yet, which would actively confuse the next tutorial reader. The draft state on this PR is the merge-order guardrail.
Author checklist