Structured tool output: `-> bytes` return crashes with a generic error on non-UTF-8 payloads instead of returning the advertised base64/binary string

Abierto
#3,554 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
78/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python
Área
api, backend

Línea de trabajo

Start at src/mcp/server/mcpserver/utilities/func_metadata.py, especially convert_result and _convert_to_content, and review tests/server/mcpserver/test_func_metadata.py plus the documented structured-output cases. Reproduce the PNG/non-UTF-8 and nested-model cases, then verify that both return successfully with the advertised binary schema and that existing UTF-8 behavior remains covered.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

v1 v2
Initial Checks
Release line

2.x (current stable)

Description

A tool annotated -> bytes publishes output_schema: {"result": {"type": "string", "format": "binary"}}, but when the tool returns actual binary data (PNG magic bytes, a zip, a PDF - anything that is not valid UTF-8) the call fails inside convert_result with PydanticSerializationError. The client only receives is_error: true with the generic text Error executing tool <name> and the data is lost. UTF-8-decodable bytes do not raise, but come back as a raw string ({"result": "hello"}) rather than any base64 encoding.

Observed output (Python 3.13.15, mcp 2.2.0, macOS, run at the v2.2.0 tag):

advertised output_schema: {'properties': {'result': {'format': 'binary', 'title': 'Result', 'type': 'string'}}, 'required': ['result'], 'type': 'object', 'title': 'read_thumbnailOutput'}
is_error: True
content: [TextContent(type='text', text='Error executing tool read_thumbnail', annotations=None, meta=None)]
structured: None
[server] PydanticSerializationError: Error serializing to JSON: invalid utf-8 sequence of 1 bytes from index 0 — at func_metadata.py:653 in _convert_to_content, via convert_result:209
UTF-8-decodable bytes b'hello' -> structured_content={'result': 'hello'} (raw string, not base64)

A bytes field inside an output model (e.g. class Thumb(BaseModel): data: bytes) hits the same crash, with the same advertised format: binary schema for that field.

Expected: bytes is documented as a supported structured-output return type (docstring at src/mcp/server/mcpserver/utilities/func_metadata.py:304 - "Primitive types (str, int, float, bool, bytes, None) - wrapped in a model with a 'result' field"; also docs/servers/structured-output.md: "Every scalar gets the same wrapper: str, int, float, bool, bytes, None"), and tests/server/mcpserver/test_func_metadata.py asserts the published {"type": "string", "format": "binary"} schema. So a -> bytes tool should deliver its payload to the client, encoded so it survives JSON - the way every other bytes path in this package already does: server.py:475 uses base64.b64encode(item.content).decode() for BlobResourceContents, and Image.to_image_content() / Audio.to_audio_content() in utilities/types.py base64-encode their data. It should not raise on the first non-UTF-8 byte and swallow the payload behind a generic error.

Root cause: src/mcp/server/mcpserver/utilities/func_metadata.py:653 - _convert_to_content (reached from convert_result, func_metadata.py:209) serializes a non-str result with pydantic_core.to_json(result, fallback=str, ...), which JSON-encodes bytes by UTF-8-decoding them; the fallback only applies to unknown types, so non-UTF-8 bytes raise PydanticSerializationError.

If it's useful I'm happy to describe or implement the approach (base64-encode bytes in _convert_to_content and the structured dump, following Image/Audio) - happy to be assigned.

Related: the open PRs touching func_metadata.py (#3119, #3118, #2939) cover argument forwarding, schema generation and Annotated metadata, not this; the base64 issues I found (#2376, #3123) are about the Image content path only.

AI disclosure: this issue was prepared with AI assistance; the reproduction above was run and its output verified by me on the v2.2.0 tag.

Example Code
import asyncio
import sys

sys.path.insert(0, "src")
sys.path.insert(0, ".")

from mcp import MCPError
from mcp.server.mcpserver import MCPServer
from tests.interaction._connect import connect_in_memory

PNG_MAGIC = b"\x89PNG\r\n\x1a\n"  # every real PNG starts with this (invalid UTF-8)


async def main() -> None:
    mcp = MCPServer("files")

    @mcp.tool()
    def read_thumbnail(name: str) -> bytes:
        """Return a thumbnail's raw bytes."""
        return PNG_MAGIC + b"\x00\x00"

    async with connect_in_memory(mcp) as client:
        tools = await client.list_tools()
        print("advertised output_schema:", tools.tools[0].output_schema)
        try:
            result = await client.call_tool("read_thumbnail", {"name": "x.png"})
            print("OK:", result.content)
        except MCPError as e:
            print("FAILED:", e.error.code, e.error.message)


asyncio.run(main())
Python & MCP Python SDK
mcp (python-sdk): 2.2.0 (tag v2.2.0 = commit 9972c21, main)
Python: 3.13.15
OS: macOS (Darwin)
Lenguaje dominante
Python
Estrellas
24.3k
Forks
4k
Merge medio
1 d 19 min
PR fusionados (30 d)
29

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de modelcontextprotocol/python-sdk

Todos los issues de modelcontextprotocol/python-sdk

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.