docs: Fix errors and typos in public documentation
- Fix `--private-key-file` to `--private-key` in `github-actions.mdx` DNS authentication example (the CLI expects hex-encoded key data, not a file path) - Add missing `./` prefix to `mcp-publisher` command in PAT authentication example - Fix typo `verfication` to `verification` in troubleshooting table - Remove duplicate word `authentication` in `quickstart.mdx` prerequisites - Fix `name` to `identifier` field in JSON examples in `versioning.mdx` - Fix `PyPi` to `PyPI` (correct capitalization) in `moderation-policy.mdx` Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
28360d5b20
commit
9d30456d48
4 changed files with 7 additions and 9 deletions
|
|
@ -112,7 +112,7 @@ jobs:
|
|||
curl -L "https://github.com/modelcontextprotocol/registry/releases/latest/download/mcp-publisher_$(uname -s | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" | tar xz mcp-publisher
|
||||
|
||||
- name: Authenticate to MCP Registry
|
||||
run: mcp-publisher login github --token ${{ secrets.MCP_GITHUB_TOKEN }}
|
||||
run: ./mcp-publisher login github --token ${{ secrets.MCP_GITHUB_TOKEN }}
|
||||
|
||||
# Optional:
|
||||
# - name: Set version in server.json
|
||||
|
|
@ -172,9 +172,7 @@ jobs:
|
|||
# TODO: Replace `example.com` with your domain name
|
||||
# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
- name: Authenticate to MCP Registry
|
||||
run: |
|
||||
echo "${{ secrets.MCP_PRIVATE_KEY }}" > key.pem
|
||||
mcp-publisher login dns --domain example.com --private-key-file key.pem
|
||||
run: ./mcp-publisher login dns --domain example.com --private-key ${{ secrets.MCP_PRIVATE_KEY }}
|
||||
|
||||
# Optional:
|
||||
# - name: Set version in server.json
|
||||
|
|
@ -218,6 +216,6 @@ The workflow will run tests, build the package, publish the package to npm, and
|
|||
| Error Message | Action |
|
||||
| --- | --- |
|
||||
| "Authentication failed" | Ensure `id-token: write` permission is set for OIDC, or check secrets. |
|
||||
| "Package validation failed" | Verify your package successfully published to the package registry (e.g., npm, PyPI), and that your package has the [necessary verfication information](./package-types.mdx). |
|
||||
| "Package validation failed" | Verify your package successfully published to the package registry (e.g., npm, PyPI), and that your package has the [necessary verification information](./package-types.mdx). |
|
||||
|
||||
{/* prettier-ignore-end */}
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ Subregistries may have their own moderation policies. If you have questions abou
|
|||
|
||||
The MCP Registry **does not** make guarantees about moderation, and consumers should assume minimal-to-no moderation.
|
||||
|
||||
The MCP Registry is a community supported project, and we have limited active moderation capabilities. We largely rely on upstream package registries (like NPM, PyPi, and Docker) or downstream subregistries (like the GitHub MCP Registry) to do more in-depth moderation.
|
||||
The MCP Registry is a community supported project, and we have limited active moderation capabilities. We largely rely on upstream package registries (like NPM, PyPI, and Docker) or downstream subregistries (like the GitHub MCP Registry) to do more in-depth moderation.
|
||||
|
||||
This means there may be content in the MCP Registry that should be removed under this policy, but which we haven't yet removed. Consumers should treat scraped data accordingly.
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ This tutorial will show you how to publish an MCP server written in TypeScript t
|
|||
|
||||
- **Node.js** — This tutorial assumes the MCP server is written in TypeScript.
|
||||
- **npm account** — The MCP Registry only hosts metadata, not artifacts. Before publishing to the MCP Registry, we will publish the MCP server's package to npm, so you will need an [npm](https://www.npmjs.com) account.
|
||||
- **GitHub account** — The MCP Registry supports [multiple authentication methods](./authentication.mdx). authentication. For simplicity, this tutorial will use GitHub-based authentication, so you will need a [GitHub](https://github.com/) account.
|
||||
- **GitHub account** — The MCP Registry supports [multiple authentication methods](./authentication.mdx). For simplicity, this tutorial will use GitHub-based authentication, so you will need a [GitHub](https://github.com/) account.
|
||||
|
||||
If you do not have an MCP server written in TypeScript, you can copy the `weather-server-typescript` server from the [`modelcontextprotocol/quickstart-resources` repository](https://github.com/modelcontextprotocol/quickstart-resources) to follow along with this tutorial:
|
||||
|
||||
|
|
|
|||
|
|
@ -77,7 +77,7 @@ For local servers, align the server version with the underlying package version
|
|||
"packages": [
|
||||
{
|
||||
"registryType": "npm",
|
||||
"name": "@my-username/my-server",
|
||||
"identifier": "@my-username/my-server",
|
||||
"version": "1.2.3",
|
||||
"transport": {
|
||||
"type": "stdio"
|
||||
|
|
@ -139,7 +139,7 @@ If you anticipate publishing a server multiple times _without_ changing the unde
|
|||
"packages": [
|
||||
{
|
||||
"registryType": "npm",
|
||||
"name": "@my-username/my-server",
|
||||
"identifier": "@my-username/my-server",
|
||||
"version": "1.2.3",
|
||||
"transport": {
|
||||
"type": "stdio"
|
||||
|
|
|
|||
Loading…
Reference in a new issue