Skip to content

Commit 6cac5a1

Browse files
committed
more grammar
1 parent b8d4375 commit 6cac5a1

File tree

6 files changed

+24
-33
lines changed

6 files changed

+24
-33
lines changed

docs/concepts/architecture.mdx

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Core Architecture"
2+
title: "Core architecture"
33
description: "Understand how MCP connects clients, servers, and LLMs"
44
---
55

@@ -27,7 +27,7 @@ flowchart LR
2727

2828
## Core components
2929

30-
### Protocol Layer
30+
### Protocol layer
3131

3232
The protocol layer handles message framing, request/response linking, and high-level communication patterns. Key classes include:
3333

@@ -51,7 +51,7 @@ class Protocol<SendRequestT, SendNotificationT, SendResultT> {
5151

5252
The transport layer handles the actual communication between clients and servers. MCP supports multiple transport mechanisms:
5353

54-
1. **stdio Transport**
54+
1. **Stdio transport**
5555
- Uses standard input/output for communication
5656
- Ideal for local processes
5757
```typescript
@@ -61,7 +61,7 @@ The transport layer handles the actual communication between clients and servers
6161
}
6262
```
6363

64-
2. **WebSocket Transport**
64+
2. **WebSocket transport**
6565
- Enables real-time bidirectional communication
6666
- Supports remote connections
6767
```typescript
@@ -71,7 +71,7 @@ The transport layer handles the actual communication between clients and servers
7171
}
7272
```
7373

74-
3. **SSE Transport**
74+
3. **SSE transport**
7575
- Uses Server-Sent Events for server-to-client messages
7676
- HTTP POST for client-to-server messages
7777
```typescript
@@ -136,7 +136,7 @@ sequenceDiagram
136136
3. Client sends `initialized` notification
137137
4. Normal message exchange begins
138138

139-
### 2. Message Exchange
139+
### 2. Message exchange
140140

141141
After initialization, the following patterns are supported:
142142

@@ -206,54 +206,54 @@ await server.connect(transport);
206206

207207
### Transport selection
208208

209-
1. **Local Communication**
209+
1. **Local communication**
210210
- Use stdio transport for local processes
211211
- Efficient for same-machine communication
212212
- Simple process management
213213

214-
2. **Remote Communication**
214+
2. **Remote communication**
215215
- WebSocket for full-duplex communication
216216
- SSE for scenarios requiring HTTP compatibility
217217
- Consider security implications
218218

219-
### Message Handling
219+
### Message handling
220220

221-
1. **Request Processing**
221+
1. **Request processing**
222222
- Validate inputs thoroughly
223223
- Use type-safe schemas
224224
- Handle errors gracefully
225225
- Implement timeouts
226226

227-
2. **Progress Reporting**
227+
2. **Progress reporting**
228228
- Use progress tokens for long operations
229229
- Report progress incrementally
230230
- Include total progress when known
231231

232-
3. **Error Management**
232+
3. **Error management**
233233
- Use appropriate error codes
234234
- Include helpful error messages
235235
- Clean up resources on errors
236236

237237
## Security considerations
238238

239-
1. **Transport Security**
239+
1. **Transport security**
240240
- Use TLS for remote connections
241241
- Validate connection origins
242242
- Implement authentication when needed
243243

244-
2. **Message Validation**
244+
2. **Message validation**
245245
- Validate all incoming messages
246246
- Sanitize inputs
247247
- Check message size limits
248248
- Verify JSON-RPC format
249249

250-
3. **Resource Protection**
250+
3. **Resource protection**
251251
- Implement access controls
252252
- Validate resource paths
253253
- Monitor resource usage
254254
- Rate limit requests
255255

256-
4. **Error Handling**
256+
4. **Error handling**
257257
- Don't leak sensitive information
258258
- Log security-relevant errors
259259
- Implement proper cleanup
@@ -277,6 +277,4 @@ await server.connect(transport);
277277
- Test different transports
278278
- Verify error handling
279279
- Check edge cases
280-
- Load test servers
281-
282-
This architecture provides a robust foundation for building MCP integrations while maintaining flexibility for different use cases and deployment scenarios.
280+
- Load test servers

docs/concepts/prompts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ To use a prompt, clients make a `prompts/get` request:
9797

9898
Prompts can be dynamic and include:
9999

100-
### Context Integration
100+
### Context integration
101101

102102
```typescript
103103
const analyzeLogsPrompt = {

docs/concepts/resources.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The protocol and path structure is defined by the MCP server implementation. Ser
3838

3939
Resources can contain two types of content:
4040

41-
### Text Resources
41+
### Text resources
4242

4343
Text resources contain UTF-8 encoded text data. These are suitable for:
4444
- Source code

docs/concepts/sampling.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ When implementing sampling:
141141
9. Test with various model parameters
142142
10. Monitor sampling costs
143143

144-
## Human-in-the-loop controls
144+
## Human in the loop controls
145145

146146
Sampling is designed with human oversight in mind:
147147

docs/concepts/tools.mdx

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,6 @@ Each tool is defined with the following structure:
3131
}
3232
```
3333

34-
The `inputSchema` uses JSON Schema to define the expected parameters and their types. This enables:
35-
36-
- Parameter validation
37-
- Type checking
38-
- Documentation of required vs optional parameters
39-
- Complex nested parameter structures
40-
4134
## Implementing tools
4235

4336
Here's an example of implementing a basic tool in an MCP server:

docs/concepts/transport.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ const transport = new WebSocketClientTransport(
7373
await client.connect(transport);
7474
```
7575

76-
### Server-sent events (SSE)
76+
### Server-sent events
7777

7878
SSE transport enables server-to-client streaming with HTTP POST requests for client-to-server communication. This is useful when WebSocket support isn't available.
7979

@@ -256,21 +256,21 @@ Tips for debugging transport issues:
256256

257257
Choose the appropriate transport based on your needs:
258258

259-
### Use stdio when:
259+
### Use stdio when
260260

261261
- Building command-line tools
262262
- Implementing local integrations
263263
- Needing simple process communication
264264
- Working with shell scripts
265265

266-
### Use WebSocket when:
266+
### Use WebSocket when
267267

268268
- Real-time updates are needed
269269
- Low latency is required
270270
- Bidirectional communication is necessary
271271
- Working with web applications
272272

273-
### Use SSE when:
273+
### Use SSE when
274274

275275
- Only server-to-client streaming is needed
276276
- WebSocket support is limited

0 commit comments

Comments
 (0)