docs: add tool_output_cap.py to STRUCTURE.md, cross-ref in agent-tools [doc-updater] - #2882
Conversation
…s [doc-updater] Update documentation to reflect changes from bb71f4d: - STRUCTURE.md: add tool_output_cap.py to the egg_agent/ module listing - agent-tools.md: add cross-reference from the MCP output-size cap section to the new PreToolUse predictive cap for built-in CC tools Triggered by: #2877 Authored-by: egg
There was a problem hiding this comment.
LGTM — doc-only PR, every factual claim verified against the code and target docs. No blocking issues.
What I verified
tool_output_cap.pyexists atshared/egg_agent/tool_output_cap.py, and the STRUCTURE.md one-liner is accurate:- "Read/Grep" matches the dispatcher —
check_builtin_tool_output_riskonly handlesReadandGrep(tool_output_cap.py:266-269). This is actually more precise than the module's own docstring, which loosely listsEdit/Write/Bashas built-ins too. - "1 MB SDK buffer",
EGG_TOOL_OUTPUT_CAP/EGG_READ_CAP_BYTES, and#2876all match the source (is_output_cap_disabled,_read_cap_bytes, module docstring).
- "Read/Grep" matches the dispatcher —
- STRUCTURE.md tree is correct:
tool_interceptor.pycorrectly switched from└──to├──, the new file is the└──terminal entry, and the listing matches the realegg_agent/directory contents and alphabetical order. - agent-tools.md cross-reference resolves: the anchor
#predictive-output-cap-pretoolusemaps to the real heading### Predictive Output Cap (PreToolUse)(agent-recovery.md:136) under GitHub's slug rules. The relative path is correct (both files live indocs/reference/). - Issue references (
#2876,#2805,#2804) are consistent with the linked section and the source. - PR-body claim that
agent-recovery.mdneeds no further changes is correct — that section already exists from the prior commit.
The new agent-tools.md paragraph is placed sensibly right after the complementary EGG_TOOL_OUTPUT_CAP_BYTES (#2805) section, and the "Built-in tools (Read, Grep, etc.) … can't be wrapped" framing is accurate (the "etc." qualifies which built-ins run in the CLI, not the hook's coverage).
Confirmed via gh pr view that the PR changes exactly the two doc files.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
| egg is addressing review feedback... |
Review feedback dispositionThe only review on this PR is an LGTM from There are no line-level review comments and no other authorized-reviewer feedback. The remaining issue-level comments are automated workflow status messages, not review feedback. No actionable items → no code changes required. Nothing to fix, defer, or disagree with. — Authored by egg |
|
egg feedback addressed. View run logs 1 previous review(s) hidden. |
…s [doc-updater] (#2882) Update documentation to reflect changes from bb71f4d: - STRUCTURE.md: add tool_output_cap.py to the egg_agent/ module listing - agent-tools.md: add cross-reference from the MCP output-size cap section to the new PreToolUse predictive cap for built-in CC tools Triggered by: #2877 Authored-by: egg Co-authored-by: jwbron <8340608+jwbron@users.noreply.github.com>
Update documentation to reflect changes introduced by bb71f4d (#2877), which added
shared/egg_agent/tool_output_cap.py— a new PreToolUse hook that bounds built-in CC tool output.tool_output_cap.pyto theegg_agent/module listing. The commit added the file but STRUCTURE.md still showed onlytool_interceptor.pyas the last entry.EGG_TOOL_OUTPUT_CAP_BYTES, Cap MCP @tool output sizes at the tool layer (follow-up to #2804) #2805) to the new built-in tool predictive cap (EGG_TOOL_OUTPUT_CAP/EGG_READ_CAP_BYTES, Bound built-in Claude Code tool output (Read/Edit/Grep) via PreToolUse predictive cap (follow-up to #2805/#2810) #2876). Both mechanisms protect the same 1 MB SDK buffer limit via different layers; the cross-reference helps operators find the complementary knob.The
docs/reference/agent-recovery.mdwas already updated as part of the original commit and does not need further changes.Triggered by: #2877
Test Plan
Authored-by: egg