docs: route per-agent setup to the install guide, and correct the registry record - #185
Draft
christosgkoros wants to merge 2 commits into
Draft
docs: route per-agent setup to the install guide, and correct the registry record#185christosgkoros wants to merge 2 commits into
christosgkoros wants to merge 2 commits into
Conversation
The "Supported agents and IDEs" table pointed all 9 clients at learning.postman.com and carried no per-agent detail, so a reader had to guess which of the two Quick start paths applied to their tool. Duplicating the full command matrix here was the wrong fix. GitHub applies rel="nofollow" to every outbound README link, so nothing accrues to postman.com — and a self-sufficient README means the install completes on a surface with no one-click buttons, no toolset/region toggles and no instrumentation, which is exactly where we want the funnel measured. So: keep Quick start as the generic, always-completable path (remote URL or npx), and route the per-agent specifics to the install guide, which has the one-click buttons and rewrites commands live as toolset and region change. - Replace the docs-only table with per-agent deep links to the guide's #install-<agent> anchors, plus columns showing whether a one-click install and a Postman plugin/extension/power exist for that agent. - Tag the links with UTM params so search -> install attribution survives the hop from GitHub. - Point the "IDE-specific setup" line at the guide rather than the table. - Drop Gemini CLI from the intro; it was removed from the supported set. Co-Authored-By: Claude <noreply@anthropic.com>
The registry record feeds the MCP client install UIs and pulsemcp, lobehub, glama, cursor.directory and mcpservers.com, so these fields are what a discovering agent or catalog actually reads. - description: was "A basic MCP server to operate on the Postman API." — says nothing about what the server does. Replaced with a capability-led line (93 chars; the schema caps description at 100). - title: added, so subregistries and clients have a display name. - websiteUrl: was unset. The schema calls it out as "particularly useful when the server has custom installation instructions", which is exactly this server. Now points at the install guide — this is the field that sends registry and aggregator traffic to a surface we control and can measure. - remotes: added /code and /learn for both US and EU. Only /mcp and /minimal were listed, so two of the four toolsets were invisible to anything discovering the server through the registry. - Authorization isRequired: was true on every endpoint, which contradicts OAuth. Now false for the US endpoints (OAuth needs no API key) and true for the EU endpoints, which are API-key only. Validated against static.modelcontextprotocol.io/schemas/2025-12-11. Version, package identifiers and fileSha256 are left to the release workflow. Co-Authored-By: Claude <noreply@anthropic.com>
christosgkoros
force-pushed
the
docs/readme-per-agent-install-commands
branch
from
August 5, 2026 16:09
f57e7e3 to
cd0b830
Compare
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
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
The Supported agents and IDEs table pointed all 9 clients at
learning.postman.comand carried no per-agent detail, so a reader had to guess which of the two Quick start paths applied to their tool. The intro also still advertised Gemini CLI, which was removed from the supported set.README — keep Quick start as the generic, always-completable path (remote URL or
npx), and route the per-agent specifics to the install guide:#install-<agent>anchors, with columns showing whether a one-click install and a Postman plugin / extension / power exist for that agent.server.json — the registry record feeds the MCP client install UIs and pulsemcp, lobehub, glama, cursor.directory and mcpservers.com, so these fields are what a discovering agent or catalog actually reads:
descriptionwas "A basic MCP server to operate on the Postman API." — says nothing about what the server does. Replaced with a capability-led line, 93 chars against the schema's 100 cap.titleadded, so subregistries have a display name.websiteUrlwas unset. The schema calls it out as "particularly useful when the server has custom installation instructions", which is exactly this server. This is the field that sends registry and aggregator traffic to a surface we control and can measure.remotesgained/codeand/learnfor US and EU. Only/mcpand/minimalwere listed, so two of the four toolsets were invisible to anything discovering the server through the registry.AuthorizationisRequiredwastrueon every endpoint, contradicting OAuth. Nowfalsefor US (OAuth needs no API key) andtruefor EU, which is API-key only.Version, package identifiers and
fileSha256are untouched — those belong to the release workflow.Why the approach changed
The original version put the resolved commands for all 9 agents directly in the README. Two problems with that:
rel="nofollow"on every outbound README link — verified, all 35 of them. Nothing accrues to the product page. A better-ranking README helpsgithub.com, which already ranks.mcp.postman.com, but the attribution back to a search entry is lost — and that funnel is being built.There is a real cost to the other extreme too: an agent that cannot complete an install from the README may fall back to a third party rather than fetch the page. In a SERP check on 2026-08-05, "postman mcp server config cursor" produced an answer that ended by telling the user to click "Connect next to Composio."
So this lands in the middle: Quick start stays generic and always completable, so no agent is ever stranded; per-agent specifics route to the guide, which is where the one-click buttons and live command rewriting are. The
#install-<agent>anchors these links target are new — they ship in marketing-site PR #3321, which makes the per-agent install content server-rendered for the first time.Issue
None
Stakeholder
@christosgkoros
Assignees
None
Preview
N/A — no preview deploy in this repo. Rendered README on the branch: https://github.com/postmanlabs/postman-mcp-server/blob/docs/readme-per-agent-install-commands/README.md
How to test
AuthorizationisRequired: falseclaim for US remotes matches server behaviour (OAuth without an API key)npx ajv-cli validate -s https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json -d server.json --strict=falseTest with Claude
Launch date
N/A
Checklist
server.jsonvalidated against the published MCP schemaAuthorizationisRequiredchange confirmed against server behaviour by a maintainer#install-<agent>anchors live — depends on marketing-site #3321 shipping firstReviewer note on ordering
The per-agent links point at anchors that do not exist on production yet. Merge #3321 first, or the 9 table links will land at the top of the install guide rather than the relevant agent. Everything else here is independent.
Generated with Claude Code