modelcontextprotocol/docs
Watch
1
0
Fork
You've already forked docs
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Justin Spahr-Summers 2024-11-20 15:37:09 +00:00
commit 3b0f2f2003
No known key found for this signature in database
1 changed files with 3 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -1,26 +1,9 @@
# Model Context Protocol Documentation
The official docs of MCP. This README is a WIP.
The official documentation for the [Model Context Protocol](https://modelcontextprotocol.io).
### Development
Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
```
npm i -g mintlify
```
Run the following command at the root of your documentation (where mint.json is)
```
mintlify dev
```
For detailed contribution guidelines, development setup, and troubleshooting, please see our [Contributing Guide](CONTRIBUTING.md).
### Publishing Changes
Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.
#### Troubleshooting
- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`
Changes will be deployed to production automatically after pushing to the default branch.