docs(readme): pitch PRIMARY-selection feature in Why This Exists#128
Conversation
Add a featured "### Bonus: read your X11/Wayland selection without Ctrl-C" subsection to ## Why This Exists, alongside the existing table-paste and fixes-copying-from-Claude-Code pitches. The feature shipped in #122 was previously documented only as three short parameter descriptions in the tools table, so a Linux user installing mcp-clipboard for this kind of workflow couldn't find it without reading every parameter description carefully. The new subsection: - Explains CLIPBOARD vs PRIMARY in two short sentences (selection buffer, middle-click paste, updates on highlight without Ctrl-C). - Lists the three tools that accept selection="primary" (clipboard_paste, clipboard_read_raw, clipboard_list_formats). - Calls out four concrete workflows: terminal triage, vim/IDE visual selection, browser/PDF reading, two-buffer (CLIPBOARD + PRIMARY). - States the macOS/Windows rejection up front so users on those platforms aren't surprised. Docs only; no code change. CHANGELOG entry added under [Unreleased] / Changed. Closes #123. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
cmeans
left a comment
There was a problem hiding this comment.
QA Round 1 — Ready for QA Signoff
Single round, zero findings. Docs-only PR; the new ### Bonus: read your X11/Wayland selection without Ctrl-C subsection lands at README.md:67, between the existing ### Bonus: it also fixes copying from Claude Code and ## Tools. Heading hierarchy is consistent (two ### Bonus siblings under ## Why This Exists) and the ## Tools table immediately following renders without an orphan blank line or list bleed.
Issue #123 scope match.
| Issue requirement | PR coverage |
|---|---|
Option 1 (light touch) or Option 2 (featured ### Bonus) |
Option 2 ✓ |
| CLIPBOARD vs PRIMARY explanation | ✓ "Linux desktops have two clipboards…" |
| Names the three accepting tools | ✓ clipboard_paste, clipboard_read_raw, clipboard_list_formats |
| Workflow callout: terminal triage | ✓ |
| Workflow callout: vim/IDE visual selection | ✓ |
| Workflow callout: browser/PDF reading | ✓ |
| Workflow callout: two-buffer | ✓ |
| macOS/Windows clear-error caveat | ✓ "Linux only. macOS and Windows have no equivalent buffer; passing selection=\"primary\" on those platforms returns a clear error." |
CHANGELOG. Single bullet under [Unreleased] / ### Changed — correct Keep-a-Changelog category for a docs change. Closes #123 correctly stated.
Convention spot-checks.
- New content has zero em-dashes (per repo convention).
git diff main...HEAD | grep "^+" | grep -c "—"→ 0. - American spellings throughout (highlighted, selection, paragraph, behavior — none of behaviour/colour/grey/centre).
- Pre-existing em-dashes at
README.md:86, 231, 233, 255, 271are correctly listed as out-of-scope in the PR body — acknowledged, not regressed by this PR.
Local verification on c451835 (docs-only, expected no-op):
uv run pytest -q→ 599 passed, 19 deselected, 5 xfailed in 3.90s.uv run ruff check src tests scripts→ clean.uv run mypy src→ clean.python scripts/sync-server-json.py --check→ in sync at2.5.1.- Pre-existing 13-check CI suite all green.
Test plan. Ticked checkboxes 2 (Tools table still renders correctly after the new subsection — verified) and 3 (CI green — verified). Checkbox 1 (PyPI render) is post-merge / post-release and stays unchecked until the next vX.Y.Z ships.
Verdict: Ready for QA Signoff. Awaiting maintainer QA Approved.
|
Adding Ready for QA Signoff — docs-only PR, issue #123 scope fully covered (Option 2 featured subsection with all four workflow callouts and the macOS/Windows clear-error caveat), local verification clean (599/19/5; ruff, mypy, sync-server-json all clean), CI fully green, no em-dashes in new content, zero findings. Awaiting maintainer |
Closes #123. Promotes the X11/Wayland PRIMARY-selection support that shipped in #122 from "three parameter descriptions in the tools table" to a featured
### Bonussubsection under## Why This Exists, alongside the existing table-paste pitch and the fixes-copying-from-Claude-Code pitch.What landed
README.md:### Bonus: read your X11/Wayland selection without Ctrl-Csubsection between the existing Claude-Code copy-from-terminal Bonus section and the## Toolstable.selection="primary"(clipboard_paste,clipboard_read_raw,clipboard_list_formats).CHANGELOG.md:[Unreleased] / ### Changedentry.Why this shape
Issue #123 outlined two options: a single bullet in
### Reading your clipboard(light touch), or a featured subsection under## Why This Existswith workflows. Picked the featured shape because PRIMARY is structurally distinct from the Ctrl-C clipboard (different buffer, different trigger semantics) and is worth equal billing with the other two "why" pitches. The tools-table parameter descriptions still cover the light-touch surface for parameter-level skimmers.Verification
lint,typecheck,test (3.11/3.12/3.13),integration-x11,version-sync, andvalidate-server-jsonshould all stay green / no-op.Out of scope
README.mdandCHANGELOG.md(lines 86, 231, 233, 255, 271 in README; many older CHANGELOG entries). Cosmetic; can be a separate sweep if desired.### Tips for reliable triggeringor### Reading your clipboardexamples. Issue Surface PRIMARY-selection feature in README beyond the tools-table parameter mention #123 explicitly asked for one shape, not both.Test plan
## Toolstable still renders correctly immediately after the new subsection (no orphan blank line, no list bleed).lint,typecheck,test (3.11/3.12/3.13),integration-x11,version-sync,validate-server-json.Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com