Skip to content

README: "When does my agent use this?" section#39

Open
tony wants to merge 1 commit intomainfrom
feature/readme-trigger-prose
Open

README: "When does my agent use this?" section#39
tony wants to merge 1 commit intomainfrom
feature/readme-trigger-prose

Conversation

@tony
Copy link
Copy Markdown
Member

@tony tony commented May 8, 2026

Summary

Inline answer to the most-frequent question this MCP gets — "when does the agent actually pick libtmux-mcp over a browser/editor MCP?" — added as a new section after Quickstart in README.md.

Covers:

  • Positive trigger prose ("the agent reaches for libtmux-mcp whenever you talk about a terminal surface")
  • Anti-trigger prose ("the server stays out of the way when you mean a browser window, an editor split, an i3 workspace, or a Jupyter cell")
  • The alwaysLoad: true JSON snippet for users who want libtmux-mcp's full schema list preloaded (Claude Code v2.1.121+)
  • Project-level CLAUDE.md template
  • Inside-tmux auto-context note

The server-side mechanism (alwaysLoad meta hint, serverInfo.name="tmux", BM25 description tuning) lives on pane-discoverability. This PR is intentionally docs-only so reviewers can evaluate user-facing prose independently of the server changes.

Test plan

  • uv run ruff check . && uv run mypy && uv run py.test -q (428 passed)
  • just build-docs (README rendered cleanly)

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.89%. Comparing base (f891507) to head (899ea9c).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #39   +/-   ##
=======================================
  Coverage   84.89%   84.89%           
=======================================
  Files          40       40           
  Lines        2290     2290           
  Branches      293      293           
=======================================
  Hits         1944     1944           
  Misses        261      261           
  Partials       85       85           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tony tony force-pushed the feature/readme-trigger-prose branch from 0e9c7c3 to bd8e9c4 Compare May 9, 2026 12:04
@tony
Copy link
Copy Markdown
Member Author

tony commented May 9, 2026

Code review

Retracted. This comment was based on a hallucinated finding. The local claude mcp remove --help (CLI v2.1.138) confirms:

-s, --scope <scope> Configuration scope (local, user, or project) — if not specified, removes from whichever scope it exists in.

The CLI auto-detects the scope, so the migration command does not silently no-op. Apologies for the noise.

The migration paragraph the comment referred to has also been removed from the README in the latest fixup; migration content will live in a dedicated MIGRATION.md / docs/migration.md follow-up.

Generated with Claude Code

why: the most-frequent question this MCP gets is "when does the agent
actually pick this over a browser/editor MCP?" Answer it inline in
the README rather than buried in tool descriptions: positive trigger
prose ("the agent reaches for libtmux-mcp whenever you talk about a
terminal surface") + negative trigger prose ("the server stays out
of the way when you mean a browser window, an editor split…") +
concrete examples.

what:
- README.md: insert "When does my agent use this?" section after
  Quickstart with positive triggers, anti-triggers, the alwaysLoad
  JSON snippet (Claude Code v2.1.121+), a project CLAUDE.md template,
  and inside-tmux auto-context note.

note: the alwaysLoad / serverInfo.name / per-tool meta hint
referenced in the new section land on the pane-discoverability
branch — this prose is intentionally split out so reviewers can
evaluate user-facing documentation independently of the server-side
mechanism.
@tony tony force-pushed the feature/readme-trigger-prose branch from bd8e9c4 to 899ea9c Compare May 9, 2026 12:28
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.

2 participants