Skip to content

Commit be80fa7

Browse files
chore: Update broken links and folder structure in mcp-registry/README.md (#193)
* Update broken links and folder structure in mcp-registry/README.md * Add schema validation instructions
1 parent 264fc25 commit be80fa7

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

mcp-registry/README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ We welcome contributions! There are two ways to add your server to the registry:
4343

4444
### 1. Create a GitHub Issue (Easiest)
4545

46-
Simply create a [new GitHub issue](https://github.com/pathintegral-institute/mcp-registry/issues/new) with:
46+
Simply create a [new GitHub issue](https://github.com/pathintegral-institute/mcpm.sh/issues/new) with:
4747

4848
- Title: "Add server: [your-server-name]"
4949
- Body: URL to your server details or API documentation
@@ -54,26 +54,30 @@ Simply create a [new GitHub issue](https://github.com/pathintegral-institute/mcp
5454
For more control over your submission:
5555

5656
1. Fork this repository
57-
2. Create a new directory in `servers/` with your server name
58-
3. Add your `manifest.json` following our [schema](schema/manifest-schema.json)
57+
2. Create a JSON file in `mcp-registry/servers/` named `[your-server-name].json`. The JSON should follow our [schema](schema/server-schema.json)
58+
3. Validate locally to ensure correct schema
59+
```bash
60+
python scripts/validate_manifest.py | grep "your-server-name"
61+
```
62+
If validation succeeds, you should see:
63+
```
64+
✓ your-server-name: Valid
65+
```
5966
4. Submit a pull request
6067

61-
For detailed instructions, see the [Contributing Guidelines](CONTRIBUTING.md).
62-
6368
## 📂 Registry Structure
6469

6570
```
6671
mcp-registry/
6772
├── README.md # Overview, usage instructions
68-
├── CONTRIBUTING.md # Guidelines for contributing servers
6973
├── servers/ # Directory containing all registered servers
70-
│ ├── [server-name]/ # Directory for each server
71-
├── manifest.json # Server metadata and configuration
72-
└── README.md # Detailed server documentation
74+
│ ├── [server-1-name].json # Server metadata and configuration
75+
│ ├── [server-2-name].json
76+
│ └── ...
7377
└── schema/ # Schema definitions
74-
└── manifest-schema.json # JSON Schema for manifest validation
78+
└── server-schema.json # JSON Schema for server validation
7579
```
7680

7781
## 📜 License
7882

79-
This registry is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
83+
This registry is licensed under the MIT License - see the [LICENSE](../LICENSE) file for details.

0 commit comments

Comments
 (0)