Skip to content

Commit 56f253f

Browse files
committed
Record tool error results on the client OpenTelemetry span
1 parent 77001c9 commit 56f253f

2 files changed

Lines changed: 59 additions & 5 deletions

File tree

‎src/mcp/shared/jsonrpc_dispatcher.py‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -414,10 +414,14 @@ async def send_raw_request(
414414
clock.start()
415415
timeout_armed = True
416416
outcome = await receive.receive()
417-
if isinstance(outcome, ErrorData) and outcome is not _CLOSED_OUTCOME:
418-
code = str(outcome.code)
419-
span.set_attributes({"error.type": code, "rpc.response.status_code": code})
420-
span.set_status(StatusCode.ERROR, outcome.message)
417+
if isinstance(outcome, ErrorData):
418+
if outcome is not _CLOSED_OUTCOME:
419+
code = str(outcome.code)
420+
span.set_attributes({"error.type": code, "rpc.response.status_code": code})
421+
span.set_status(StatusCode.ERROR, outcome.message)
422+
elif method == "tools/call" and outcome.get("isError") is True:
423+
span.set_attribute("error.type", "tool_error")
424+
span.set_status(StatusCode.ERROR)
421425
except TimeoutError:
422426
if not timeout_armed:
423427
# The clock starts only after the write, so this TimeoutError is the

‎tests/shared/test_otel.py‎

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
import mcp_types as types
44
import pytest
55
from logfire.testing import CaptureLogfire
6-
from opentelemetry.trace import StatusCode
6+
from opentelemetry.trace import SpanKind, StatusCode
77

88
from mcp.client.client import Client
99
from mcp.server import Server, ServerRequestContext
1010
from mcp.server.mcpserver import MCPServer
11+
from mcp.server.mcpserver.exceptions import ToolError
1112
from mcp.shared._otel import extract_trace_context
1213
from mcp.shared.exceptions import MCPError
1314

@@ -91,3 +92,52 @@ async def list_prompts(
9192
assert failed.attributes is not None
9293
assert failed.attributes["error.type"] == str(types.INVALID_PARAMS)
9394
assert failed.attributes["rpc.response.status_code"] == str(types.INVALID_PARAMS)
95+
96+
97+
async def test_client_and_server_spans_agree_on_tool_error(capfire: CaptureLogfire) -> None:
98+
"""A `tools/call` whose result has `isError: true` marks both client and server spans ERROR with
99+
`error.type="tool_error"` and no `rpc.response.status_code` (OpenTelemetry GenAI MCP conventions);
100+
a succeeding `tools/call` leaves both spans UNSET.
101+
"""
102+
server = MCPServer("test")
103+
104+
@server.tool()
105+
def ok() -> str:
106+
return "fine"
107+
108+
@server.tool()
109+
def fail() -> str:
110+
raise ToolError("upstream unavailable")
111+
112+
async with Client(server, mode="legacy") as client:
113+
ok_result = await client.call_tool("ok")
114+
err_result = await client.call_tool("fail")
115+
116+
assert ok_result.is_error is False
117+
assert err_result.is_error is True
118+
assert isinstance(err_result.content[0], types.TextContent)
119+
assert err_result.content[0].text == "Error executing tool fail: upstream unavailable"
120+
121+
spans = {
122+
(span.name, span.kind): span
123+
for span in capfire.exporter.exported_spans
124+
if (span.attributes or {}).get("logfire.span_type") != "pending_span"
125+
}
126+
127+
client_ok = spans[("MCP send tools/call ok", SpanKind.CLIENT)]
128+
server_ok = spans[("tools/call ok", SpanKind.SERVER)]
129+
assert client_ok.status.status_code == StatusCode.UNSET
130+
assert server_ok.status.status_code == StatusCode.UNSET
131+
assert client_ok.attributes is not None
132+
assert "error.type" not in client_ok.attributes
133+
134+
client_fail = spans[("MCP send tools/call fail", SpanKind.CLIENT)]
135+
server_fail = spans[("tools/call fail", SpanKind.SERVER)]
136+
assert client_fail.context is not None and server_fail.context is not None
137+
assert client_fail.context.trace_id == server_fail.context.trace_id
138+
assert client_fail.status.status_code == StatusCode.ERROR
139+
assert server_fail.status.status_code == StatusCode.ERROR
140+
assert client_fail.attributes is not None and server_fail.attributes is not None
141+
assert client_fail.attributes["error.type"] == "tool_error"
142+
assert server_fail.attributes["error.type"] == "tool_error"
143+
assert "rpc.response.status_code" not in client_fail.attributes

0 commit comments

Comments
 (0)