Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
114 lines (79 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

114 lines (79 loc) · 3.08 KB

Contributing to Model Context Protocol

Thank you for your interest in contributing to the Model Context Protocol specification! This document outlines how to contribute to this project.

Prerequisites

The following software is required to work on the spec:

  • Node.js 20 or above
  • TypeScript
  • TypeScript JSON Schema (for generating JSON schema)
  • Mintlify (optional, for docs)
  • nvm (optional, for managing Node versions)

Getting Started

  1. Fork the repository
  2. Clone your fork:
git clone https://github.com/YOUR-USERNAME/modelcontextprotocol.git
cd modelcontextprotocol
  1. Install dependencies:
nvm install  # install correct Node version
npm install  # install dependencies

Making Changes

Note that schema changes are made to schema.ts. schema.json is generated from schema.ts using npm run validate:schema.

  1. Create a new branch:
git checkout -b feature/your-feature-name
  1. Make your changes
  2. Validate your changes:
npm run validate:schema    # validate schema
npm run generate:json     # generate JSON schema
  1. Run docs locally (optional):
npm run serve:docs

Documentation Guidelines

When contributing to the documentation:

  • 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
  • Use appropriate headings: "When to use", "Steps", and "Tips" for tutorials
  • Place new pages in appropriate sections (concepts, tutorials, etc.)
  • Update docs.json when adding new pages
  • Follow existing file naming conventions (kebab-case.mdx)
  • Include proper frontmatter in MDX files

Specification Proposal Guidelines

Principles of MCP

  1. Simple + Minimal: It is much easier to add things to a specification than it is to remove them. To maintain simplicity, we keep a high bar for adding new concepts and primitives as each addition requires maintenance and compatibility consideration.
  2. Concrete: Specification changes need to be based on specific implementation challenges and not on speculative ideas.

Stages of a specification proposal

  1. Define: Explore the problem space, validate that other MCP users face a similar issue, and then clearly define the problem.
  2. Prototype: Build an example solution to the problem and demonstrate its practical application.
  3. Write: Based on the prototype, write a specification proposal.

Submitting Changes

  1. Push your changes to your fork
  2. Submit a pull request to the main repository
  3. Follow the pull request template
  4. Wait for review

Code of Conduct

This project follows a Code of Conduct. Please review it in CODE_OF_CONDUCT.md.

Questions

If you have questions, please create an issue in the repository.

License

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

Security

Please review our Security Policy for reporting security issues.