Skip to content

Commit d0dd637

Browse files
authored
Merge branch 'main' into patch-1
2 parents 3eced1b + 6a4dc0f commit d0dd637

34 files changed

+649
-280
lines changed

.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: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,7 @@ jobs:
2525
run: npm ci
2626

2727
- name: Check markdown formatting
28-
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: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,39 +33,34 @@ npm install # install dependencies
3333
## Making Changes
3434

3535
Note that schema changes are made to `schema.ts`, and `schema.json` is generated from
36-
`schema.ts`. You should validate your `schema.ts` changes first and then generate the
37-
`schema.json`.
36+
`schema.ts`.
3837

3938
1. Create a new branch:
4039

4140
```bash
4241
git checkout -b feature/your-feature-name
4342
```
4443

45-
2. Make your changes
46-
3. Validate your changes:
44+
2. Make your changes.
4745

48-
```bash
49-
npm run validate:schema # validate schema
50-
```
51-
52-
4. Generate the `schema.json`:
46+
3. Validate schema changes and generate `schema.json`:
5347

5448
```bash
55-
npm run generate:json # generate JSON schema
49+
npm run check:schema:ts
50+
npm run generate:json
5651
```
5752

58-
5. Run docs locally (optional):
53+
4. Validate documentation changes and apply formatting:
5954

6055
```bash
61-
npm run serve:docs
56+
npm run check:docs
57+
npm run format
6258
```
6359

64-
6. Format/lint your changes:
60+
5. Preview documentation locally (optional):
6561

6662
```bash
67-
npm run format:check # check formatting
68-
npm run format # apply formatting
63+
npm run serve:docs
6964
```
7065

7166
### Documentation Guidelines
@@ -77,7 +72,7 @@ When contributing to the documentation:
7772
- Include code examples where appropriate
7873
- Use proper MDX formatting and components
7974
- Test all links and code samples
80-
- You may run `npm run check-links` to look for broken internal links.
75+
- You may run `npm run check:docs:links` to look for broken internal links.
8176
- Use appropriate headings: "When to use", "Steps", and "Tips" for tutorials
8277
- Place new pages in appropriate sections (concepts, tutorials, etc.)
8378
- Update `docs.json` when adding new pages

docs/clients.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ This page provides an overview of applications that support the Model Context Pr
120120
[WhatsMPC]: https://wassist.app/mcp/
121121
[Witsy]: https://github.com/nbonamy/witsy
122122
[Zed]: https://zed.dev
123-
[Zencoder]: https://zecoder.ai
123+
[Zencoder]: https://zencoder.ai
124124
[Resources]: https://modelcontextprotocol.io/docs/concepts/resources
125125
[Prompts]: https://modelcontextprotocol.io/docs/concepts/prompts
126126
[Tools]: https://modelcontextprotocol.io/docs/concepts/tools

docs/docs/concepts/architecture.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ The transport layer handles the actual communication between clients and servers
108108
- Uses standard input/output for communication
109109
- Ideal for local processes
110110

111-
2. **HTTP with SSE transport**
112-
- Uses Server-Sent Events for server-to-client messages
111+
2. **Streamable HTTP transport**
112+
- Uses HTTP with optional Server-Sent Events for streaming
113113
- HTTP POST for client-to-server messages
114114

115115
All transports use [JSON-RPC](https://www.jsonrpc.org/) 2.0 to exchange messages. See the [specification](/specification/) for detailed information about the Model Context Protocol message format.
@@ -295,7 +295,7 @@ Here's a basic example of implementing an MCP server:
295295
- Simple process management
296296

297297
2. **Remote communication**
298-
- Use SSE for scenarios requiring HTTP compatibility
298+
- Use Streamable HTTP for scenarios requiring HTTP compatibility
299299
- Consider security implications including authentication and authorization
300300

301301
### Message handling

0 commit comments

Comments
 (0)