docs(time, git): fix invalid JSON in Zed context_servers config snippets#4231
Open
Cyberfilo wants to merge 1 commit into
Open
docs(time, git): fix invalid JSON in Zed context_servers config snippets#4231Cyberfilo wants to merge 1 commit into
context_servers config snippets#4231Cyberfilo wants to merge 1 commit into
Conversation
…ppets
The Zed configuration snippets in `src/time/README.md` and
`src/git/README.md` used `"context_servers": [` (array) with
key-value entries inside — which is not valid JSON. The other
Zed `context_servers` snippets in the same files (under `Using
pip installation`) correctly use `{` (object), so this was an
inconsistent typo on the `uvx` variants.
The result is that copy-pasting the snippet straight into
`~/.config/zed/settings.json` causes Zed to fail parsing the
file silently and ignore the MCP server registration.
Switches `[` to `{` and `],` to `},` on the two affected
snippets so they match Zed's expected object shape and the
adjacent pip-installation snippets in the same READMEs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The Zed configuration snippets under `Using uvx` in `src/time/README.md` and `src/git/README.md` use an array `[` with key-value entries inside, which is not valid JSON:
```json
"context_servers": [
"mcp-server-time": {
"command": "uvx",
"args": ["mcp-server-time"]
}
],
```
The adjacent `Using pip installation` snippets in the same files correctly use an object `{`, so this was an inconsistent typo on the uvx variants.
The practical effect: copy-pasting the snippet straight into `~/.config/zed/settings.json` causes Zed to fail parsing the file silently and ignore the MCP server registration. Users who go through the README expecting a working copy-paste configuration land on a broken Zed config.
Fix
Switch `[` to `{` and `],` to `},` on the two affected snippets so the structure matches:
Test plan
Each fixed snippet now parses cleanly when wrapped in the surrounding `{ }` braces that an actual `settings.json` would supply. Diff is 4 lines changed across 2 files; no other content modified.
Filed under CONTRIBUTING.md's "Improvements to existing documentation is welcome" lane.