Skip to content

docs(readme): restructure Installation with a client decision guide#499

Open
mocha06 wants to merge 2 commits into
devfrom
docs/readme-install-restructure
Open

docs(readme): restructure Installation with a client decision guide#499
mocha06 wants to merge 2 commits into
devfrom
docs/readme-install-restructure

Conversation

@mocha06

@mocha06 mocha06 commented Jul 23, 2026

Copy link
Copy Markdown
Collaborator

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.

  • Decision guide — five one-liners mapping client/need → path.
  • Comparison table — the columns that actually drive the choice: where the MCP server runs, tool surface, auth, what else it installs, and best-for.
  • Reordered subsections (Hosted MCP → Claude Code plugin → Quick-install → CLI-only → Skills-only), each opening with a "Pick this when:" line.
  • Recommendation note — Claude Code is the recommended, best-tested client; other clients (Cursor, Claude Desktop, Codex) are supported but still maturing.

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.md and skills/onboarding/pipefy-toolkit-setup/SKILL.md. Verified no dangling references to the old anchors remain.

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>
@mocha06
mocha06 requested a review from adriannoes July 23, 2026 02:38
@mocha06 mocha06 self-assigned this Jul 23, 2026

@adriannoes adriannoes left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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.

Comment thread README.md Outdated
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>
@mocha06

mocha06 commented Jul 23, 2026

Copy link
Copy Markdown
Collaborator Author

Good catch — confirmed and fixed in 716c17f. Verified on the branch tip: REMOTE_SEED is 179 of 185 (includes create_card, delete_pipe, etc.); only the 6 local-bound tools are withheld. Updated the Hosted cell to "179 of 185 (all but 6 local-bound tools)", dropped the reads-only framing, and reframed the decision bullets + both "Pick this when" lines around no-local-Python / no-CLI-or-slash-commands / the 6 local-only tools rather than reads-vs-writes.

@adriannoes

Copy link
Copy Markdown
Collaborator

The Hosted surface fix in 716c17f looks good and the review thread on that point is resolved.

Before I approve: please rebase (or merge) onto current dev and bump the Installation numbers to match post-#497 allowlists. On dev today that is 180 of 186 remote-safe (and 186 for the full local rows), not 179 of 185. The branch is still behind dev, so landing as-is would reintroduce a stale count right after merge.

Once the tip shows 180 of 186 (and local rows say 186) against an up-to-date dev base, I am happy to approve.

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