Skip to content

Update README.md to remove mcp key on .vscode/mcp.json example #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 23, 2025

Conversation

fuentesjr
Copy link
Contributor

@fuentesjr fuentesjr commented Apr 8, 2025

The .vscode/mcp.json configuration example in the README.md does not appear to work with the snippet provided. There is a note that indicates that the mcp key is not needed. More specifically, the mcp key needs to be removed for the .vscode/mcp.json configuration to work. To make things simpler and easier to get started, we provide two example snippets to get started depending on which settings file is used.

Before:
image

After:
image

Version:

Version: 1.99.1 (Universal)
Commit: 7c6fdfb0b8f2f675eb0b47f3d95eeca78962565b
Date: 2025-04-04T15:58:59.624Z (4 days ago)
Electron: 34.3.2
ElectronBuildId: 11161073
Chromium: 132.0.6834.210
Node.js: 20.18.3
V8: 13.2.152.41-electron.0
OS: Darwin x64 24.3.0

@Copilot Copilot AI review requested due to automatic review settings April 8, 2025 20:55
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the README.md to remove the non-required "mcp" key from the VS Code configuration example so that it works across all versions of VS Code.

  • Removed the "mcp" key block from the JSON code snippet.
  • Updated the configuration example to reflect the current VS Code requirements.

@fuentesjr fuentesjr changed the title Update README.md to remove non-required mcp key Update README.md to remove mcp key on .vscode/mcp.json example Apr 8, 2025
@SamMorrowDrums SamMorrowDrums added the documentation Improvements or additions to documentation label Apr 15, 2025
The vscode configuration example in the README.md does not work with my version of vscode. Since it's also not required, this change removes it so that it works in all versions of vscode.


Version:

```
Version: 1.99.1 (Universal)
Commit: 7c6fdfb0b8f2f675eb0b47f3d95eeca78962565b
Date: 2025-04-04T15:58:59.624Z (4 days ago)
Electron: 34.3.2
ElectronBuildId: 11161073
Chromium: 132.0.6834.210
Node.js: 20.18.3
V8: 13.2.152.41-electron.0
OS: Darwin x64 24.3.0
```
@williammartin williammartin force-pushed the fuentesjr/remove-mcp-key-from-vscode-mcp-config branch from dd6e884 to d858f11 Compare April 23, 2025 15:01
@williammartin williammartin requested a review from a team as a code owner April 23, 2025 15:01
Copy link
Collaborator

@williammartin williammartin left a comment

Choose a reason for hiding this comment

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

Much better thanks.

@williammartin williammartin merged commit f8436ab into main Apr 23, 2025
16 checks passed
@williammartin williammartin deleted the fuentesjr/remove-mcp-key-from-vscode-mcp-config branch April 23, 2025 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants