Skip to content

Commit 8f92c8a

Browse files
tadasanttoby
authored andcommitted
Open source FAQ
1 parent 9d041ad commit 8f92c8a

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

docs/faq.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ These questions come up often in discussions about the MCP Registry. If you have
77
### What is the MCP Registry?
88

99
The MCP Registry is the official centralized metadata repository for publicly-accessible MCP servers. It provides:
10+
1011
- A single place for server creators to publish metadata about their servers
1112
- A REST API for MCP clients and aggregators to discover available servers
1213
- Standardized installation and configuration information
@@ -19,6 +20,7 @@ No. The MCP Registry stores metadata about MCP servers and references to where t
1920
### Who should use the MCP Registry directly?
2021

2122
The registry is designed for programmatic consumption by:
23+
2224
- MCP client applications (Claude Desktop, Cline, etc.)
2325
- Server aggregators (Smithery, PulseMCP, etc.)
2426
- NOT individual end-users (they should use MCP clients or aggregator UIs)
@@ -32,6 +34,7 @@ A UI is planned as a future milestone after the initial API launch, but is not p
3234
### How do I publish my MCP server?
3335

3436
Servers are published by submitting a `server.json` file through our CLI tool. The process requires:
37+
3538
1. GitHub authentication
3639
2. A public GitHub repository (even for closed-source servers - just for the metadata)
3740
3. Your server package published to a supported registry (npm, PyPI, Docker Hub, etc.)
@@ -45,7 +48,7 @@ Servers are published by submitting a `server.json` file through our CLI tool. T
4548

4649
### Is open source required?
4750

48-
Locally-run servers are required to be open source. Remote servers are not.
51+
No. While open source code is encouraged, it is not required for either locally or remotely run servers.
4952

5053
### What package registries are supported?
5154

@@ -58,6 +61,7 @@ More can be added as the community desires; feel free to open an issue if you ar
5861
### Can I publish multiple versions?
5962

6063
Yes, versioning is supported:
64+
6165
- Each version gets its own immutable metadata
6266
- Version bumps are required for updates
6367
- Old versions remain accessible for compatibility
@@ -76,18 +80,21 @@ A reverse-publication flow is planned to allow quick deletion of accidentally pu
7680
### How do I know a server is from the claimed organization?
7781

7882
DNS verification ensures namespace ownership. For example:
83+
7984
- `com.microsoft/server` requires DNS verification of microsoft.com
8085
- `io.github.username/server` is tied to a GitHub account or GitHub organization
8186

8287
### What about typosquatting?
8388

8489
The registry implements:
90+
8591
- Automatic blocking of names within a certain edit distance of existing servers
8692
- Community reporting mechanisms
8793

8894
### Is there security scanning?
8995

9096
The MVP delegates security to the underlying package registries. Future iterations may include:
97+
9198
- Vulnerability scanning
9299
- Dependency analysis
93100

@@ -104,6 +111,7 @@ The MVP delegates security to the underlying package registries. Future iteratio
104111
### How often should I poll the registry?
105112

106113
Recommended polling frequency:
114+
107115
- `/servers` endpoint: once per day
108116
- `/servers/:id` endpoint: once per version (results are immutable)
109117
- Design assumes CDN caching between registry and consumers
@@ -115,6 +123,7 @@ Not in the initial MVP, but the architecture supports adding webhooks for update
115123
### Can I run my own registry instance?
116124

117125
While the API shapes and data formats are designed for reuse, the registry implementation itself is not designed for self-hosting. Organizations needing private registries should:
126+
118127
- Implement the same API shape
119128
- Use the same `server.json` format
120129
- Potentially mirror/filter the official registry data
@@ -156,6 +165,7 @@ Categorization and curation are intentionally left to consumers (MCP clients and
156165
### Will there be quality metrics?
157166

158167
Quality assessment is explicitly out of scope for the official registry. This is delegated to:
168+
159169
- MCP clients (for their specific use cases)
160170
- Third-party aggregators
161171
- Community reviews on external platforms
@@ -166,4 +176,4 @@ Internationalization is a future consideration but not part of the MVP.
166176

167177
### Will private registries be supported?
168178

169-
The registry design (API shapes, data formats) is intended to be reusable for private deployments, but the official registry will only host public servers.
179+
The registry design (API shapes, data formats) is intended to be reusable for private deployments, but the official registry will only host public servers.

0 commit comments

Comments
 (0)