docs(readme): restructure Installation with a client decision guide#499
docs(readme): restructure Installation with a client decision guide#499mocha06 wants to merge 2 commits into
Conversation
Rewrite the Installation section around the five ways to use the toolkit (hosted MCP, Claude Code plugin, quick-install script, CLI-only, skills-only), led by a decision guide and a comparison table showing where each MCP runs, its tool surface, auth, and what else it installs. Reorder the subsections to match the table, each opening with a "Pick this when:" line, and note that Claude Code is the recommended, best-tested client. Renaming the install subsection headings changed their anchors, so update the cross-file links in packages/mcp/README.md and the onboarding SKILL. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
adriannoes
left a comment
There was a problem hiding this comment.
This install restructure is the right shape: five paths, a comparison table, and "Pick this when" subsections make the choice greppable. Anchors and cross-links look consistent, CI is green, and there is nothing security-sensitive in the diff.
Please hold merge on one accuracy issue in the new Hosted row. The table and decision guide claim a remote-safe subset of roughly 76 of 185 tools limited to reads and discovery, and they send write needs to the Claude Code plugin. On this tip the remote seed is 179 of 185 and already includes create/update/delete; only six local-bound tools are withheld. That misstates the main Hosted vs plugin differentiator this PR is trying to teach. Requesting changes until the Hosted cell and the matching bullets match the allowlist (and until "writes require plugin" is reframed around local-only capabilities and CLI/slash ergonomics).
Separate note: if PR #497 merges first and the registry moves 185→186, refresh the totals when you land the wording fix so the guide does not churn twice.
The rewrite described Hosted as a ~76/185 reads-&-discovery subset and sent write needs to the plugin. Since #494 the remote profile exposes 179 of 185 tools (REMOTE_SEED), including create/update/delete; only 6 local-bound tools are withheld (attachment/document uploads, custom LLM-provider secrets, and execute_graphql). Update the Hosted cell, decision bullets, and both "Pick this when" lines to differentiate on no-local-Python / no-CLI-or-slash- commands / the 6 local-only tools rather than reads-vs-writes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Good catch — confirmed and fixed in |
|
The Hosted surface fix in Before I approve: please rebase (or merge) onto current Once the tip shows 180 of 186 (and local rows say 186) against an up-to-date |
What
Rewrites the README Installation section around the five ways to use the toolkit, so a first-time reader can quickly tell which path they want and how the paths differ.
Why
The prior section listed install methods as a flat set of subsections with no "which one do I pick?" guidance, and the key differentiator — hosted exposes a remote-safe subset of tools vs. all 185 locally — wasn't surfaced. This was confusing to follow as a first-time user.
Note
Renaming the install subsection headings changed their GitHub anchors, so this also updates the cross-file links in
packages/mcp/README.mdandskills/onboarding/pipefy-toolkit-setup/SKILL.md. Verified no dangling references to the old anchors remain.