docs(python): Improve error documentation with complete hierarchy #617
+292
−19
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
## Changes ### errors/page.mdx - Add complete ToolExecutionError hierarchy (ToolkitError → ToolError → ToolRuntimeError → ToolExecutionError) - Add retry-aware errors section with examples (RetryableToolError, FatalToolError, ContextRequiredToolError) - Add UpstreamError and UpstreamRateLimitError documentation - Document error hierarchy diagram matching arcade-core implementation ### overview/page.mdx - Add additional examples for tool registration patterns ### transports/page.mdx - Clarify HTTP endpoint table (/mcp GET/POST/DELETE) - Add response mode documentation (JSON vs SSE) ### types/page.mdx - Add error adapter type documentation - Add examples for built-in adapters (Slack, Google, Microsoft) ## Why The error documentation was incomplete - missing the full ToolExecutionError hierarchy and retry-aware error types that tool authors need to use.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Summary
Improves Python SDK error documentation with complete ToolExecutionError hierarchy.
Changes
Why
Error docs were incomplete - missing the full hierarchy and retry-aware errors that tool authors need.
Note
Enhances Python reference docs with full tool error hierarchy and examples, adds error adapters section, expands tool registration examples (auth/secrets/lifecycle), and clarifies HTTP transport endpoints.
app/en/references/mcp/python/errors/page.mdx)arcade_core.errorstool execution errors with retry semantics:RetryableToolError,FatalToolError,ContextRequiredToolError,UpstreamError,UpstreamRateLimitError(with code examples).app/en/references/mcp/python/overview/page.mdx)requires_auth), secrets (requires_secrets), and lifecycle hooks (@app.on_event).app/en/references/mcp/python/transports/page.mdx)GET/POST/DELETE /mcp; add callout about response types andAcceptheader.app/en/references/mcp/python/types/page.mdx)@app.tool(adapters=[...]).Written by Cursor Bugbot for commit e3a669e. This will update automatically on new commits. Configure here.