Skip to content

docs(agents): document the echo guard setting - #260

Merged
Him188 merged 1 commit into
mainfrom
him188/echo-guard
Oct 18, 2026
Merged

Him188 merged 1 commit into
mainfrom
him188/echo-guard

Conversation

@Him188

@Him188 Him188 commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds an Echo guard section to Agents > Build > Configuration, after Interruptions.

  • Why it exists: callers' devices and the phone network normally cancel the agent's echo, but in a few calls (under 3%) some gets through in the agent's first seconds and cuts it off.
  • What it does: for 3 seconds after the agent first starts talking, the caller can't interrupt it and what the caller says over the agent is dropped. Keypad entries and the web SDK's interrupt() still work.
  • One key per call channel (web_voice, phone_inbound, phone_outbound), each true, false or null, in a table with the Builder labels and defaults (on, on, off).
  • When to turn it off: when callers should be able to interrupt the agent within those 3 seconds.
  • The config example in the same page shows a new agent's value (null).

Merge timing

The setting is live in production. The branch is rebased on main, whose api-reference/openapi.json already carries echo_guard from the scheduled schema update (#266), so no schema change is needed here.

Checks

  • prettier --check agents/build/configuration.mdx passes.
  • The anchors used (#system-variables, #keypad-input) exist.

Linear: FA-498.

🤖 Generated with Claude Code


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need.

@mintlify

mintlify Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
hanabiaiinc 🟢 Ready View Preview Oct 18, 2026, 6:15 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 7e0a3c89-dc15-4c67-95e3-5ed15ff4bad2
📥 Commits

Reviewing files that changed from the base of the PR and between 7d5908f and bfd413d.

📒 Files selected for processing: 1
  • agents/build/configuration.mdx

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

The configuration guide now describes conversation.echo_guard, its channel defaults and reset behavior, and which inputs remain effective during its three-second window. The draft response example includes "echo_guard": null.

Changes: Echo guard configuration

Layer / File(s) Summary
Setting and example
agents/build/configuration.mdx
The guide documents echo guard behavior, per-channel defaults, reset behavior, and inputs that remain effective during the guard window. The draft response example includes echo_guard: null.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to bfd41

The documentation matches the checked-in API schema for the described settings. No actionable merge risk is established by the available evidence.

Pre-merge checks: Passed 5
Check name Status Explanation
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: documenting the conversation.echo_guard setting in the agents configuration documentation.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches: 💡 1
🛠️ Fix failing CI checks: 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

Adds an Echo guard section to Agents > Build > Configuration: why some
echo can still reach the agent in its first seconds, what the guard
does for those 3 seconds, the default per channel, and when to turn it
off. The config example shows a new agent's echo_guard value (null).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Him188
Him188 force-pushed the him188/echo-guard branch from f1880a3 to 4b784e4 Compare October 18, 2026 06:15
@Him188
Him188 merged commit 1a2a5e6 into main Oct 18, 2026
5 of 6 checks passed
@Him188
Him188 deleted the him188/echo-guard branch October 18, 2026 07:16

This branch was successfully deployed

1 active deployment
staging — 4b784e45 Deployed Oct 18, 2026 by mintlify[bot]
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.

1 participant