Repository navigation
Document tool approval behavior and update API reference - #1800
Conversation
…val is false Clarify that when enable_tool_approval is false (the default for server/automation), tools requiring approval are converted to errors and fed back to the LLM for self-correction, rather than silently failing. https://claude.ai/code/session_01FKBNNFQXTFdQDFqGm4GXQp Signed-off-by: Claude <noreply@anthropic.com>
Claude Code ReviewThis repository is configured for manual code reviews. Comment |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughThis PR updates the HTTP API documentation to add a "Tool Approval Behavior" section describing how the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Deploy Preview for holmes-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for holmes-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
) ## Summary This PR enhances the HTTP API documentation by clarifying the `enable_tool_approval` parameter behavior and adding a dedicated section explaining how tool approval works in different contexts. ## Changes - Updated the `enable_tool_approval` parameter description in the API reference table to reference a new detailed behavior section - Added new "Tool Approval Behavior" section that documents: - How `enable_tool_approval: true` works for interactive clients (pauses stream, emits `approval_required` event, requires follow-up request with `tool_decisions`) - How `enable_tool_approval: false` works for server/automation contexts (automatically converts unapproved tools to errors, allows LLM self-correction) - Use case clarification that server-mode integrations don't require human-in-the-loop approval ## Details The documentation now provides clear guidance on when and how to use the tool approval feature, helping users understand the different behaviors for interactive vs. automated scenarios. This is particularly useful for integrations like Keep workflows that operate in server mode without human intervention. https://claude.ai/code/session_01FKBNNFQXTFdQDFqGm4GXQp Signed-off-by: Claude <noreply@anthropic.com> Co-authored-by: Claude <noreply@anthropic.com>
Summary
This PR enhances the HTTP API documentation by clarifying the
enable_tool_approvalparameter behavior and adding a dedicated section explaining how tool approval works in different contexts.Changes
enable_tool_approvalparameter description in the API reference table to reference a new detailed behavior sectionenable_tool_approval: trueworks for interactive clients (pauses stream, emitsapproval_requiredevent, requires follow-up request withtool_decisions)enable_tool_approval: falseworks for server/automation contexts (automatically converts unapproved tools to errors, allows LLM self-correction)Details
The documentation now provides clear guidance on when and how to use the tool approval feature, helping users understand the different behaviors for interactive vs. automated scenarios. This is particularly useful for integrations like Keep workflows that operate in server mode without human intervention.
https://claude.ai/code/session_01FKBNNFQXTFdQDFqGm4GXQp
Summary by CodeRabbit