Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

73 lines (52 loc) · 1.71 KB
Raw

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)
  • Hugo (optional, for docs)
  • Go (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/specification.git
cd specification
  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

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.