Add 'packages/mcp-spec/' from commit 'd06853c5e8'

git-subtree-dir: packages/mcp-spec
git-subtree-mainline: 02e421c1f1
git-subtree-split: d06853c5e8
This commit is contained in:
David Soria Parra 2024-09-24 21:56:32 +01:00
commit 929275eddf
No known key found for this signature in database

37
packages/mcp-spec/README.md generated Normal file
View file

@ -0,0 +1,37 @@
# Model Context Protocol spec
This repo contains the specification and protocol schema for the Model Context Protocol.
The schema is [defined in TypeScript](schema/schema.ts) first, but [made available as JSON Schema](schema/schema.json) as well, for wider compatibility.
## Prequisites
The following software is required to work on the spec:
* Typescript
* Node.JS 20 or above
* Yarn
* Typescript JSON Schema (for generating json schema)
* Hugo (optionally, for serving the documentation)
* Go (optionall, for serving the documentation)
* nvm (optionally, for managing node versions)
## Validating and building the spec
The following commands install the dependencies, validate the schema and generate the json schema.
```bash
$ nvn install # install the correct node version
$ yarn install # install dependencies
$ yarn validate:schema # validate the schema
$ yarn validate:examples # validate the examples
$ yarn generate:json # generate the json schema
```
## Serving the documentation
The documentation lives in the `docs` folder. To serve the documentation, run the following commands:
```bash
$ yarn serve:docs # serve the documentation
```
Note that this reqires Hugo and Go to be installed.