docs: webhook tool execution modes - #132
Conversation
…ground) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
📝 WalkthroughWalkthroughThe webhook tools documentation adds three execution modes: ChangesWebhook execution modes
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@agents/build/webhook-tools.mdx`:
- Line 94: Update the internal link in the text-only runs description to use the
relative target ../test/agent-tests instead of the root-relative
/agents/test/agent-tests, preserving the surrounding wording.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 6f11821e-588d-49aa-80b3-bb5cce2eb9eb
📒 Files selected for processing (1)
agents/build/webhook-tools.mdx
|
|
||
| - Up to **10 background calls** can be in flight per conversation. Further calls fail immediately with an error the agent can react to ("let me finish checking the first thing you asked about"). | ||
| - When the conversation ends, in-flight background calls are cancelled; the attempt stays visible in the conversation's tool-call history. | ||
| - In text-only runs — [agent tests](/agents/test/agent-tests), for example — every webhook tool executes as `blocking`, so results always appear in the transcript in order. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use a relative path for the internal link.
Change /agents/test/agent-tests to ../test/agent-tests, relative to agents/build/webhook-tools.mdx. The current root-relative path does not follow the internal-link rule.
As per coding guidelines, use relative paths for internal links.
Proposed fix
- - In text-only runs — [agent tests](/agents/test/agent-tests), for example — every webhook tool executes as `blocking`, so results always appear in the transcript in order.
+ - In text-only runs — [agent tests](../test/agent-tests), for example — every webhook tool executes as `blocking`, so results always appear in the transcript in order.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - In text-only runs — [agent tests](/agents/test/agent-tests), for example — every webhook tool executes as `blocking`, so results always appear in the transcript in order. | |
| - In text-only runs — [agent tests](../test/agent-tests), for example — every webhook tool executes as `blocking`, so results always appear in the transcript in order. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@agents/build/webhook-tools.mdx` at line 94, Update the internal link in the
text-only runs description to use the relative target ../test/agent-tests
instead of the root-relative /agents/test/agent-tests, preserving the
surrounding wording.
Source: Coding guidelines
Documents
execution_mode(blocking / fire_and_forget / background) for webhook tools: mode comparison, background limits (300s timeout, 10 in-flight), and error-handling behavior per mode.🤖 Generated with Claude Code
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.Summary by CodeRabbit
New Features
Documentation