Contributing to MCP Documentation

Thank you for your interest in contributing to the Model Context Protocol (MCP) documentation! This guide will help you get started with contributing.

Getting Started

Install the required tools:
- Node.js
- Git
- Mintlify CLI: npm i -g mintlify
Fork and clone the repository
Create a new branch for your changes
Run mintlify dev to preview changes locally

Signing Your Commits

We require all commits to be signed to verify the identity of contributors. Here's how to set up commit signing:

Generate a GPG key if you don't have one:
```
gpg --full-generate-key
```
- Choose RSA and RSA (default)
- Choose 4096 bits
- Enter your name and email (must match GitHub email)

Get your GPG key ID:

gpg --list-secret-keys --keyid-format=long

Configure Git to use your GPG key:

git config --global user.signingkey YOUR_KEY_ID
git config --global commit.gpgsign true

Add your GPG key to GitHub:
- Copy your GPG key: gpg --armor --export YOUR_KEY_ID
- Go to GitHub Settings > SSH and GPG keys
- Click "New GPG key" and paste your key
For each commit, use:
```
git commit -S -m "Your commit message"
```
The -S flag signs your commit. With commit.gpgsign configured, you can omit the -S flag.

Note: On Windows, you might need to download GPG4Win and configure its path in Git.

You can learn more about signed commits here.

Documentation Guidelines

Keep content clear, concise, and technically accurate
Follow the existing file structure and naming conventions
Include code examples where appropriate
Use proper MDX formatting and components
Test all links and code samples

Content Types

You can contribute to:

Conceptual guides
API reference documentation
Tutorials and quickstarts
Best practices and examples
Troubleshooting guides

Pull Request Process

Ensure your changes follow our documentation guidelines
Update the relevant table of contents if needed
Test your changes locally using mintlify dev
Submit a pull request with a clear description of your changes
Wait for review and address any feedback

Need Help?

Check existing documentation at modelcontextprotocol.io
Open an issue for bugs or concerns
Join our community discussions

Code of Conduct

Please note that this project follows our Code of Conduct. By participating, you agree to uphold these guidelines.

2.8 KiB Raw Blame History