Skip to content

docs: add mcp-cli usage to agent instructions - #847

Merged
yxtay merged 6 commits into
mainfrom
docs/mcp-cli-agent-awareness
Jul 1, 2026
Merged

docs: add mcp-cli usage to agent instructions#847
yxtay merged 6 commits into
mainfrom
docs/mcp-cli-agent-awareness

Conversation

@yxtay

@yxtay yxtay commented Jul 1, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add ## MCP Servers section to chezmoi/private_dot_agents/AGENTS.md so AI agents know MCP servers are reachable via the mcp-cli CLI.
  • Section is intentionally minimal: it points to mcp-cli --help for the full command reference (config search paths, formats, examples) rather than duplicating it.

Why

The mcp-cli binary and ~/.config/mcp/mcp_servers.json config are already provisioned (commit f259cd4), but nothing told agents to use them. This closes that gap.

Placed in the shared AGENTS.md (imported into CLAUDE.md via @AGENTS.md) since mcp-cli is agent-agnostic.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added guidance for working with MCP servers when native support isn’t available.
    • Included quick references for finding available commands, viewing tool details, and using native MCP tools when possible.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@yxtay, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 45 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: eb63437d-6645-4ef5-a362-a60d520a0d51

📥 Commits

Reviewing files that changed from the base of the PR and between 1fec2b0 and 50310fd.

📒 Files selected for processing (5)
  • .mega-linter.yml
  • chezmoi/private_dot_agents/AGENTS.md
  • chezmoi/private_dot_claude/create_CLAUDE.md.tmpl
  • chezmoi/private_dot_claude/symlink_AGENTS.md.tmpl
  • chezmoi/private_dot_config/mcp/mcp_servers.json
📝 Walkthrough

Walkthrough

A new "MCP Servers" documentation section was added to AGENTS.md, describing usage of mcp-cli for accessing MCP servers, discovering commands, inspecting tool schemas, and preferring native MCP tools when available.

Changes

AGENTS.md MCP Documentation

Layer / File(s) Summary
MCP Servers section addition
chezmoi/private_dot_agents/AGENTS.md
Adds documentation on using mcp-cli for MCP server access, command discovery, tool schema inspection, and native tool preference.

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

Poem

A rabbit hops through docs anew,
Found "MCP" in plain view,
mcp-cli, a helpful friend,
Guides my tools from start to end,
Hop, hop, hooray — the notes ring true! 🐇📜

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the change: it adds mcp-cli usage guidance to agent instructions in a docs file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/mcp-cli-agent-awareness

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.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request adds a new 'MCP Servers' section to the AGENTS.md documentation, detailing guidelines for using the mcp-cli tool. The review feedback recommends explicitly documenting the 'call' command syntax to prevent AI agents from hallucinating execution subcommands.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread chezmoi/private_dot_agents/AGENTS.md Outdated
@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

MegaLinter analysis: Success

Descriptor Linter Files Fixed Errors Warnings Elapsed time
✅ BASH shfmt 3 0 0 0 0.02s
✅ JSON prettier 2 0 0 0 0.33s
✅ MARKDOWN markdownlint 4 0 0 0 0.55s
✅ MARKDOWN markdown-table-formatter 4 0 0 0 0.15s
✅ YAML prettier 10 0 0 0 0.48s

Notices

📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining SECURITY_SUGGESTIONS: false)

See detailed reports in MegaLinter artifacts

Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)

  • Documentation: Custom Flavors
  • Command: npx mega-linter-runner@9.5.0 --custom-flavor-setup --custom-flavor-linters BASH_SHFMT,JSON_PRETTIER,MARKDOWN_MARKDOWNLINT,MARKDOWN_MARKDOWN_TABLE_FORMATTER,YAML_PRETTIER

MegaLinter is graciously provided by OX Security
Show us your support by starring ⭐ the repository

@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

⚠️MegaLinter analysis: Success with warnings

Descriptor Linter Files Fixed Errors Warnings Elapsed time
✅ BASH bash-exec 3 0 0 0.01s
✅ BASH shellcheck 3 0 0 0.1s
✅ REPOSITORY checkov yes no no 23.71s
✅ REPOSITORY devskim yes no no 2.01s
✅ REPOSITORY dustilock yes no no 0.01s
✅ REPOSITORY gitleaks yes no no 1.48s
✅ REPOSITORY grype yes no no 48.17s
✅ REPOSITORY kingfisher yes no no 8.38s
⚠️ REPOSITORY osv-scanner yes 1 no 0.13s
✅ REPOSITORY secretlint yes no no 1.82s
✅ REPOSITORY syft yes no no 1.82s
✅ REPOSITORY trivy yes no no 12.16s
✅ REPOSITORY trivy-sbom yes no no 0.2s
✅ REPOSITORY trufflehog yes no no 4.43s

Detailed Issues

⚠️ REPOSITORY / osv-scanner - 1 error
Scanning dir .
Starting filesystem walk for root: /
End status: 39 dirs visited, 132 inodes visited, 0 Extract calls, 2.759615ms elapsed, 2.759795ms wall time
No package sources found, --help for usage information.

Notices

📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining SECURITY_SUGGESTIONS: false)

See detailed reports in MegaLinter artifacts

Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)

  • Documentation: Custom Flavors
  • Command: npx mega-linter-runner@9.5.0 --custom-flavor-setup --custom-flavor-linters BASH_EXEC,BASH_SHELLCHECK,REPOSITORY_CHECKOV,REPOSITORY_DEVSKIM,REPOSITORY_DUSTILOCK,REPOSITORY_GITLEAKS,REPOSITORY_GRYPE,REPOSITORY_OSV_SCANNER,REPOSITORY_SECRETLINT,REPOSITORY_SYFT,REPOSITORY_TRIVY,REPOSITORY_TRIVY_SBOM,REPOSITORY_TRUFFLEHOG,REPOSITORY_KINGFISHER

MegaLinter is graciously provided by OX Security
Show us your support by starring ⭐ the repository

@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

⚠️MegaLinter analysis: Success with warnings

Descriptor Linter Files Fixed Errors Warnings Elapsed time
✅ ACTION actionlint 5 0 0 0.27s
✅ ACTION zizmor 5 0 0 0 0.62s
✅ BASH bash-exec 3 0 0 0.01s
✅ BASH shellcheck 3 0 0 0.08s
✅ BASH shfmt 3 0 0 0 0.01s
✅ COPYPASTE jscpd yes no no 0.65s
✅ EDITORCONFIG editorconfig-checker 62 0 0 0.13s
✅ JSON prettier 2 0 0 0 0.33s
✅ JSON v8r 2 0 0 1.98s
✅ MARKDOWN markdownlint 4 0 0 0 0.61s
✅ MARKDOWN markdown-table-formatter 4 0 0 0 0.19s
✅ REPOSITORY checkov yes no no 22.94s
✅ REPOSITORY gitleaks yes no no 1.75s
✅ REPOSITORY git_diff yes no no 0.01s
✅ REPOSITORY grype yes no no 52.8s
⚠️ REPOSITORY osv-scanner yes 1 no 0.14s
✅ REPOSITORY secretlint yes no no 1.12s
✅ REPOSITORY syft yes no no 2.32s
✅ REPOSITORY trivy yes no no 8.75s
✅ REPOSITORY trivy-sbom yes no no 0.17s
✅ REPOSITORY trufflehog yes no no 3.94s
⚠️ SPELL lychee 18 1 0 1.13s
✅ YAML prettier 10 0 0 0 0.48s
✅ YAML v8r 10 0 0 7.23s
✅ YAML yamllint 10 0 0 0.37s

Detailed Issues

⚠️ SPELL / lychee - 1 error
📝 Summary
---------------------
🔍 Total...........19
🔗 Unique..........15
✅ Successful......18
⏳ Timeouts.........0
🔀 Redirected.......3
👻 Excluded.........0
❓ Unknown..........0
🚫 Errors...........1
⛔ Unsupported......1

Errors in chezmoi/private_dot_config/mcp/mcp_servers.json
[406] https://mcp.deepwiki.com/mcp (at 8:15) | Rejected status code: 406 Not Acceptable

Hint: Followed 3 redirects. You might want to consider replacing redirecting URLs with the resolved URLs. Use verbose mode (`-v`/`-vv`) to see redirection details.
Hint: You can configure accepted/rejected response codes with `-a` or `--accept`
⚠️ REPOSITORY / osv-scanner - 1 error
Scanning dir .
Starting filesystem walk for root: /
End status: 39 dirs visited, 132 inodes visited, 0 Extract calls, 6.350564ms elapsed, 6.350817ms wall time
No package sources found, --help for usage information.

Notices

📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining SECURITY_SUGGESTIONS: false)

See detailed reports in MegaLinter artifacts

Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)

  • Documentation: Custom Flavors
  • Command: npx mega-linter-runner@9.5.0 --custom-flavor-setup --custom-flavor-linters ACTION_ACTIONLINT,ACTION_ZIZMOR,BASH_EXEC,BASH_SHELLCHECK,BASH_SHFMT,COPYPASTE_JSCPD,EDITORCONFIG_EDITORCONFIG_CHECKER,JSON_V8R,JSON_PRETTIER,MARKDOWN_MARKDOWNLINT,MARKDOWN_MARKDOWN_TABLE_FORMATTER,REPOSITORY_CHECKOV,REPOSITORY_GIT_DIFF,REPOSITORY_GITLEAKS,REPOSITORY_GRYPE,REPOSITORY_OSV_SCANNER,REPOSITORY_SECRETLINT,REPOSITORY_SYFT,REPOSITORY_TRIVY,REPOSITORY_TRIVY_SBOM,REPOSITORY_TRUFFLEHOG,SPELL_LYCHEE,YAML_PRETTIER,YAML_YAMLLINT,YAML_V8R

MegaLinter is graciously provided by OX Security
Show us your support by starring ⭐ the repository

Provide ~/.config/mcp/mcp_servers.json for mcp-cli auto-discovery.
Split ~/.claude/CLAUDE.md into a real file importing @AGENTS.md and
symlink AGENTS.md to the canonical ~/.agents/AGENTS.md.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added size/M and removed size/S labels Jul 1, 2026
yxtay and others added 4 commits July 1, 2026 17:52
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: YuXuan Tay <5795122+yxtay@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added size/L and removed size/M labels Jul 1, 2026
@yxtay
yxtay merged commit b1c8e69 into main Jul 1, 2026
31 checks passed
@yxtay
yxtay deleted the docs/mcp-cli-agent-awareness branch July 1, 2026 10:01
@coderabbitai coderabbitai Bot mentioned this pull request Jul 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant