Skip to content

Commit 6ea35ee

Browse files
committed
Merge remote-tracking branch 'upstream/main'
* upstream/main: docs: update README links chore: add markdown format check workflow and format all docs chore: add prettier and format command for markdown files Move schema files to versioned directory Fix broken links. 2024-11-05 schema.ts/schema.json points to main/schema/2024-11-05/schema.ts in anticipation of PR modelcontextprotocol#145 being merged. update generate json after merge update protocol revision to draft on sampling page updated schema protocol version to reflect draft. change to relative link in spec point documentation changes to "draft" Revert schema/schema.ts to upstream/main, add drafts folder. Update validate and build scripts to build drafts too. fix: update draft page reference and add alias for better navigation fix: incorrect link for "Specification (Draft)" on nav bar Update schema/schema.ts remove spurious semicolon validation, simplify wording. Add optional "size" attribute to Resource, include in Documentation Update docs/specification/client/sampling.md Updated Specification and Docs to support Audio Modality.
2 parents 11f0d6c + 363e36b commit 6ea35ee

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+4832
-764
lines changed

.github/workflows/markdown-format.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Markdown Format Check
2+
3+
on:
4+
push:
5+
paths:
6+
- '**/*.md'
7+
pull_request:
8+
paths:
9+
- '**/*.md'
10+
11+
jobs:
12+
format:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
17+
- name: Setup Node.js
18+
uses: actions/setup-node@v4
19+
with:
20+
node-version: '20'
21+
22+
- name: Install dependencies
23+
run: npm ci
24+
25+
- name: Check markdown formatting
26+
run: npm run format:check

CODE_OF_CONDUCT.md

Lines changed: 64 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -2,124 +2,115 @@
22

33
## Our Pledge
44

5-
We as members, contributors, and leaders pledge to make participation in our
6-
community a harassment-free experience for everyone, regardless of age, body
7-
size, visible or invisible disability, ethnicity, sex characteristics, gender
8-
identity and expression, level of experience, education, socio-economic status,
9-
nationality, personal appearance, race, religion, or sexual identity
10-
and orientation.
5+
We as members, contributors, and leaders pledge to make participation in our community a
6+
harassment-free experience for everyone, regardless of age, body size, visible or
7+
invisible disability, ethnicity, sex characteristics, gender identity and expression,
8+
level of experience, education, socio-economic status, nationality, personal appearance,
9+
race, religion, or sexual identity and orientation.
1110

12-
We pledge to act and interact in ways that contribute to an open, welcoming,
13-
diverse, inclusive, and healthy community.
11+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse,
12+
inclusive, and healthy community.
1413

1514
## Our Standards
1615

17-
Examples of behavior that contributes to a positive environment for our
18-
community include:
16+
Examples of behavior that contributes to a positive environment for our community
17+
include:
1918

20-
* Demonstrating empathy and kindness toward other people
21-
* Being respectful of differing opinions, viewpoints, and experiences
22-
* Giving and gracefully accepting constructive feedback
23-
* Accepting responsibility and apologizing to those affected by our mistakes,
24-
and learning from the experience
25-
* Focusing on what is best not just for us as individuals, but for the
26-
overall community
19+
- Demonstrating empathy and kindness toward other people
20+
- Being respectful of differing opinions, viewpoints, and experiences
21+
- Giving and gracefully accepting constructive feedback
22+
- Accepting responsibility and apologizing to those affected by our mistakes, and
23+
learning from the experience
24+
- Focusing on what is best not just for us as individuals, but for the overall community
2725

2826
Examples of unacceptable behavior include:
2927

30-
* The use of sexualized language or imagery, and sexual attention or
31-
advances of any kind
32-
* Trolling, insulting or derogatory comments, and personal or political attacks
33-
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email
35-
address, without their explicit permission
36-
* Other conduct which could reasonably be considered inappropriate in a
37-
professional setting
28+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
29+
- Trolling, insulting or derogatory comments, and personal or political attacks
30+
- Public or private harassment
31+
- Publishing others' private information, such as a physical or email address, without
32+
their explicit permission
33+
- Other conduct which could reasonably be considered inappropriate in a professional
34+
setting
3835

3936
## Enforcement Responsibilities
4037

4138
Community leaders are responsible for clarifying and enforcing our standards of
42-
acceptable behavior and will take appropriate and fair corrective action in
43-
response to any behavior that they deem inappropriate, threatening, offensive,
44-
or harmful.
39+
acceptable behavior and will take appropriate and fair corrective action in response to
40+
any behavior that they deem inappropriate, threatening, offensive, or harmful.
4541

46-
Community leaders have the right and responsibility to remove, edit, or reject
47-
comments, commits, code, wiki edits, issues, and other contributions that are
48-
not aligned to this Code of Conduct, and will communicate reasons for moderation
49-
decisions when appropriate.
42+
Community leaders have the right and responsibility to remove, edit, or reject comments,
43+
commits, code, wiki edits, issues, and other contributions that are not aligned to this
44+
Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
5045

5146
## Scope
5247

53-
This Code of Conduct applies within all community spaces, and also applies when
54-
an individual is officially representing the community in public spaces.
55-
Examples of representing our community include using an official e-mail address,
56-
posting via an official social media account, or acting as an appointed
57-
representative at an online or offline event.
48+
This Code of Conduct applies within all community spaces, and also applies when an
49+
individual is officially representing the community in public spaces. Examples of
50+
representing our community include using an official e-mail address, posting via an
51+
official social media account, or acting as an appointed representative at an online or
52+
offline event.
5853

5954
## Enforcement
6055

61-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement at
63-
64-
All complaints will be reviewed and investigated promptly and fairly.
56+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to
57+
the community leaders responsible for enforcement at [email protected]. All
58+
complaints will be reviewed and investigated promptly and fairly.
6559

66-
All community leaders are obligated to respect the privacy and security of the
67-
reporter of any incident.
60+
All community leaders are obligated to respect the privacy and security of the reporter
61+
of any incident.
6862

6963
## Enforcement Guidelines
7064

71-
Community leaders will follow these Community Impact Guidelines in determining
72-
the consequences for any action they deem in violation of this Code of Conduct:
65+
Community leaders will follow these Community Impact Guidelines in determining the
66+
consequences for any action they deem in violation of this Code of Conduct:
7367

7468
### 1. Correction
7569

7670
**Community Impact**: Use of inappropriate language or other behavior deemed
7771
unprofessional or unwelcome in the community.
7872

79-
**Consequence**: A private, written warning from community leaders, providing
80-
clarity around the nature of the violation and an explanation of why the
81-
behavior was inappropriate. A public apology may be requested.
73+
**Consequence**: A private, written warning from community leaders, providing clarity
74+
around the nature of the violation and an explanation of why the behavior was
75+
inappropriate. A public apology may be requested.
8276

8377
### 2. Warning
8478

85-
**Community Impact**: A violation through a single incident or series
86-
of actions.
79+
**Community Impact**: A violation through a single incident or series of actions.
8780

88-
**Consequence**: A warning with consequences for continued behavior. No
89-
interaction with the people involved, including unsolicited interaction with
90-
those enforcing the Code of Conduct, for a specified period of time. This
91-
includes avoiding interactions in community spaces as well as external channels
92-
like social media. Violating these terms may lead to a temporary or
93-
permanent ban.
81+
**Consequence**: A warning with consequences for continued behavior. No interaction with
82+
the people involved, including unsolicited interaction with those enforcing the Code of
83+
Conduct, for a specified period of time. This includes avoiding interactions in community
84+
spaces as well as external channels like social media. Violating these terms may lead to
85+
a temporary or permanent ban.
9486

9587
### 3. Temporary Ban
9688

97-
**Community Impact**: A serious violation of community standards, including
98-
sustained inappropriate behavior.
89+
**Community Impact**: A serious violation of community standards, including sustained
90+
inappropriate behavior.
9991

100-
**Consequence**: A temporary ban from any sort of interaction or public
101-
communication with the community for a specified period of time. No public or
102-
private interaction with the people involved, including unsolicited interaction
103-
with those enforcing the Code of Conduct, is allowed during this period.
104-
Violating these terms may lead to a permanent ban.
92+
**Consequence**: A temporary ban from any sort of interaction or public communication
93+
with the community for a specified period of time. No public or private interaction with
94+
the people involved, including unsolicited interaction with those enforcing the Code of
95+
Conduct, is allowed during this period. Violating these terms may lead to a permanent
96+
ban.
10597

10698
### 4. Permanent Ban
10799

108-
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
110-
individual, or aggression toward or disparagement of classes of individuals.
100+
**Community Impact**: Demonstrating a pattern of violation of community standards,
101+
including sustained inappropriate behavior, harassment of an individual, or aggression
102+
toward or disparagement of classes of individuals.
111103

112-
**Consequence**: A permanent ban from any sort of public interaction within
113-
the community.
104+
**Consequence**: A permanent ban from any sort of public interaction within the
105+
community.
114106

115107
## Attribution
116108

117-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118-
version 2.0, available at
119-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
109+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
110+
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120111

121-
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122-
enforcement ladder](https://github.com/mozilla/diversity).
112+
Community Impact Guidelines were inspired by
113+
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
123114

124115
[homepage]: https://www.contributor-covenant.org
125116

CONTRIBUTING.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Contributing to Model Context Protocol
22

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

56
## Prerequisites
67

@@ -17,34 +18,40 @@ The following software is required to work on the spec:
1718

1819
1. Fork the repository
1920
2. Clone your fork:
21+
2022
```bash
2123
git clone https://github.com/YOUR-USERNAME/specification.git
2224
cd specification
2325
```
2426

2527
3. Install dependencies:
28+
2629
```bash
2730
nvm install # install correct Node version
2831
npm install # install dependencies
2932
```
3033

3134
## Making Changes
32-
Note that schema changes are made to `schema.ts`. `schema.json` is generated from `schema.ts`
33-
using `npm run validate:schema`.
35+
36+
Note that schema changes are made to `schema.ts`. `schema.json` is generated from
37+
`schema.ts` using `npm run validate:schema`.
3438

3539
1. Create a new branch:
40+
3641
```bash
3742
git checkout -b feature/your-feature-name
3843
```
3944

4045
2. Make your changes
4146
3. Validate your changes:
47+
4248
```bash
4349
npm run validate:schema # validate schema
4450
npm run generate:json # generate JSON schema
4551
```
4652

4753
4. Run docs locally (optional):
54+
4855
```bash
4956
npm run serve:docs
5057
```
@@ -58,15 +65,17 @@ npm run serve:docs
5865

5966
## Code of Conduct
6067

61-
This project follows a Code of Conduct. Please review it in [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
68+
This project follows a Code of Conduct. Please review it in
69+
[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
6270

6371
## Questions
6472

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

6775
## License
6876

69-
By contributing, you agree that your contributions will be licensed under the MIT License.
77+
By contributing, you agree that your contributions will be licensed under the MIT
78+
License.
7079

7180
## Security
7281

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,15 @@
22

33
This repo contains the specification and protocol schema for the Model Context Protocol.
44

5-
The schema is [defined in TypeScript](schema/schema.ts) first, but [made available as JSON Schema](schema/schema.json) as well, for wider compatibility.
5+
The schema is [defined in TypeScript](schema/2024-11-05/schema.ts) first, but
6+
[made available as JSON Schema](schema/2024-11-05/schema.json) as well, for wider compatibility.
67

78
## Contributing
89

9-
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this project.
10+
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this
11+
project.
1012

1113
## License
1214

13-
This project is licensed under the MIT License—see the [LICENSE](LICENSE) file for details.
15+
This project is licensed under the MIT License—see the [LICENSE](LICENSE) file for
16+
details.

SECURITY.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
# Security Policy
2+
23
Thank you for helping us keep the SDKs and systems they interact with secure.
34

45
## Reporting Security Issues
56

6-
This SDK is maintained by [Anthropic](https://www.anthropic.com/) as part of the Model Context Protocol project.
7+
This SDK is maintained by [Anthropic](https://www.anthropic.com/) as part of the Model
8+
Context Protocol project.
79

8-
The security of our systems and user data is Anthropic’s top priority. We appreciate the work of security researchers acting in good faith in identifying and reporting potential vulnerabilities.
10+
The security of our systems and user data is Anthropic’s top priority. We appreciate the
11+
work of security researchers acting in good faith in identifying and reporting potential
12+
vulnerabilities.
913

10-
Our security program is managed on HackerOne and we ask that any validated vulnerability in this functionality be reported through their [submission form](https://hackerone.com/anthropic-vdp/reports/new?type=team&report_type=vulnerability).
14+
Our security program is managed on HackerOne and we ask that any validated vulnerability
15+
in this functionality be reported through their
16+
[submission form](https://hackerone.com/anthropic-vdp/reports/new?type=team&report_type=vulnerability).
1117

1218
## Vulnerability Disclosure Program
1319

14-
Our Vulnerability Program Guidelines are defined on our [HackerOne program page](https://hackerone.com/anthropic-vdp).
20+
Our Vulnerability Program Guidelines are defined on our
21+
[HackerOne program page](https://hackerone.com/anthropic-vdp).

docs/resources/_index.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,23 @@ sidebar:
66
exclude: true
77
---
88

9-
The Model Context Protocol (MCP) provides multiple resources for documentation and implementation:
9+
The Model Context Protocol (MCP) provides multiple resources for documentation and
10+
implementation:
1011

11-
- **User Documentation**: Visit [modelcontextprotocol.io](https://modelcontextprotocol.io) for comprehensive user-facing documentation
12-
- **Python SDK**: The Python implementation is available at [github.com/modelcontextprotocol/python-sdk](https://github.com/modelcontextprotocol/python-sdk) - [Discussions](https://github.com/modelcontextprotocol/python-sdk/discussions)
13-
- **Specification**: The core specification is available at [github.com/modelcontextprotocol/specification](https://github.com/modelcontextprotocol/specification) - [Discussions](https://github.com/modelcontextprotocol/specification/discussions)
14-
- **TypeScript SDK**: The TypeScript implementation can be found at [github.com/modelcontextprotocol/typescript-sdk](https://github.com/modelcontextprotocol/typescript-sdk) - [Discussions](https://github.com/modelcontextprotocol/typescript-sdk/discussions)
12+
- **User Documentation**: Visit
13+
[modelcontextprotocol.io](https://modelcontextprotocol.io) for comprehensive
14+
user-facing documentation
15+
- **Python SDK**: The Python implementation is available at
16+
[github.com/modelcontextprotocol/python-sdk](https://github.com/modelcontextprotocol/python-sdk) -
17+
[Issues](https://github.com/modelcontextprotocol/python-sdk/issues)
18+
- **Specification**: The core specification is available at
19+
[github.com/modelcontextprotocol/specification](https://github.com/modelcontextprotocol/specification) -
20+
[Discussions](https://github.com/modelcontextprotocol/specification/discussions)
21+
- **TypeScript SDK**: The TypeScript implementation can be found at
22+
[github.com/modelcontextprotocol/typescript-sdk](https://github.com/modelcontextprotocol/typescript-sdk) -
23+
[Issues](https://github.com/modelcontextprotocol/typescript-sdk/issues)
1524

16-
For questions or discussions, please open a discussion in the appropriate GitHub repository based on your implementation or use case. You can also visit the [Model Context Protocol organization on GitHub](https://github.com/modelcontextprotocol) to see all repositories and ongoing development.
25+
For questions or discussions, please open a discussion in the appropriate GitHub
26+
repository based on your implementation or use case. You can also visit the
27+
[Model Context Protocol organization on GitHub](https://github.com/modelcontextprotocol)
28+
to see all repositories and ongoing development.

0 commit comments

Comments
 (0)