Skip to content

Commit 825c4c5

Browse files
docs: clean up contributing guidelines and communication documentation (modelcontextprotocol#1312)
* docs: clean up contributing guidelines and communication documentation There's currently a bunch of duplicated content between these pages, and it's not that easy to follow. This aims to make it easier to get started, and avoid dupliated/conflicting info. * lint * Update CONTRIBUTING.md Co-authored-by: Jonathan Hefner <[email protected]> --------- Co-authored-by: Jonathan Hefner <[email protected]>
1 parent 44d14ad commit 825c4c5

File tree

5 files changed

+38
-35
lines changed

5 files changed

+38
-35
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Contributing to Model Context Protocol
22

3-
Thank you for your interest in contributing to the Model Context Protocol specification!
3+
Thank you for your interest in contributing to the Model Context Protocol specification, schemas, or docs!
44
This document outlines how to contribute to this project.
55

6-
## Prerequisites
6+
Also see the [overall MCP communication guidelines in our docs](https://modelcontextprotocol.io/community/communication), which explains how and where discussions about changes happen.
7+
8+
## General prerequisites
79

810
The following software is required to work on the spec:
911

@@ -13,9 +15,9 @@ The following software is required to work on the spec:
1315
- [Mintlify](https://mintlify.com/) (optional, for docs)
1416
- nvm (optional, for managing Node versions)
1517

16-
## Getting Started
18+
### Getting Started
1719

18-
1. Fork the repository
20+
1. [Fork the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
1921
2. Clone your fork:
2022

2123
```bash
@@ -30,7 +32,7 @@ nvm install # install correct Node version
3032
npm install # install dependencies
3133
```
3234

33-
## Making Changes
35+
## Schema changes
3436

3537
Note that schema changes are made to `schema.ts`, and `schema.json` is generated from
3638
`schema.ts`.
@@ -50,17 +52,21 @@ npm run check:schema:ts
5052
npm run generate:schema
5153
```
5254

53-
4. Validate documentation changes and apply formatting:
55+
## Documentation changes
56+
57+
Documentation is written in MDX format and in the [`docs`](./docs) directory.
58+
59+
You can preview documentation changes locally by running:
5460

5561
```bash
56-
npm run check:docs
57-
npm run format
62+
npm run serve:docs
5863
```
5964

60-
5. Preview documentation locally (optional):
65+
And lint them with:
6166

6267
```bash
63-
npm run serve:docs
68+
npm run check:docs
69+
npm run format
6470
```
6571

6672
### Documentation Guidelines
@@ -104,15 +110,6 @@ When contributing to the documentation:
104110
3. Follow the pull request template
105111
4. Wait for review
106112

107-
## Code of Conduct
108-
109-
This project follows a Code of Conduct. Please review it in
110-
[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
111-
112-
## Questions
113-
114-
If you have questions, please create an issue in the repository.
115-
116113
## License
117114

118115
By contributing, you agree that your contributions will be licensed under the MIT

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
# Model Context Protocol specification
1+
# Model Context Protocol (MCP)
22

3-
This repo contains the specification and protocol schema for the Model Context Protocol.
3+
_Just heard of MCP and not sure where to start? See [the documentation website instead](https://modelcontextprotocol.io)._
4+
5+
This repo contains the:
6+
7+
- MCP specification
8+
- MCP protocol schema
9+
- Official MCP documentation
410

511
The schema is [defined in TypeScript](schema/2025-06-18/schema.ts) first, but
612
[made available as JSON Schema](schema/2025-06-18/schema.json) as well, for wider
@@ -11,10 +17,8 @@ The official MCP documentation is built using Mintlify and available at
1117

1218
## Contributing
1319

14-
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this
15-
project.
20+
See [CONTRIBUTING.md](./CONTRIBUTING.md).
1621

1722
## License
1823

19-
This project is licensed under the MIT License—see the [LICENSE](LICENSE) file for
20-
details.
24+
This project is licensed under the [MIT License](LICENSE).

docs/community/communication.mdx

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,18 @@ title: Contributor Communication
33
description: Communication strategy and framework for the Model Context Protocol community
44
---
55

6-
This document provides practical guidance for communicating and collaborating within the Model Context Protocol (MCP) project. It outlines the communication channels, workflows, and processes used by the MCP community.
7-
8-
All communication within the MCP community is governed by our [Code of Conduct](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/CODE_OF_CONDUCT.md). We expect all participants to maintain respectful, professional, and inclusive interactions across all channels.
6+
This document explains how to communicate and collaborate within the Model Context Protocol (MCP) project.
97

108
## Communication Channels
119

12-
We support three primary communication channels: the [public Discord server][discord-join], [GitHub Issues](https://github.com/modelcontextprotocol/modelcontextprotocol/issues), and [GitHub Discussions](https://github.com/modelcontextprotocol/modelcontextprotocol/discussions) in the [main project repository](https://github.com/modelcontextprotocol/modelcontextprotocol).
10+
In short:
11+
12+
- **[Discord][discord-join]**: For real-time or ad-hoc discussions.
13+
- **[GitHub Discussions](https://github.com/modelcontextprotocol/modelcontextprotocol/discussions)**: For structured, longer-form discussions.
14+
- **[GitHub Issues](https://github.com/modelcontextprotocol/modelcontextprotocol/issues)**: For actionable tasks, bug reports, and feature requests.
15+
- **For security-sensitive issues**: Follow the process in [SECURITY.md](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/SECURITY.md).
16+
17+
All communication is governed by our [Code of Conduct](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/CODE_OF_CONDUCT.md). We expect all participants to maintain respectful, professional, and inclusive interactions across all channels.
1318

1419
### Discord
1520

docs/development/contributing.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Contributing
33
description: How to participate in Model Context Protocol development
44
---
55

6-
We welcome contributions from the community! Please review our [contributing guidelines](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/CONTRIBUTING.md) for details on how to submit changes.
6+
{/* NB: hidden from docs, deprecated page */}
77

8-
All contributors must adhere to our [Code of Conduct](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/CODE_OF_CONDUCT.md).
9-
10-
For questions and discussions, please use [GitHub Discussions](https://github.com/modelcontextprotocol/modelcontextprotocol/discussions).
8+
We welcome contributions from the community! Most repositories should have a README.md or CONTRIBUTING.md file with instructions for how to get started.

docs/docs.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -277,11 +277,10 @@
277277
{
278278
"tab": "Community",
279279
"pages": [
280+
"community/communication",
280281
"community/governance",
281282
"community/sep-guidelines",
282-
"community/communication",
283283
"development/roadmap",
284-
"development/contributing",
285284
"clients",
286285
"examples"
287286
]

0 commit comments

Comments
 (0)