docs: use "tmux" as the registration slug throughout#40
Open
Conversation
why: README's recommended registration slug is `tmux` (matches what users actually think — "the tmux MCP"), but `docs/clients.md` and the install-widget were using `libtmux`. Followers of either doc would end up with `mcp__tmux__*` or `mcp__libtmux__*` tool prefixes depending on which page they read. Aligning every doc to `tmux` removes the papercut. what: - docs/clients.md: 18 registration-slug `libtmux` -> `tmux` (in `claude mcp add ...`, `codex mcp add ...`, `gemini mcp add ...`, JSON `mcpServers.libtmux` keys, TOML `[mcp_servers.libtmux]` key). Package name `libtmux-mcp`, module `libtmux_mcp`, and GitHub link unchanged. - docs/_ext/widgets/mcp_install.py: 9 registration-slug occurrences in INSTALL_CMDS dict updated to `tmux`. `pip install libtmux-mcp` lines unchanged. - tests/docs/test_widgets.py + snapshots: assertions and stored snapshots updated to expect the new `tmux` slug. note: existing user registrations as `libtmux` keep working — the slug is a per-install user choice, not a property of the package. This change recommends `tmux` for new installs.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #40 +/- ##
=======================================
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. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/clients.mdand the install widget were usinglibtmuxas the registration slug whileREADME.mdrecommendstmux. Followers of either doc would end up withmcp__tmux__*ormcp__libtmux__*tool prefixes depending on which page they read.This PR aligns every doc to
tmux:docs/clients.md— 18 registration-sluglibtmux→tmux(inclaude mcp add,codex mcp add,gemini mcp add, JSONmcpServers.libtmuxkeys, TOML[mcp_servers.libtmux]key)docs/_ext/widgets/mcp_install.py— 9 registration-slug occurrences inINSTALL_CMDStests/docs/test_widgets.py+ snapshots — assertions and stored snapshots updated to expect the newtmuxslugThe package name
libtmux-mcp, the importlibtmux_mcp, and the GitHub link are unchanged. Existing user registrations aslibtmuxkeep working — the slug is a per-install user choice, not a property of the package. This change just recommendstmuxfor new installs.Test plan
uv run ruff check . && uv run mypy && uv run py.test -q(428 passed; widget snapshot tests updated)just build-docs