Skip to content

Commit 44397cb

Browse files
authored
Fix broken reference documentation links (#1387)
Summary: - Fix the reference index FAQ link to point at the existing docs FAQ. - Correct package registry guide links from docs/contributing into docs/reference. Validation: - Focused markdown-link-check on the changed docs passed. - Git whitespace check passed. Co-authored-by: kriptoburak <kriptoburak@users.noreply.github.com>
1 parent dda760f commit 44397cb

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/contributing/add-package-registry.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
The MCP Registry project is a **metaregistry**, meaning that it hosts metadata for MCP servers but does not host the code for the servers directly.
44

5-
For local MCP servers, the MCP Registry has pointers in the `packages` node of the [`server.json`](../../reference/server-json/generic-server-json.md) schema that refer to packages in supported package managers.
5+
For local MCP servers, the MCP Registry has pointers in the `packages` node of the [`server.json`](../reference/server-json/generic-server-json.md) schema that refer to packages in supported package managers.
66

7-
The list of supported package managers for hosting MCP servers is defined by the `properties.packages[N].properties.registryType` string enum in the [`server.json` schema](../../reference/server-json/draft/server.schema.json). For example, this could be "npm" (for npmjs.com packages) or "pypi" (for PyPI packages).
7+
The list of supported package managers for hosting MCP servers is defined by the `properties.packages[N].properties.registryType` string enum in the [`server.json` schema](../reference/server-json/draft/server.schema.json). For example, this could be "npm" (for npmjs.com packages) or "pypi" (for PyPI packages).
88

99
For remote MCP servers, the package registry is not relevant. The MCP client consumes the server via a URL instead of by downloading and running a package. In other words, this document only applies to local MCP servers.
1010

@@ -33,15 +33,15 @@ These steps may evolve as additional validations or details are discovered and m
3333
1. [Create a feature request issue](https://github.com/modelcontextprotocol/registry/issues/new?template=feature_request.md) on the MCP Registry repository to begin the discussion about adding the package registry.
3434
- Example for NuGet: https://github.com/modelcontextprotocol/registry/issues/126
3535
1. Open a PR with the following changes:
36-
- Update the [`server.json` schema](../../reference/server-json/draft/server.schema.json)
36+
- Update the [`server.json` schema](../reference/server-json/draft/server.schema.json)
3737
- Add your package registry name to the `registryType` example array.
3838
- Add your package registry base url to the `registryBaseUrl` example array.
3939
- Add the single-shot CLI command name to the `runtimeHint` example value array.
40-
- Update the [`openapi.yaml`](../../reference/api/openapi.yaml)
40+
- Update the [`openapi.yaml`](../reference/api/openapi.yaml)
4141
- Add your package registry name to the `registryType` enum value array.
4242
- Add your package registry base url to the `registryBaseUrl` enum value array.
4343
- Add the single-shot CLI command name to the `runtimeHint` example value array.
44-
- Add a sample, minimal `server.json` to the [`server.json` examples](../../reference/server-json/generic-server-json.md).
44+
- Add a sample, minimal `server.json` to the [`server.json` examples](../reference/server-json/generic-server-json.md).
4545
- Implement a registry validator:
4646
- Create a new validator file: `internal/validators/registries/yourregistry.go`, following the pattern of existing validators. Examples:
4747
- **npm**: Checks for an `mcpName` field in `package.json` that matches the server name

docs/reference/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ Technical specifications and quick lookups for the MCP Registry.
1919

2020
## Quick Reference
2121

22-
- [FAQ](./faq.md)
22+
- [FAQ](../modelcontextprotocol-io/faq.mdx)

0 commit comments

Comments
 (0)