Skip to content

docs(mcp): client setup for Codex and others, plus troubleshooting - #20

Merged
rohanpoudel2 merged 1 commit into
mainfrom
docs/mcp-readme-clients
Aug 5, 2026
Merged

docs(mcp): client setup for Codex and others, plus troubleshooting#20
rohanpoudel2 merged 1 commit into
mainfrom
docs/mcp-readme-clients

Conversation

@rohanpoudel2

Copy link
Copy Markdown
Owner

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 CLI — both codex mcp add and the raw ~/.codex/config.toml block
  • Claude Code and Claude Desktop
  • A generic stdio block for anything else (Cursor, VS Code, Windsurf, Zed)

The 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

  • "What you can ask for" — the requests a person actually makes. Tool names mean nothing to someone reading an npm page cold.
  • Troubleshooting for the four real failure modes: server won't start, ffmpeg missing from a GUI-launched client's PATH, a format rejected as unsupported, and files reported as skipped when nothing is wrong.
  • Badges, and every parameter of every tool documented.

Verified against the published package

Not the local workspace build — the actual thing users get:

$ npx -y image-and-video-compressor-mcp
tools: compress_media, discover_media, list_capabilities, plan_video_conversion, probe_media
image formats: .jpg .png .webp .avif .tif .gif
video available: true

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.md deliberately uses absolute GitHub URLs, no relative links. That package sets repository.directory to mcp, which makes npm's relative-link rewriting fragile. The main README keeps its relative links, which resolve correctly from the repo root.

…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.
@rohanpoudel2
rohanpoudel2 merged commit 271b9f7 into main Aug 5, 2026
1 of 8 checks passed
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.

1 participant