Skip to content

docs(cli): say who runs the server, not what running it does - #180

Merged
valentinozegna merged 1 commit into
mainfrom
docs/help-stdio-wording
Aug 23, 2026
Merged

docs(cli): say who runs the server, not what running it does#180
valentinozegna merged 1 commit into
mainfrom
docs/help-stdio-wording

Conversation

@valentinozegna

Copy link
Copy Markdown
Contributor

Summary

  • The help header said "Run with no command to start the server over stdio", but running it by hand in a terminal prints the setup hint instead; the server only serves when an MCP client spawns it. The sentence in help and the matching one in docs/cli.md now say that

Test plan

  • npm run type-check; CLI tests pass; help output reads correctly

Changelog

  • CLI: the help header no longer implies running the binary by hand starts the server; an MCP client's spawn does

Help said running with no command starts the server over stdio, but by hand in a terminal it prints the setup hint instead; only an MCP client's spawn serves. The sentence now says that, in help and in docs/cli.md.
@claude

claude Bot commented Aug 23, 2026

Copy link
Copy Markdown

Claude finished @valentinozegna's task in 39s —— View job


Review complete ✅

  • Gather context (diff, CLAUDE.md)
  • Review src/cli/commands.ts wording change
  • Review docs/cli.md wording change
  • Post inline comments if needed
  • Post summary

Verdict: LGTM — clean, accurate wording fix. No inline comments.

I verified the new wording against src/index.ts:86-96: when stdin is a TTY (run by hand), the process prints the "run by an MCP client" setup hint and returns instead of calling runServer(); the server only actually starts over stdio when spawned non-interactively (i.e., by an MCP client). Both edits now correctly reflect that:

  • src/cli/commands.ts:54-55 (help header) — accurate.
  • docs/cli.md:3 — accurate, and consistent with the help header's phrasing.

Also checked:

  • No other file still has the old "Run with no command to start the server over stdio" phrasing — this was the only occurrence.
  • No test asserts the exact help-header string, so nothing needed updating there.
  • Scope matches the stated PR: pure wording, no behavior change, no changelog/version files touched (per repo convention).

Nothing further to suggest.

@valentinozegna
valentinozegna added this pull request to the merge queue Aug 23, 2026
Merged via the queue into main with commit 86cfecf Aug 23, 2026
3 checks passed
@valentinozegna
valentinozegna deleted the docs/help-stdio-wording branch August 23, 2026 20:34
@valentinozegna valentinozegna mentioned this pull request Aug 23, 2026
2 tasks
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