FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

fix(mcpserver): preserve Annotated/Field metadata for dict[str, T] return types by anneheartrecord · Pull Request #2939 · modelcontextprotocol/python-sdk · GitHub

Repository navigation

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .py  (2) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
6 changes: 3 additions & 3 deletions src/mcp/server/mcpserver/utilities/func_metadata.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -349,9 +349,9 @@ def _try_create_model_and_schema(
if origin is dict:
args = get_args(type_expr)
if len(args) == 2 and args[0] is str:
# TODO: should we use the original annotation? We are losing any potential `Annotated`
# metadata for Pydantic here:
model = _create_dict_model(func_name, type_expr)
# Use the original annotation (which may be `Annotated[dict[str, T], Field(...)]`)
# so that any Annotated metadata (e.g. Field description) is preserved in the schema.
model = _create_dict_model(func_name, original_annotation)
else:
# dict with non-str keys needs wrapping
model = _create_wrapped_model(func_name, original_annotation)
Expand Down
27 changes: 27 additions & 0 deletions tests/server/mcpserver/test_func_metadata.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,33 @@ def func_dict_int_key() -> dict[int, str]: # pragma: no cover
assert "result" in meta.output_schema["properties"]


def test_structured_output_dict_str_preserves_annotated_metadata():
"""dict[str, T] return types should preserve Annotated/Field metadata in output schema.

Regression test for https://github.com/modelcontextprotocol/python-sdk/issues/2935
"""

def get_config() -> Annotated[dict[str, int], Field(description="Configuration values")]: # pragma: no cover
return {"timeout": 30}

meta = func_metadata(get_config)
assert meta.output_schema is not None
assert meta.output_schema.get("description") == "Configuration values", (
f"Expected 'description' in schema, got: {meta.output_schema}"
)

# Additional metadata (title, max_length, etc.) should also be preserved
def get_headers() -> Annotated[
dict[str, str], Field(description="HTTP headers", title="Headers")
]: # pragma: no cover
return {"Content-Type": "application/json"}

meta2 = func_metadata(get_headers)
assert meta2.output_schema is not None
assert meta2.output_schema.get("description") == "HTTP headers"
assert meta2.output_schema.get("title") == "Headers"


@pytest.mark.anyio
async def test_lambda_function():
"""Test lambda function schema and validation"""
Expand Down
Loading

Back | FazBrowse Home | New Git URL