Skip to content

Commit ecd3048

Browse files
authored
Fix mkdocs build warnings (#10)
- Fix absolute link to relative in examples-lowlevel-servers.md - Add missing return type annotation to session property - Remove broken cross-references to type aliases (RequestId, ElicitationResult) - Update CLAUDE.md documentation build command
1 parent 74040f1 commit ecd3048

File tree

5 files changed

+10
-6
lines changed

5 files changed

+10
-6
lines changed

CLAUDE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ This document contains critical information about working with this codebase. Fo
2424
- Coverage: test edge cases and errors
2525
- New features require tests
2626
- Bug fixes require regression tests
27+
- Documentation
28+
- Test changes in docs/ and Python docstrings: `uv run mkdocs build`
29+
- On macOS: `export DYLD_FALLBACK_LIBRARY_PATH=/opt/homebrew/lib & uv run mkdocs build`
30+
- Fix WARNING and ERROR issues and re-run build until clean
2731

2832
- For commits fixing bugs or adding features based on user reports add:
2933

docs/examples-lowlevel-servers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Low-level server examples
22

3-
The [low-level server API](/python-sdk/reference/mcp/server/lowlevel/server/) provides maximum control over MCP protocol implementation. Use these patterns when you need fine-grained control or when [`FastMCP`][mcp.server.fastmcp.FastMCP] doesn't meet your requirements.
3+
The [low-level server API](reference/mcp/server/lowlevel/server.md) provides maximum control over MCP protocol implementation. Use these patterns when you need fine-grained control or when [`FastMCP`][mcp.server.fastmcp.FastMCP] doesn't meet your requirements.
44

55
The low-level API provides the foundation that FastMCP is built upon, giving you access to all MCP protocol features with complete control over implementation details.
66

src/mcp/server/fastmcp/server.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1487,7 +1487,7 @@ async def elicit(
14871487
and simple containers (list, dict) are allowed - no complex nested objects.
14881488
14891489
Returns:
1490-
[`ElicitationResult`][mcp.server.fastmcp.utilities.types.ElicitationResult] containing:
1490+
`ElicitationResult` containing:
14911491
14921492
- `action`: One of "accept", "decline", or "cancel" indicating user response
14931493
- `data`: The structured response data (only populated if action is "accept")
@@ -1652,7 +1652,7 @@ async def traceable_tool(data: str, ctx: Context) -> str:
16521652
return str(self.request_context.request_id)
16531653

16541654
@property
1655-
def session(self):
1655+
def session(self) -> ServerSession:
16561656
"""Access to the underlying ServerSession for advanced MCP operations.
16571657
16581658
This property provides direct access to the [`ServerSession`][mcp.server.session.ServerSession]

src/mcp/server/session.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ async def send_log_message(
318318
logger: Optional name to identify the source of the log message.
319319
Useful for categorizing logs from different components or modules
320320
within your server (e.g., "database", "auth", "tool_handler").
321-
related_request_id: Optional [`types.RequestId`][mcp.types.RequestId] linking this log to a specific client request.
321+
related_request_id: Optional `types.RequestId` linking this log to a specific client request.
322322
Use this to associate log messages with the request they relate to,
323323
making it easier to trace request processing and debug issues.
324324
@@ -600,7 +600,7 @@ async def elicit(
600600
message: The prompt or question to present to the user.
601601
requestedSchema: A [`types.ElicitRequestedSchema`][mcp.types.ElicitRequestedSchema]
602602
defining the expected response structure according to JSON Schema.
603-
related_request_id: Optional [`types.RequestId`][mcp.types.RequestId] linking
603+
related_request_id: Optional `types.RequestId` linking
604604
this elicitation to a specific client request for tracing.
605605
606606
Returns:

src/mcp/shared/context.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ async def query_data(name: str, arguments: dict[str, Any]):
7777
```
7878
7979
Attributes:
80-
request_id: Unique identifier for the current request as a [`RequestId`][mcp.types.RequestId].
80+
request_id: Unique identifier for the current request as a `RequestId`.
8181
Use this for logging, tracing, or linking related operations.
8282
meta: Optional request metadata including progress tokens and other client-provided
8383
information. May be `None` if no metadata was provided.

0 commit comments

Comments
 (0)