Skip to content

docs: add Claude Code setup instructions to MCP server guide#2529

Merged
brandonmcconnell merged 3 commits intoCopilotKit:mainfrom
ChanMeng666:main
Oct 9, 2025
Merged

docs: add Claude Code setup instructions to MCP server guide#2529
brandonmcconnell merged 3 commits intoCopilotKit:mainfrom
ChanMeng666:main

Conversation

@ChanMeng666
Copy link
Copy Markdown
Contributor

@ChanMeng666 ChanMeng666 commented Sep 29, 2025

What does this PR do?

This PR adds comprehensive setup instructions for configuring the CopilotKit MCP server in Claude Code to the existing MCP server setup documentation. The addition includes:

  • Step-by-step CLI commands for adding the CopilotKit MCP server
  • Expected output examples for verification
  • Connection verification instructions
  • Important notes about server name requirements
  • Usage information and management commands
  • Consistent formatting following the existing documentation style

The new Claude Code section is positioned logically between the Cline and GitHub Copilot sections, maintaining the document's flow and structure.

Related PRs and Issues

  • Addresses the gap in documentation for Claude Code users who want to integrate CopilotKit MCP server
  • Follows the same pattern and style as other editor/IDE integrations in the guide

Checklist

  • I have read the Contribution Guide
  • If the PR changes or adds functionality, I have updated the relevant documentation

Summary by CodeRabbit

  • Documentation
    • Added a new guide section for setting up an MCP server in Claude Code, including step-by-step commands to add an SSE MCP server, example output, and a verification checklist.
    • Improves clarity for onboarding and configuration, helping users confirm successful connections and troubleshoot setup issues.

ChanMeng666 and others added 3 commits June 29, 2025 23:49
Add comprehensive setup instructions for configuring CopilotKit MCP server
in Claude Code, including CLI commands, expected outputs, verification steps,
and management commands. Follows existing documentation style and structure.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@changesets-bot-copilotkit
Copy link
Copy Markdown

⏭️ Changeset Not Required

Latest commit: 2bd15a8

No changes in this PR affected the @copilitkit/* packages. Merging this PR will not cause a version bump for any packages.

Changeset is not required for this PR.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Sep 29, 2025

Walkthrough

Adds a new Claude Code section to the MCP server setup docs, including commands, expected output, and verification steps. The section appears duplicated within the file. No code or API changes.

Changes

Cohort / File(s) Summary of changes
Docs: MCP server setup (Claude Code section)
docs/snippets/shared/guides/mcp-server-setup.mdx
Added Claude Code instructions to add an SSE MCP server, sample output, and verification step; the new block is duplicated in the document.

Sequence Diagram(s)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

preview

Suggested reviewers

  • mme
  • ataibarkai
  • ranst91
  • tylerslaton

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly indicates that this pull request adds setup instructions for Claude Code in the MCP server guide, matching the changes to the documentation. It uses the conventional “docs” prefix and avoids unnecessary detail while clearly conveying the main intent. The scope is precise and reflects the content changes without extraneous information or vagueness.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ad8d4d1 and 2bd15a8.

📒 Files selected for processing (1)
  • docs/snippets/shared/guides/mcp-server-setup.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*

📄 CodeRabbit inference engine (.cursor/rules/quick-reference.mdc)

Check [docs/] for documentation site

Files:

  • docs/snippets/shared/guides/mcp-server-setup.mdx
docs/snippets/**/*

📄 CodeRabbit inference engine (.cursor/rules/quick-reference.mdc)

Use [docs/snippets/] for code examples in documentation

Files:

  • docs/snippets/shared/guides/mcp-server-setup.mdx

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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 and usage tips.

@vercel
Copy link
Copy Markdown
Contributor

vercel bot commented Sep 29, 2025

@ChanMeng666 is attempting to deploy a commit to the CopilotKit Team on Vercel.

A member of the Team first needs to authorize it.

@vercel
Copy link
Copy Markdown
Contributor

vercel bot commented Sep 29, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
registry Ready Ready Preview Comment Sep 29, 2025 3:42am

Copy link
Copy Markdown
Contributor

@brandonmcconnell brandonmcconnell left a comment

Choose a reason for hiding this comment

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

This looks great. Thanks, @ChanMeng666 👏

@brandonmcconnell brandonmcconnell merged commit 9d538da into CopilotKit:main Oct 9, 2025
3 of 22 checks passed
tylerslaton pushed a commit to tylerslaton/CopilotKit that referenced this pull request Nov 5, 2025
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