introduce NewToolResultErrorWithErr and update docs #140
Conversation
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
WalkthroughThe changes update error handling across two areas. The calculator tool now returns a standardized error message ("cannot divide by zero") using a structured error function instead of the default error generation. In parallel, the HTTP tool updates its error responses by replacing the use of generic formatting functions with a dedicated error function that appends detailed error context. Additionally, a new utility function has been added to create structured error results that include specific error details. Changes
Possibly related PRs
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
fabiante
reviewed
Apr 14, 2025
mcp/utils.go
Outdated
| // NewToolResultErrorWithErr creates a new CallToolResult with an error message. | ||
| // If an error is provided, its details will be appended to the text message. | ||
| // Any errors that originate from the tool SHOULD be reported inside the result object. | ||
| func NewToolResultErrorWithErr(text string, err error) *CallToolResult { |
There was a problem hiding this comment.
What do you think about NewToolResultErrorFromErr instead? Semantically the same, maybe a bit more clearer.
We could even go NewToolResultErrorFrom.
|
@deviantony Thanks for following up on this topic. The overall changes in this PR make sense to me, and I appreciate the effort to standardize error handling and clarify usage in the README. That said, I agree with @fabiante — |
fabiante
approved these changes
Apr 15, 2025
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.
This is a proposal for a follow-up on #87
It introduces a
NewToolResultErrorWithErrfunction that takes an error as a parameter to aggregate it in the result.It also updates the documentation in the README to show when to use the regular
NewToolResultErrorVSNewToolResultErrorWithErr.@daimatz happy to hear your thoughts.
I've updated all errors handling to use this function because I don't think that there is a particular example in the README that covers a "regular" error raising, e.g.:
Summary by CodeRabbit