Skip to content

docs: update CLI command for adding GitHub PAT in README#2527

Open
RossTarrant wants to merge 1 commit into
mainfrom
rosstarrant/update-claude-cli-in-readme
Open

docs: update CLI command for adding GitHub PAT in README#2527
RossTarrant wants to merge 1 commit into
mainfrom
rosstarrant/update-claude-cli-in-readme

Conversation

@RossTarrant
Copy link
Copy Markdown
Contributor

Summary

Updates the README Claude CLI example for configuring the GitHub MCP Server with a PAT to use the current claude mcp add command.

Why

The README referenced claude mcp update github, but update is not a valid Claude MCP command. This aligns the README with the existing Claude installation guide.

Fixes #2053

What changed

  • Replaced the outdated claude mcp update github example in README.md
  • Updated the example to use claude mcp add github ... -- docker run ...

MCP impact

  • No tool or API changes
  • Tool schema or behavior changed
  • New tool added

Prompts tested (tool changes only)

  • N/A (documentation-only change)

Security / limits

  • No security or limits impact
  • Auth / permissions considered
  • Data exposure, filtering, or token/size limits considered

Tool renaming

  • I am renaming tools as part of this PR (e.g. a part of a consolidation effort)
    • I have added the new tool aliases in deprecated_tool_aliases.go
  • I am not renaming tools as part of this PR

Lint & tests

  • Linted locally with ./script/lint — not run; documentation-only change
  • Tested locally with ./script/test — not run; documentation-only change

Docs

  • Not needed
  • Updated (README / docs / examples)

@RossTarrant RossTarrant requested a review from a team as a code owner May 22, 2026 15:00
Copilot AI review requested due to automatic review settings May 22, 2026 15:00
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the README’s Claude Code CLI example for configuring the GitHub MCP Server with a GitHub PAT to use the valid claude mcp add command (matching the existing Claude installation guide), fixing the previously documented non-existent claude mcp update usage.

Changes:

  • Replaced the outdated claude mcp update github ... example with claude mcp add github ... -- docker run ... in README.md.
  • Aligned the README command with docs/installation-guides/install-claude.md’s Docker setup instructions.
Show a summary per file
File Description
README.md Fixes the Claude CLI command example for adding the server with a PAT (switches from invalid update to add with Docker invocation).

Copilot's findings

  • Files reviewed: 1/1 changed files
  • Comments generated: 0

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.

Documentation for adding with claude cli is wrong

4 participants