docs(mcp): client setup for Codex and others, plus troubleshooting - #20
Merged
Conversation
…ting section The MCP README covered Claude only, and the npm page for that package is where anyone deciding whether to use it lands. - Codex CLI, both `codex mcp add` and the raw ~/.codex/config.toml block. Syntax verified against codex-cli 0.137.0 locally rather than copied from a blog: `codex mcp add <NAME> -- <COMMAND>`, and the TOML shape confirmed against a real installed server entry. - Claude Code, Claude Desktop, and a generic stdio block that works for Cursor, VS Code, Windsurf and Zed. - "What you can ask for": the requests a person actually makes, since the tool names mean nothing to someone reading the npm page. - Troubleshooting for the four real failures — server will not start, ffmpeg missing from a GUI-launched client's PATH, a format rejected, and files reported as skipped when nothing is wrong. - Badges, and every parameter documented. Claims checked against the PUBLISHED package over npx, not the local workspace build: all five tools list, list_capabilities reports correctly, and stdout is genuinely silent (0 bytes) so the protocol cannot be corrupted — which is what the troubleshooting section tells people to expect. No relative links in mcp/README.md: that package sets repository.directory to "mcp", so npm's relative-link rewriting is fragile there. Absolute GitHub URLs instead.
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.
The MCP README covered Claude only. The npm page for that package is where people decide whether to use it, so it needed to cover more than one client.
Client setup
codex mcp addand the raw~/.codex/config.tomlblockThe Codex syntax is verified locally against codex-cli 0.137.0, not copied from a blog post:
codex mcp add <NAME> -- <COMMAND>..., with the TOML shape ([mcp_servers.<name>]+command+args) confirmed against a real installed server entry.Also added
PATH, a format rejected as unsupported, and files reported asskippedwhen nothing is wrong.Verified against the published package
Not the local workspace build — the actual thing users get:
The troubleshooting section tells people the server should print nothing on stdout, so I checked that too — 0 bytes, exit 0 on stdin close. A stray byte there would corrupt JSON-RPC.
One packaging note
mcp/README.mddeliberately uses absolute GitHub URLs, no relative links. That package setsrepository.directorytomcp, which makes npm's relative-link rewriting fragile. The main README keeps its relative links, which resolve correctly from the repo root.