registry/docs/modelcontextprotocol-io
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Ashwanthram K L dac0982f6d
docs: signpost non-npm publishers to package-types from quickstart (#1192)
## What

Two targeted additions to `docs/modelcontextprotocol-io/quickstart.mdx`:

1. A `<Note>` immediately after the tutorial's intro, telling PyPI /
NuGet / OCI / MCPB publishers that the Step 1 ownership-verification
mechanism differs for their package type and pointing them to [Package
Types](./package-types) before continuing.
2. The troubleshooting row for **"Registry validation failed for
package"** previously named only npm's `mcpName` property in
`package.json`. It now names all three current mechanisms (npm →
`mcpName` in `package.json`; PyPI / NuGet → `mcp-name: <server-name>`
line in the package README; other types → link to Package Types).

+5 / -1 lines.

## Why

The quickstart is the landing page for new publishers, but it's entirely
TypeScript / npm-flavored — the Step 1 example shows npm's `mcpName`
property and nothing else. The cross-reference to `./package-types` only
appears in the "Next Steps" footer, by which point a PyPI publisher has
already gone through every step and hit a `400 Bad Request` at
`mcp-publisher publish`:

> `registry validation failed for package 0 (<pkg>): PyPI package
'<pkg>' ownership validation failed. The server name
'io.github.<user>/<server>' must appear as 'mcp-name:
io.github.<user>/<server>' in the package README`

That specific error has tripped at least one other publisher (#531) and
was what motivated this change. The ownership mechanism is correctly
documented at `./package-types` — the fix is purely to route people
there before they publish, not to duplicate the content.

## What this change is **not**

- It does not propose changing the validation logic.
- It does not duplicate content from `package-types.mdx` into the
quickstart.
- It does not add a separate PyPI-specific tutorial. The existing
npm-flavored tutorial remains the canonical one; the note just tells
non-npm readers which step is different.

## Verification

- Change is docs-only; no build or test impact.
- Link target `./package-types` is the same shape as the one already
used in "Next Steps" of the same file.
- Anchor `#step-1-add-verification-information-to-the-package` matches
the existing heading's slug.

## Related

- #531 — same validation error hit by another PyPI publisher; closed
with a workaround but the quickstart wasn't updated.
2026-04-23 18:21:21 -04:00
..
about.mdx Remove .mdx suffixes from internal doc links for Mintlify (#1052) 2026-03-12 11:46:30 +01:00
authentication.mdx docs: Add preview disclaimer note to public documentation 2026-01-22 07:35:03 -06:00
ecosystem-diagram.excalidraw.svg Prepare docs for modelcontextprotocol.io (#728) 2025-11-18 17:22:31 +00:00
faq.mdx Publisher-managed "deleted" support (#893) 2026-02-27 09:00:07 -08:00
github-actions.mdx Remove .mdx suffixes from internal doc links for Mintlify (#1052) 2026-03-12 11:46:30 +01:00
moderation-policy.mdx docs: Add preview disclaimer note to public documentation 2026-01-22 07:35:03 -06:00
package-types.mdx docs: Add preview disclaimer note to public documentation 2026-01-22 07:35:03 -06:00
quickstart.mdx docs: signpost non-npm publishers to package-types from quickstart (#1192) 2026-04-23 18:21:21 -04:00
registry-aggregators.mdx Remove .mdx suffixes from internal doc links for Mintlify (#1052) 2026-03-12 11:46:30 +01:00
remote-servers.mdx docs: Add preview disclaimer note to public documentation 2026-01-22 07:35:03 -06:00
terms-of-service.mdx docs: Add preview disclaimer note to public documentation 2026-01-22 07:35:03 -06:00
versioning.mdx docs: Add preview disclaimer note to public documentation 2026-01-22 07:35:03 -06:00