Skip to content

docs: describe the Clerk MCP server in the README - #114

Open
eatmorespinach wants to merge 11 commits into
mainfrom
drewsing/readme-mcp-server-section
Open

eatmorespinach wants to merge 11 commits into
mainfrom
drewsing/readme-mcp-server-section

Conversation

@eatmorespinach

@eatmorespinach eatmorespinach commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

What does this solve? What changed?

  • We want Clerk's MCP server listed on github.com/mcp. That list feeds VS Code's MCP gallery and Copilot. WorkOS and Supabase are already there.
  • GitHub's registry team replied with one blocker. Our registry entry must link to a public repo, and its README must say what the server does, how to connect it, and how to use it. GitHub shows that README in Copilot.
  • This repo already ships the server in the clerk plugin, so we'd point the listing here instead of creating a new repo.
  • This PR adds a short "Clerk MCP Server" section after Install. It links to the docs for per-agent setup, so we don't maintain those steps twice. The Install link to the server now points to this section, not the raw endpoint, which shows "Unauthorized" in a browser.

I'd like feedback on placement. The section sits below Install so skills stay the headline. GitHub may want it higher, since Copilot readers arrive looking for the server.

Deadline

The prerequisite clerk/clerk#3720 has merged. It documents the organization and user update tools and includes the analytics FAQ fix from clerk/clerk#3729, so the linked guide now matches this README. Merge this PR before clerk/mcp#1 is published and server.json is republished with this repo's URL.

Other resources

✎

GitHub's MCP Registry shows the README of the server's public repo in
Copilot, and requires it to say what the server does and how to
connect it. Add a short section and link to it from Install.
@eatmorespinach
eatmorespinach marked this pull request as ready for review October 30, 2026 21:05
@eatmorespinach
eatmorespinach requested review from a team as code owners October 30, 2026 21:05
@SarahSoutoul SarahSoutoul self-assigned this Oct 30, 2026
Comment thread README.md Resolved
@SarahSoutoul

Copy link
Copy Markdown
Contributor

@eatmorespinach Pushed a docs review clarifying the wording for the analytics paragraph, using a descriptive link for the full data details, and changing "Example Prompts" to "Example prompts". The rest reads clearly to me.

To answer your request around feedback of the MCP section placement, I think it works well directly after Install: skills remain the focus, and readers looking for the server can find it quickly. Left one comment to consider and should be good to approve then.

Comment thread README.md Resolved
@SarahSoutoul

SarahSoutoul commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

@eatmorespinach To confirm the merge order and have it as paper trail:

  • #3745 is already merged.
  • Next is merging the two MCP guide updates: #3720 and #3729.
  • Then, merge this PR before clerk/mcp#1 is published.

Does that match the rollout you're planning? Also, since #114 is blocked for the moment, I've added the "do not merge" label. If you're good with this order, could you update the PR description accordingly so we have it documented there?

@SarahSoutoul SarahSoutoul added the do not merge Prevents PRs from being merged while label is applied. label Nov 3, 2026
@eatmorespinach

Copy link
Copy Markdown
Contributor Author

@SarahSoutoul yep we're aligned

Next is merging the two MCP guide updates: https://github.com/clerk/clerk/pull/3720. As fyi we may wait on https://github.com/clerk/clerk/pull/3729 (just talked to devin) until Codex plugin is approved, so if so, we can first do 3720.
Then, merge this PR before https://github.com/clerk/mcp/pull/1 is published.

@SarahSoutoul

Copy link
Copy Markdown
Contributor

Cool! Have updated the description with this plan then @eatmorespinach

Comment thread README.md Resolved
@SarahSoutoul SarahSoutoul removed the do not merge Prevents PRs from being merged while label is applied. label Nov 12, 2026

@SarahSoutoul SarahSoutoul left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM!

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.

2 participants