Skip to content

docs: point MCP server examples at the public app.sourcebot.dev deployment#1462

Merged
msukkari merged 1 commit into
mainfrom
michael/mcp-docs-public-deployment
Jul 18, 2026
Merged

docs: point MCP server examples at the public app.sourcebot.dev deployment#1462
msukkari merged 1 commit into
mainfrom
michael/mcp-docs-public-deployment

Conversation

@msukkari

@msukkari msukkari commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Summary

The MCP server docs used a sb.example.com placeholder in every client example, which doesn't resolve to anything. This swaps all of them to app.sourcebot.dev so the examples connect to our public Sourcebot deployment out of the box, and adds a short note near the top telling readers to replace the URL with their own deployment as needed.

  • Replaced all 24 sb.example.com occurrences in docs/docs/features/mcp-server.mdx with app.sourcebot.dev (code snippets and the per-example "Replace ..." lines).
  • Added a note above the client examples:

    The examples below add the MCP server and connect it to Sourcebot's public deployment at app.sourcebot.dev. Replace the URL with your own Sourcebot deployment as needed.

Docs-only change, so no CHANGELOG entry.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only URL and copy updates with no runtime, auth, or API behavior changes.

Overview
MCP client setup docs now use https://app.sourcebot.dev/api/mcp instead of the non-resolving sb.example.com placeholder in every snippet and “Replace …” line (Claude Code, Cursor, VS Code, Codex, OpenCode, Windsurf; OAuth and API key tabs).

A Note above the accordion examples states that samples target the public deployment at app.sourcebot.dev and that readers should swap in their own instance URL when self-hosting.

Reviewed by Cursor Bugbot for commit 7c1c0ab. Bugbot is set up for automated code reviews on this repo. Configure here.

Summary by CodeRabbit

  • Documentation
    • Updated MCP server setup examples to use Sourcebot’s public deployment URL.
    • Clarified that users should replace the example URL with their own Sourcebot deployment address.
    • Refreshed setup instructions for Claude Code, Cursor, VS Code, Codex, OpenCode, and Windsurf.

…yment

Replaces the sb.example.com placeholder throughout the MCP server docs with
app.sourcebot.dev so the examples connect to our public deployment out of
the box, and adds a note telling readers to swap in their own deployment URL.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

@msukkari your pull request is missing a changelog!

@mintlify

mintlify Bot commented Jul 18, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
sourcebot 🟢 Ready View Preview Jul 18, 2026, 9:39 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 32cf429c-7eb4-4fbd-be5b-593d2d990805

📥 Commits

Reviewing files that changed from the base of the PR and between d739b58 and 7c1c0ab.

📒 Files selected for processing (1)
  • docs/docs/features/mcp-server.mdx

Walkthrough

Updated MCP setup documentation to use https://app.sourcebot.dev/api/mcp across six client integrations and clarified that readers should replace the public deployment URL with their own Sourcebot instance.

Changes

MCP setup documentation

Layer / File(s) Summary
Client endpoint examples and deployment guidance
docs/docs/features/mcp-server.mdx
MCP configuration examples for Claude Code, Cursor, VS Code, Codex, OpenCode, and Windsurf now use the public Sourcebot deployment URL, with corresponding instructions explaining how to substitute a self-hosted instance URL.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: brendan-kellam

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the documentation update to point MCP server examples at the public app.sourcebot.dev deployment.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch michael/mcp-docs-public-deployment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@msukkari
msukkari merged commit 1509872 into main Jul 18, 2026
10 of 11 checks passed
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.

1 participant