🎃 Add a "Share / README badge" section with Add-to-Cursor and Add-to-VS-Code badges
维护者通常 1 天内回复
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 50/100
- Issue 类型
- 功能
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- nextjs, playwright, typescript
- 领域
- documentation, frontend, testing
调研方向
Start with the deep-link code in packages/frontend/src/app/mcp-server/[id]/page.tsx (around lines 337-345 and the Quick Connect uses at 440-457 and 473) and move the config into a new packages/frontend/src/lib/mcp-install-links.ts so the in-app buttons keep producing the same links. Then add the Share card below the Connect section, with copy buttons via handleCopy and an oauth2/both gate from server.info(). Done when the copied Markdown decodes to this server's endpoint, legacy mode shows the explanation, and the Playwright spec in tests/e2e/mcp-server-connect-clients.spec.ts passes.
由索引模型根据 Issue 内容生成。
描述
Part of the October Challenge #997.
Why
An admin who sets up an MCP server for a team wants to hand it out without walking every colleague through a config file: put "Add to Cursor" and "Add to VS Code" badges in the team README, wiki or onboarding page, click, done. Both editors support one-click MCP install links, and many MCP servers on GitHub show such badges at the top of their README.
What already exists: the MCP server page builds a Cursor deep link (cursor://anysphere.cursor-deeplink/mcp/install?…, mcp-server/[id]/page.tsx:337-340) and a VS Code deep link (vscode:mcp/install?…, :342-345), used by the "Open in Cursor" / "Open in VS Code" buttons in the Quick Connect modals (:440-457) and by "One-click add to VS Code" in the Copilot modal (:473). Custom-scheme links work when clicked inside the app, but not in a README: GitHub's Markdown sanitizer removes links that are not http(s), and most wikis do the same. What is missing is a "Share" section that produces copy-paste badge snippets based on the https install links the two editors provide.
Self-hosted vs Cloud
- Self-hosted: enabled in Community and Business. Frontend only, no
ee/code. The badge contains the instance's MCP URL; when that islocalhostor127.0.0.1, show a warning that the badge only works on this machine. The preview on the page must not load images from shields.io or any other host, because some instances run without outbound connections (docs/deployment.md:422, "Fully Offline Mode"). Only the copied snippet references remote badge images. - Cloud (
DEPLOYMENT_MODE=cloud): enabled. The URL ishttps://cloud.anythingmcp.com/mcp/<serverId>. Publishing it is safe: the URL is not a credential, and whoever clicks the badge still has to sign in and be a member of the workspace that owns the server (mcp-endpoint.controller.ts:924-970). - Who can use it: any role that can open the MCP server page. Snippets never contain an API key, token or session value.
What to build
-
Shared link builders: move the config of the two existing deep links into
packages/frontend/src/lib/mcp-install-links.ts(pure functions taking{ name, url }), add the https variants next to them, and use the module in the page, so in-app buttons and badges always encode the same config:- Cursor:
https://cursor.com/en/install-mcp?name=<name>&config=<base64 of {"url":"<endpoint>"}> - VS Code:
https://vscode.dev/redirect/mcp/install?name=<name>&config=<URL-encoded {"name","type":"http","url"}>
Check both formats against the current Cursor and VS Code documentation before building, and link the doc pages in the PR. If an editor documents an official button image, use it; otherwise use a shields.io static badge, as the repository README already does (
README.md:26-30). - Cursor:
-
"Share this server" card in the right column, below "Connect your MCP client" (
mcp-server/[id]/page.tsx:673-759), with:- a preview of both badges rendered locally (styled links, no remote images);
- "Copy Markdown" and "Copy HTML" buttons using
handleCopy(:213-227, which already recordsclient_config_copied); - the snippet itself in a code block (
codeBlock,:360-373).
-
Auth mode: a badge carries only the URL, so whoever clicks it signs in with OAuth. Show the badges only when
mcpAuthModeisoauth2orboth(fromserver.info(),lib/api.ts:982-996). Inlegacyornone, show one line instead, explaining that one-click installs need OAuth (MCP_AUTH_MODE=oauth2orboth). -
Docs: a short "Share a server with your team" paragraph in
docs/guides.mdunder "Connect your AI client".
Where to look
packages/frontend/src/app/mcp-server/[id]/page.tsx:101-105(apiUrl),:251(endpointUrl),:253(slug),:337-345(existing deep links),:440-457and:473(where they are used),:673-759(right column).packages/frontend/src/lib/api.ts:982-996:server.info()withmcpAuthMode.packages/frontend/src/lib/clipboard.ts: copy with a fallback for plain-HTTP installs.packages/backend/src/mcp-server/mcp-endpoint.controller.ts:924-970: membership check on/mcp/<serverId>.README.md:26-30: shields.io badge style already in use.packages/frontend/tests/e2e/mcp-server-connect-clients.spec.ts: test setup for this page.
Acceptance criteria
- The copied Markdown contains https links for both editors whose decoded
configpoints at exactly this server's endpoint, and nocursor://,vscode:,X-API-Key, token or cookie value. - The existing "Open in Cursor" / "Open in VS Code" buttons produce the same links as before (moved, not changed).
- With
mcpAuthMode: 'legacy'the snippets are replaced by the explanation; alocalhostendpoint shows the warning. - Rendering the page makes no request to a third-party host (assert with
page.on('request')in Playwright). - Manually verified: badges pasted into a GitHub README (a gist or a test repository) open Cursor and VS Code and add the server (describe it in the PR).
- Playwright test in
mcp-server-connect-clients.spec.ts(stub/health/server-infowithmcpAuthMode, grant clipboard permission, assert the copied text). Run withcd packages/frontend && npm run test:e2e.
Out of scope
- Badges for other clients (Claude, ChatGPT, Windsurf), which have no comparable https install link.
- Badges in this repository's own README.
- Install links that carry an API key.
Size
M (1–2 days)
How to claim
Comment "I'd like to work on this" and we'll assign you. Rules in #997.
- 主要语言
- TypeScript
- 星标
- 856
- 派生
- 82
- 平均合并
- 5 小时 45 分钟
- 30 天内合并 PR
- 158
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
HelpCode-ai/anythingmcp 的其他 Issue
-
Docs: document all SMTP_* and other undocumented env vars for self-hosting可能已有人在做 @notlakshitha 于 4 天前认领。 未关闭enhancement
难度 2/5 1-3 小时 新手友好度 82/100
HelpCode-ai/anythingmcp#1049 · 3 条评论 ·
维护者通常 1 天内回复
-
good first issue hacktoberfest
难度 2/5 半天 新手友好度 70/100
HelpCode-ai/anythingmcp#996 ·
维护者通常 1 天内回复
-
good first issue hacktoberfest
难度 2/5 半天 新手友好度 72/100
HelpCode-ai/anythingmcp#995 ·
维护者通常 1 天内回复
-
enhancement good first issue hacktoberfest help wanted
难度 2/5 1-3 小时 新手友好度 78/100
HelpCode-ai/anythingmcp#982 ·
维护者通常 1 天内回复
-
Upload the new social preview可能已有人在做 @helpcodeai 于 4 天前认领。 未关闭
HelpCode-ai/anythingmcp#1087 · 6 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
查看 HelpCode-ai/anythingmcp 的全部 Issue
相似的 Issue
-
freshness freshness:observed-only
难度 2/5 1-3 小时 新手友好度 68/100
thoroc/context-radar#280 ·
-
难度 2/5 1-3 小时 新手友好度 66/100
-
documentation story
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 74/100
维护者通常 1 天内回复
-
bug category:billing priority:p3 track:fast
难度 2/5 1-3 小时 新手友好度 72/100
LanternOps/breeze#9223 ·
维护者通常 1 天内回复