Skip to content

Commit da7e734

Browse files
committed
docs: add introductory paragraphs after all headings
Ensure every heading is followed by a paragraph before any code block, list, table, or other content. Also add this as a documentation guideline in CLAUDE.md.
1 parent 392bb35 commit da7e734

File tree

4 files changed

+19
-0
lines changed

4 files changed

+19
-0
lines changed

CLAUDE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,11 @@ When making breaking changes, document them in `docs/migration.md`. Include:
6666
Search for related sections in the migration guide and group related changes together
6767
rather than adding new standalone sections.
6868

69+
## Documentation
70+
71+
- After a heading, always add an introductory paragraph before any code block, list, table, or
72+
other content. Never go directly from a heading to non-paragraph content.
73+
6974
## Python Tools
7075

7176
## Code Formatting

docs/concepts.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,8 @@ mcp = MCPServer("My App", lifespan=app_lifespan)
159159

160160
## Next steps
161161

162+
Continue learning about MCP:
163+
162164
- **[Quickstart](quickstart.md)** — build your first server
163165
- **[Testing](testing.md)** — test your server with the `Client` class
164166
- **[Authorization](authorization.md)** — securing your servers with OAuth 2.1

docs/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ This Python SDK implements the full MCP specification, making it easy to:
1111

1212
## Quick example
1313

14+
A minimal MCP server with a single tool:
15+
1416
```python
1517
from mcp.server.mcpserver import MCPServer
1618

@@ -31,12 +33,16 @@ uv run --with mcp server.py
3133

3234
## Getting started
3335

36+
Follow these steps to start building with MCP:
37+
3438
1. **[Install](installation.md)** the SDK
3539
2. **[Quickstart](quickstart.md)** — build your first MCP server
3640
3. **[Concepts](concepts.md)** — understand the protocol architecture and primitives
3741

3842
## Links
3943

44+
Useful references for working with MCP:
45+
4046
- [MCP specification](https://modelcontextprotocol.io)
4147
- [API Reference](api.md)
4248
- [Migration guide](migration.md) (v1 → v2)

docs/quickstart.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ if __name__ == "__main__":
5050

5151
## Run the server
5252

53+
Start the server with uv:
54+
5355
```bash
5456
uv run --with mcp server.py
5557
```
@@ -58,6 +60,8 @@ The server starts on `http://localhost:8000/mcp` using Streamable HTTP transport
5860

5961
## Connect a client
6062

63+
You can connect to your running server using any MCP client:
64+
6165
=== "Claude Code"
6266

6367
Add the server to [Claude Code](https://docs.claude.com/en/docs/claude-code/mcp):
@@ -78,6 +82,8 @@ The server starts on `http://localhost:8000/mcp` using Streamable HTTP transport
7882

7983
## Next steps
8084

85+
Now that you have a running server, explore these topics:
86+
8187
- **[Concepts](concepts.md)** — understand the protocol architecture and primitives
8288
- **[Testing](testing.md)** — test your server with the `Client` class
8389
- **[API Reference](api.md)** — full API documentation

0 commit comments

Comments
 (0)