feat(mcp): preserve CallToolResult.isError flag in MCPToolResult#2118
Open
Zelys-DFKH wants to merge 1 commit intostrands-agents:mainfrom
Open
feat(mcp): preserve CallToolResult.isError flag in MCPToolResult#2118Zelys-DFKH wants to merge 1 commit intostrands-agents:mainfrom
Zelys-DFKH wants to merge 1 commit intostrands-agents:mainfrom
Conversation
Adds an optional isError field to MCPToolResult, set to True only when the underlying MCP tool returned CallToolResult.isError=True. This lets callers tell apart application-level errors from protocol/transport errors, which currently both surface as status='error'. Closes strands-agents#1670
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds an optional
isErrorfield toMCPToolResult, set toTrueonly when the underlying MCP tool returnedCallToolResult.isError=True. This lets callers tell apart application-level errors (the tool ran but reported a failure) from protocol/transport errors (the tool never ran because of a client exception, timeout, or session issue). Right now both surface identically asstatus="error", which is what #1670 is asking to fix.Behavior:
CallToolResult.isError=True): result hasstatus="error"andisError=Truestatus="error"and noisErrorkey. This path goes through_handle_tool_execution_errorand is unchanged.status="success", noisErrorkeyThe field is
NotRequired, so existing code readingMCPToolResultkeeps working without changes.Related Issues
Closes #1670
Documentation PR
N/A
Type of Change
New feature
Testing
How have you tested the change? Verify that the changes do not break functionality or introduce warnings in consuming repositories: agents-docs, agents-tools, agents-cli
test_call_tool_sync_statusandtest_call_tool_async_statusparametrized tests to assertresult.get("isError") == (True if is_error else None)test_mcp_tool_result_typeto confirm the field is absent by default and settable when providedhatch run prepare(ruff + mypy + full test suite): 2524 passed, 4 skipped, no new warningsNo new docs needed — this is a small additive field on an existing TypedDict, already documented in the docstring on
MCPToolResult.hatch run prepareChecklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.