Skip to content

Commit 596ec6c

Browse files
committed
Merge remote-tracking branch 'upstream/main'
2 parents 67dc243 + 9ce0ffe commit 596ec6c

Some content is hidden

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

73 files changed

+3260
-1113
lines changed

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
package-lock.json linguist-generated=true
2+
schema/*/schema.json linguist-generated=true

.github/workflows/main.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ jobs:
1818

1919
- run: npm ci
2020

21-
- run: npm run validate:schema
21+
- name: Check TypeScript definitions
22+
run: npm run check:schema:ts
2223

23-
- run: npm run generate:json
2424
- name: Verify that `npm run generate:json` did not change outputs (if it did, please re-run it and re-commit!)
25-
run: git diff --exit-code
25+
run: npm run check:schema:json

.github/workflows/markdown-format.yml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,28 @@ on:
44
push:
55
paths:
66
- '**/*.md'
7+
- '**/*.mdx'
78
pull_request:
89
paths:
910
- '**/*.md'
11+
- '**/*.mdx'
1012

1113
jobs:
1214
format:
1315
runs-on: ubuntu-latest
1416
steps:
1517
- uses: actions/checkout@v4
16-
18+
1719
- name: Setup Node.js
1820
uses: actions/setup-node@v4
1921
with:
2022
node-version: '20'
21-
23+
2224
- name: Install dependencies
2325
run: npm ci
24-
26+
2527
- name: Check markdown formatting
26-
run: npm run format:check
28+
run: npm run check:docs:format
29+
30+
- name: Check markdown links
31+
run: npm run check:docs:links

CONTRIBUTING.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,32 @@ npm install # install dependencies
3232

3333
## Making Changes
3434

35-
Note that schema changes are made to `schema.ts`. `schema.json` is generated from
36-
`schema.ts` using `npm run validate:schema`.
35+
Note that schema changes are made to `schema.ts`, and `schema.json` is generated from
36+
`schema.ts`.
3737

3838
1. Create a new branch:
3939

4040
```bash
4141
git checkout -b feature/your-feature-name
4242
```
4343

44-
2. Make your changes
45-
3. Validate your changes:
44+
2. Make your changes.
45+
46+
3. Validate schema changes and generate `schema.json`:
47+
48+
```bash
49+
npm run check:schema:ts
50+
npm run generate:json
51+
```
52+
53+
4. Validate documentation changes and apply formatting:
4654

4755
```bash
48-
npm run validate:schema # validate schema
49-
npm run generate:json # generate JSON schema
56+
npm run check:docs
57+
npm run format
5058
```
5159

52-
4. Run docs locally (optional):
60+
5. Preview documentation locally (optional):
5361

5462
```bash
5563
npm run serve:docs
@@ -64,10 +72,11 @@ When contributing to the documentation:
6472
- Include code examples where appropriate
6573
- Use proper MDX formatting and components
6674
- Test all links and code samples
75+
- You may run `npm run check:docs:links` to look for broken internal links.
6776
- Use appropriate headings: "When to use", "Steps", and "Tips" for tutorials
6877
- Place new pages in appropriate sections (concepts, tutorials, etc.)
69-
- Update docs.json when adding new pages
70-
- Follow existing file naming conventions (kebab-case.mdx)
78+
- Update `docs.json` when adding new pages
79+
- Follow existing file naming conventions (`kebab-case.mdx`)
7180
- Include proper frontmatter in MDX files
7281

7382
### Specification Proposal Guidelines

docs/clients.mdx

Lines changed: 248 additions & 72 deletions
Large diffs are not rendered by default.

docs/development/roadmap.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ description: Our plans for evolving Model Context Protocol
77

88
The Model Context Protocol is rapidly evolving. This page outlines our current thinking on key priorities and direction for approximately **the next six months**, though these may change significantly as the project develops. To see what's changed recently, check out the **[specification changelog](/specification/2025-03-26/changelog/)**.
99

10-
<Note>The ideas presented here are not commitments—we may solve these challenges differently than described, or some may not materialize at all. This is also not an _exhaustive_ list; we may incorporate work that isn't mentioned here.</Note>
10+
<Note>
11+
12+
The ideas presented here are not commitments—we may solve these challenges differently than described, or some may not materialize at all. This is also not an _exhaustive_ list; we may incorporate work that isn't mentioned here.
13+
14+
</Note>
1115

1216
We value community participation! Each section links to relevant discussions where you can learn more and contribute your thoughts.
1317

docs/development/updates.mdx

Lines changed: 0 additions & 65 deletions
This file was deleted.

docs/docs.json

Lines changed: 21 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -53,27 +53,12 @@
5353
{
5454
"group": "Development",
5555
"pages": [
56-
"development/updates",
5756
"development/roadmap",
5857
"development/contributing"
5958
]
6059
}
6160
]
62-
},
63-
{
64-
"tab": "SDKs",
65-
"icon": "book-open",
66-
"groups": [
67-
{
68-
"group": "Java",
69-
"pages": [
70-
"sdk/java/mcp-overview",
71-
"sdk/java/mcp-client",
72-
"sdk/java/mcp-server"
73-
]
74-
}
75-
]
76-
},
61+
},
7762
{
7863
"tab": "Specification",
7964
"icon": "book",
@@ -203,7 +188,8 @@
203188
"group": "Client Features",
204189
"pages": [
205190
"specification/draft/client/roots",
206-
"specification/draft/client/sampling"
191+
"specification/draft/client/sampling",
192+
"specification/draft/client/elicitation"
207193
]
208194
},
209195
{
@@ -227,25 +213,17 @@
227213
},
228214
{
229215
"group": "Resources",
230-
"pages": [
231-
"specification/versioning",
232-
"specification/contributing"
233-
]
216+
"pages": ["specification/versioning", "specification/contributing"]
234217
}
235218
]
236219
}
237220
],
238221
"global": {
239222
"anchors": [
240223
{
241-
"anchor": "Python SDK",
242-
"href": "https://github.com/modelcontextprotocol/python-sdk",
243-
"icon": "python"
244-
},
245-
{
246-
"anchor": "TypeScript SDK",
247-
"href": "https://github.com/modelcontextprotocol/typescript-sdk",
248-
"icon": "square-js"
224+
"anchor": "C# SDK",
225+
"href": "https://github.com/modelcontextprotocol/csharp-sdk",
226+
"icon": "square-c"
249227
},
250228
{
251229
"anchor": "Java SDK",
@@ -258,14 +236,24 @@
258236
"icon": "square-k"
259237
},
260238
{
261-
"anchor": "C# SDK",
262-
"href": "https://github.com/modelcontextprotocol/csharp-sdk",
263-
"icon": "square-c"
239+
"anchor": "Python SDK",
240+
"href": "https://github.com/modelcontextprotocol/python-sdk",
241+
"icon": "python"
242+
},
243+
{
244+
"anchor": "Ruby SDK",
245+
"href": "https://github.com/modelcontextprotocol/ruby-sdk",
246+
"icon": "gem"
264247
},
265248
{
266249
"anchor": "Swift SDK",
267250
"href": "https://github.com/modelcontextprotocol/swift-sdk",
268251
"icon": "swift"
252+
},
253+
{
254+
"anchor": "TypeScript SDK",
255+
"href": "https://github.com/modelcontextprotocol/typescript-sdk",
256+
"icon": "square-js"
269257
}
270258
]
271259
}
@@ -309,9 +297,6 @@
309297
}
310298
],
311299
"contextual": {
312-
"options": [
313-
"copy",
314-
"view"
315-
]
300+
"options": ["copy", "view"]
316301
}
317302
}

0 commit comments

Comments
 (0)