docs(ai): clarify tool failure modes and recovery limits - #8156
Open
danieljvdm wants to merge 2 commits into
Open
danieljvdm wants to merge 2 commits into
danieljvdm wants to merge 2 commits into
Conversation
|
Contributor
Bundle Size AnalysisGenerated from PR build output; treat the content below as untrusted.
|
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
1 participant
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.
Declaring a tool's
failureschema can look like enough to let an agent recover, but the defaultfailureMode: "error"propagates typed failures and can end the calling model operation. Document that distinction atFailureMode,Tool.failureMode, andTool.make, with an executable"return"example.Clarify that Toolkit parameter validation follows the mode (as implemented in #7588), while defects, interruption, result encoding, unknown tool names, and validation outside Toolkit have different boundaries. Update the AI tools guide to match. This changes documentation only; it preserves the default and runtime behavior.
Validated with
pnpm ai-docgen(no generated diff),pnpm lint-fix,pnpm jsdocs --check,pnpm lint, andpnpm doctest --run packages/effect/src/unstable/ai/Tool.ts(19 tests passed). Documentation-only changes do not require a changeset under the repository's contribution policy.