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

Merge pull request #1 from modelcontextprotocol/zack-lee/quickstart

Browse source 
Creating quickstarts and initial doc structure
This commit is contained in:
Zachary Lee 2024-11-18 09:13:02 -05:00 • committed by GitHub
commit 40ecf96a43
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
48 changed files with 4864 additions and 1281 deletions
Download patch file Download diff file Expand all files Collapse all files

1
.prettierignore Normal file
View file

@ -0,0 +1 @@
*.mdx

12
README.md
View file

@ -1,12 +1,6 @@
# Mintlify Starter Kit
# Model Context Protocol Documentation
Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including
- Guide pages
- Navigation
- Customizations
- API Reference pages
- Use of popular components
The official docs of MCP. This README is a WIP.
### Development
@ -24,7 +18,7 @@ mintlify dev
### 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.
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

8
api-reference/client-api/connection-management.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: "Connection Management"
description: "Manage MCP client connections"
---
# Connection Management
Manage MCP client connections

8
api-reference/client-api/resource-consumption.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: "Resource Consumption"
description: "Work with MCP resources from clients"
---
# Resource Consumption
Work with MCP resources from clients

8
api-reference/client-api/tool-invocation.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: "Tool Invocation"
description: "Invoke MCP tools from clients"
---
# Tool Invocation
Invoke MCP tools from clients

4
api-reference/endpoint/create.mdx
View file

@ -1,4 +0,0 @@
---
title: 'Create Plant'
openapi: 'POST /plants'
---

4
api-reference/endpoint/delete.mdx
View file

@ -1,4 +0,0 @@
---
title: 'Delete Plant'
openapi: 'DELETE /plants/{id}'
---

4
api-reference/endpoint/get.mdx
View file

@ -1,4 +0,0 @@
---
title: 'Get Plants'
openapi: 'GET /plants'
---

8
api-reference/error-handling.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: "Error Handling"
description: "Handle errors in MCP implementations"
---
# Error Handling
Handle errors in MCP implementations

33
api-reference/introduction.mdx
View file

@ -1,33 +0,0 @@
---
title: 'Introduction'
description: 'Example section for showcasing API endpoints'
---
<Note>
If you're not looking to build API reference documentation, you can delete
this section by removing the api-reference folder.
</Note>
## Welcome
There are two ways to build API documentation: [OpenAPI](https://mintlify.com/docs/api-playground/openapi/setup) and [MDX components](https://mintlify.com/docs/api-playground/mdx/configuration). For the starter kit, we are using the following OpenAPI specification.
<Card
title="Plant Store Endpoints"
icon="leaf"
href="https://github.com/mintlify/starter/blob/main/api-reference/openapi.json"
>
View the OpenAPI specification file
</Card>
## Authentication
All API endpoints are authenticated using Bearer tokens and picked up from the specification file.
```json
"security": [
{
"bearerAuth": []
}
]
```

8
api-reference/message-types.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: "Message Types"
description: "Complete reference of MCP message formats"
---
# Message Types
Complete reference of MCP message formats

195
api-reference/openapi.json
View file

@ -1,195 +0,0 @@
{
"openapi": "3.0.1",
"info": {
"title": "OpenAPI Plant Store",
"description": "A sample API that uses a plant store as an example to demonstrate features in the OpenAPI specification",
"license": {
"name": "MIT"
},
"version": "1.0.0"
},
"servers": [
{
"url": "http://sandbox.mintlify.com"
}
],
"security": [
{
"bearerAuth": []
}
],
"paths": {
"/plants": {
"get": {
"description": "Returns all plants from the system that the user has access to",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "The maximum number of results to return",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Plant response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Plant"
}
}
}
}
},
"400": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"description": "Creates a new plant in the store",
"requestBody": {
"description": "Plant to add to the store",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewPlant"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "plant response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Plant"
}
}
}
},
"400": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/plants/{id}": {
"delete": {
"description": "Deletes a single plant based on the ID supplied",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of plant to delete",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "Plant deleted",
"content": {}
},
"400": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Plant": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"description": "The name of the plant",
"type": "string"
},
"tag": {
"description": "Tag to specify the type",
"type": "string"
}
}
},
"NewPlant": {
"allOf": [
{
"$ref": "#/components/schemas/Plant"
},
{
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"description": "Identification number of the plant",
"type": "integer",
"format": "int64"
}
}
}
]
},
"Error": {
"required": [
"error",
"message"
],
"type": "object",
"properties": {
"error": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
}
}
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer"
}
}
}
}

8
api-reference/protocol-overview.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: "Protocol Overview"
description: "Understanding the Model Context Protocol"
---
# Protocol Overview
Understanding the Model Context Protocol

8
api-reference/python/class-reference.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: "Python Class Reference"
description: "Complete Python SDK class documentation"
---
# Python Class Reference
Complete Python SDK class documentation

8
api-reference/python/examples.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: "Python Examples"
description: "Example Python implementations"
---
# Python Examples
Example Python implementations

8
api-reference/python/type-hints.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: "Python Type Hints"
description: "Python type system documentation"
---
# Python Type Hints
Python type system documentation

8
api-reference/server-api/event-handling.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: "Event Handling"
description: "Handle events in your MCP server"
---
# Event Handling
Handle events in your MCP server

8
api-reference/server-api/resource-management.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: "Resource Management"
description: "Manage resources in your MCP server"
---
# Resource Management
Manage resources in your MCP server

8
api-reference/server-api/tool-implementation.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: "Tool Implementation"
description: "Implement tools in your MCP server"
---
# Tool Implementation
Implement tools in your MCP server

8
api-reference/typescript/class-reference.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: "TypeScript Class Reference"
description: "Complete TypeScript SDK class documentation"
---
# TypeScript Class Reference
Complete TypeScript SDK class documentation

Some files were not shown because too many files have changed in this diff Show more