modelcontextprotocol / modelcontextprotocol/python-sdk

CallToolResult structuredContent is not alias-normalized to match outputSchema

オープン
#3,467 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

v1 v2
主要言語
Python
スター
24.3k
フォーク
4k
平均マージ
1日 1時間
マージ済み PR(30日)
31

説明

Initial Checks
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) then model_dump(..., by_alias=True) / dump_python(..., by_alias=True), so structuredContent keys match outputSchema.
  • CallToolResult path: 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.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. 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

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。