Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

docs-site: "Connect to editor" one-click MCP install buttons (Cursor / VS Code)

Đang mở
  • Có gì không ổn?
#37 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation, frontend

Hướng nghiên cứu

Bắt đầu trong frontend của docs-site, không phải repository này, và tìm trang thiết lập hoặc tích hợp MCP. Triển khai các điểm vào cho Cursor, VS Code, Claude Code và mục nhập JSON thủ công bằng endpoint được lưu trữ cùng các payload được cung cấp. Xác minh từng mục QA, bao gồm các liên kết VS Code được khởi chạy từ trình duyệt, cách xử lý Insiders và một lệnh gọi công cụ docs sau khi cài đặt.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Note: This tracks a docs-site UI change, filed here for visibility. The implementation lives in the docs-site frontend, not in this repo — the MCP server is only the install target. Transfer/move to the docs-site tracker once one exists.

Summary

Add "Connect to editor" one-click install buttons for the Mapbox Docs MCP server on the docs site, following the Redocly/Sinch pattern (see developers.sinch.com). Clicking a button hands the editor a pre-filled MCP config so users skip hand-editing JSON.

Why this fits us well

  • The docs MCP server is token-free and already hosted at https://mcp-docs.mapbox.com/mcp, so the button is a genuine one-click install — no API key paste, no local install.
  • Smoother than the reference implementation: Sinch's buttons install a local server; ours points at the hosted endpoint.

Scope

  • This is a docs-site frontend change. No change to @mapbox/mcp-docs-server; the server is the target the links point at.

Deliverables

  • Cursor button — cursor://anysphere.cursor-deeplink/mcp/install?name=mapbox-docs&config=<base64>
  • VS Code button — browser-safe https://insiders.vscode.dev/redirect/mcp/install?name=mapbox-docs&config=<urlencoded> form (config uses type:http for the remote server)
  • Claude Code — copyable command, NOT a deep link (no URL scheme exists): claude mcp add mapbox-docs --transport http https://mcp-docs.mapbox.com/mcp
  • Manual-setup fallback (raw mcpServers JSON) for editors without MCP-install-URL support

Payloads (production, hosted endpoint)

  • Cursor config (raw): {"url":"https://mcp-docs.mapbox.com/mcp"} → base64 eyJ1cmwiOiJodHRwczovL21jcC1kb2NzLm1hcGJveC5jb20vbWNwIn0=
  • VS Code config (raw): {"type":"http","url":"https://mcp-docs.mapbox.com/mcp"} → URL-encoded %7B%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fmcp-docs.mapbox.com%2Fmcp%22%7D
  • Server name: mapbox-docs

Caveats

  • Custom-scheme links trigger a browser "open external app?" prompt — expected; button copy should set that expectation.
  • Requires an editor build with MCP-install-URL support (current Cursor and recent VS Code). Confirm the minimum VS Code version before publishing.
  • VS Code Insiders users may need the vscode-insiders: variant, or let the redirect resolve.

QA

  • Cursor link opens install prompt and registers mapbox-docs at the hosted URL
  • VS Code redirect link works when clicked from a browser
  • VS Code Insiders users land in Insiders
  • Claude Code command copies cleanly and runs without a token
  • Manual-setup fallback reachable for unsupported editors
  • Post-install, a docs tool call returns results against mcp-docs.mapbox.com

Reference

Full handoff spec with live buttons, drop-in HTML/markdown snippets, and payload reference prepared separately (artifact). Origin: Slack feedback from Andrew Sepic (2026-07-08).

Ngôn ngữ chính
TypeScript
Star
1
Fork
1
Merge trung bình
2 ngày 23 giờ
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của mapbox/mcp-docs-server

Tất cả issue của mapbox/mcp-docs-server

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.