modelcontextprotocol / modelcontextprotocol/python-sdk
CallToolResult structuredContent is not alias-normalized to match outputSchema
還沒有人認領這個 Issue。
- 主要語言
- Python
- 星號
- 24.3k
- 分支
- 4k
- 平均合併
- 1 天 1 小時
- 30 天內合併 PR
- 31
描述
Initial Checks
- I confirm that I'm using the newest release of my line (the latest 2.x, or the latest 1.x if I'm still on v1)
- I confirm that I searched for my issue in https://github.com/modelcontextprotocol/python-sdk/issues before opening this issue
Release line
2.x (current stable)
Description
FuncMetadata.convert_result treats a plain model return and a CallToolResult return differently for Pydantic field aliases.
- Plain returns:
validate_python(..., by_alias=True, by_name=True)thenmodel_dump(..., by_alias=True)/dump_python(..., by_alias=True), sostructuredContentkeys matchoutputSchema. CallToolResultpath:validate_python(result.structured_content)only, then returns the result unchanged.
Because validation accepts Python field names when populate_by_name / by_name is in play, a tool can pass validation while emitting wire keys that do not match the published outputSchema (which uses aliases). Clients that validate structuredContent against outputSchema then reject a server-produced payload.
Related but not the same as #1073 / #1099 (plain-return alias dump) or #3100 / #3118 (schema validation vs serialization mode). This is specifically the CallToolResult short-circuit skipping alias normalization.
Verified on current main tip 08a3bc8eaf5bb69a6cb05ac708a86f5325977c20.
Expected: after validating CallToolResult.structured_content, normalize it the same way as the plain-return path (by_alias dump) before returning.
Example Code
from __future__ import annotations
import json
from typing import Annotated
from pydantic import BaseModel, ConfigDict, Field
from mcp_types import CallToolResult, TextContent
from mcp.server.mcpserver.utilities.func_metadata import func_metadata
class AliasOut(BaseModel):
model_config = ConfigDict(populate_by_name=True)
field_first: str = Field(alias="first")
field_second: str = Field(alias="second")
def plain() -> AliasOut:
return AliasOut(field_first="a", field_second="b")
def via_call_tool_result() -> Annotated[CallToolResult, AliasOut]:
# Python field names — accepted by validate when populate_by_name is on
return CallToolResult(
content=[TextContent(text="ok")],
structured_content={"field_first": "a", "field_second": "b"},
)
plain_meta = func_metadata(plain)
ctr_meta = func_metadata(via_call_tool_result)
print("outputSchema keys:", sorted(plain_meta.output_schema["properties"]))
print("plain:", json.dumps(plain_meta.convert_result(plain()).structured_content, sort_keys=True))
print(
"CallToolResult:",
json.dumps(ctr_meta.convert_result(via_call_tool_result()).structured_content, sort_keys=True),
)
Observed on main @ 08a3bc8:
outputSchema keys: ['first', 'second']
plain: {"first": "a", "second": "b"}
CallToolResult: {"field_first": "a", "field_second": "b"}
Python & MCP Python SDK
- Python: 3.12.10
- MCP Python SDK: current
main@08a3bc8eaf5bb69a6cb05ac708a86f5325977c20(2.1.2.dev16+08a3bc8) - Pydantic: 2.12.5 (venv) / also reproduced with system 2.13.5 for imports
AI disclosure
This issue was drafted with AI assistance (Cursor / Grok). I verified the reproduction on current main and reviewed the convert_result paths in func_metadata.py before filing. I would like to open a fix PR for this issue.
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
從 mcp/server/mcpserver/utilities/func_metadata.py 中的 FuncMetadata.convert_result 開始,將 CallToolResult 分支與 issue 中描述的普通回傳路徑進行比較。先執行提供的 alias 範例;當 CallToolResult.structured_content 在轉換後使用 outputSchema 的 alias,同時保留結果的其餘部分時,即表示完成。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- api
- Issue 類型
- 缺陷
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 活躍
- 描述清晰度
- 描述清楚
- 新手友好度
- 76/100