Skip to content

Document tool approval behavior and update API reference - #1800

Merged
aantn merged 3 commits into
masterfrom
claude/investigate-bash-parsing-bug-L27Ku
Mar 17, 2026
Merged

aantn merged 3 commits into
masterfrom
claude/investigate-bash-parsing-bug-L27Ku

Conversation

@aantn

@aantn aantn commented Mar 17, 2026 •

Copy link
Copy Markdown
Collaborator

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

Summary by CodeRabbit

  • Documentation
    • Added comprehensive tool approval behavior documentation explaining how enable_tool_approval functions in interactive versus server/automation modes, including event details and automatic error handling with retry guidance.

…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

claude Bot commented Mar 17, 2026

Copy link
Copy Markdown
Contributor

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review.

@aantn
aantn enabled auto-merge (squash) March 17, 2026 00:19
@coderabbitai

coderabbitai Bot commented Mar 17, 2026 •

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cca80ea5-d5be-40a3-b704-dd77b7ba5336

📥 Commits

Reviewing files that changed from the base of the PR and between dc68c16 and dc63d31.

📒 Files selected for processing (1)
  • docs/reference/http-api.md

Walkthrough

This PR updates the HTTP API documentation to add a "Tool Approval Behavior" section describing how the enable_tool_approval parameter operates differently in interactive versus server/automation modes, including event details and error handling. The existing field description now references this new section.

Changes

Cohort / File(s) Summary
HTTP API Documentation
docs/reference/http-api.md
Added "Tool Approval Behavior" documentation section explaining interactive vs server/automation mode behavior, event details (approval_required), and error handling. Updated enable_tool_approval field description to reference this new section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • Add HTTP API documentation #592: Modifies HTTP API documentation for the /api/chat endpoint, specifically expanding the enable_tool_approval field description and adding tool approval behavior documentation.

Suggested reviewers

  • arikalon1
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately summarizes the main change: documenting tool approval behavior and updating the HTTP API reference documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@netlify

netlify Bot commented Mar 17, 2026

Copy link
Copy Markdown

✅ Deploy Preview for holmes-docs ready!

Name Link
🔨 Latest commit d6a22ca
🔍 Latest deploy log https://app.netlify.com/projects/holmes-docs/deploys/69b89deecc03e100087436c5
😎 Deploy Preview https://deploy-preview-1800--holmes-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Mar 17, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for holmes-docs ready!

Name Link
🔨 Latest commit aef2f5f
🔍 Latest deploy log https://app.netlify.com/projects/holmes-docs/deploys/69b923228a91510008ac5dee
😎 Deploy Preview https://deploy-preview-1800--holmes-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@aantn
aantn merged commit 45bad5f into master Mar 17, 2026
14 of 15 checks passed
@aantn
aantn deleted the claude/investigate-bash-parsing-bug-L27Ku branch March 17, 2026 10:13
henrikrexed pushed a commit to henrikrexed/holmesgpt that referenced this pull request Mar 17, 2026
)

## 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants