Skip to content

Conversation

@jamesmontemagno
Copy link

@jamesmontemagno jamesmontemagno commented Nov 8, 2025

Added installation instructions for VS Code and VS Code Insiders.

generated via https://mcpbadge.dev/mcp

Summary by CodeRabbit

  • Documentation
    • Added VS Code installation badges for both standard and Insiders versions.
    • Added CLI setup guidance with commands for easy MCP server configuration in VS Code.
    • Simplified and clarified MCP server configuration documentation.
Added installation instructions for VS Code and VS Code Insiders.
@coderabbitai
Copy link

coderabbitai bot commented Nov 8, 2025

Walkthrough

README.md was updated to add VS Code installation badges, restructure the MCP server configuration by moving from a nested "mcp" wrapper to a top-level "servers" object with "apple-docs" configuration, introduce a new CLI section with command examples for adding MCP servers, and ensure proper file formatting with EOF newline.

Changes

Cohort / File(s) Change Summary
Documentation Updates
README.md
Added VS Code and VS Code Insiders badges; restructured MCP server configuration to use top-level "servers" object; added CLI section with npx command examples for both standard and Insiders VS Code; ensured EOF newline

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Pure documentation changes with no code logic modifications
  • Straightforward restructuring of configuration examples and addition of informational content

Poem

🐰 A badge here, a badge there,
MCP config simplified with care,
CLI commands now shine so bright,
README dressed up just right! ✨

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 accurately summarizes the main change: updating the README with VS Code installation instructions, which aligns with the primary modifications of adding VS Code badges and CLI usage snippets.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
README.md (1)

112-112: Use a proper heading instead of bold text for section.

Line 112 uses bold emphasis (**CLI**) but should use a markdown heading (###) to denote a proper subsection, especially since it introduces new instructional content below. This improves semantic structure and readability.

~ -**CLI** ~ +### CLI ~

This addresses the markdownlint MD036 violation flagged by the static analysis tools.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 60c2719 and 98d2c88.

📒 Files selected for processing (1)
  • README.md (2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md

112-112: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🔇 Additional comments (1)
README.md (1)

92-123: VS Code installation changes look good.

The addition of VS Code and VS Code Insiders installation badges, updated JSON configuration structure, and CLI commands are all properly formatted. The URLs are correct, JSON escaping is valid, and the configuration is consistent across all examples (file-based and CLI-based). The "env": {} field is appropriate for this MCP server configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant