Skip to content

docs: fix npx command in README - #20

Merged
akurinnoy merged 1 commit into
mainfrom
fix/readme-npx-command
Jul 9, 2026
Merged

docs: fix npx command in README#20
akurinnoy merged 1 commit into
mainfrom
fix/readme-npx-command

Conversation

@akurinnoy

@akurinnoy akurinnoy commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Use --package (long form) instead of -p — the short form gets consumed by claude mcp add's flag parser, causing it to launch interactively instead of registering the MCP server
  • Remove --transport stdio — it's the default, and --transport isn't recognized by current CLI versions

Before

claude mcp add --transport stdio che-mcp -- npx -p che-mcp-server che-mcp-bridge

After

claude mcp add che-mcp -- npx --package che-mcp-server che-mcp-bridge

Summary by CodeRabbit

  • Documentation
    • Updated the Agent Quick Start instructions for local CLI setup.
    • Added clearer connection examples for both npx usage and a global install flow.
    • Improved formatting by separating the two setup paths for easier follow-through.

- Use --package (long form) instead of -p which gets consumed by
  claude mcp add's flag parser
- Remove --transport stdio (it's the default)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Oleksii Kurinnyi <okurinny@redhat.com>
@akurinnoy
akurinnoy requested a review from tolusha as a code owner July 9, 2026 17:41
@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 359e9123-0af5-4404-bffd-06f4017cb59a

📥 Commits

Reviewing files that changed from the base of the PR and between a10699a and a706e71.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The README's Agent Quick Start section was updated to replace a single claude mcp add example using --transport stdio and npx -p with two separate examples: one using npx --package and another showing a global npm install -g install path.

Changes

README instructions update

Layer / File(s) Summary
Update Agent Quick Start connection commands
README.md
Replaced old claude mcp add example with separate "Via npx" (--package) and "Or install globally" (npm install -g) instructions.

Estimated code review effort: 1 (Trivial) | ~2 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/readme-npx-command

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@akurinnoy
akurinnoy merged commit ca77a04 into main Jul 9, 2026
2 of 3 checks passed
@akurinnoy
akurinnoy deleted the fix/readme-npx-command branch July 9, 2026 17:42
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

Image built: quay.io/che-incubator/che-mcp-server:pr-20

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