Skip to content

docs: add tool_output_cap.py to STRUCTURE.md, cross-ref in agent-tools [doc-updater] - #2882

Merged
jwbron merged 1 commit into
mainfrom
egg/doc-update-tool-output-cap-structure
May 29, 2026
Merged

docs: add tool_output_cap.py to STRUCTURE.md, cross-ref in agent-tools [doc-updater]#2882
jwbron merged 1 commit into
mainfrom
egg/doc-update-tool-output-cap-structure

Conversation

@james-in-a-box

Copy link
Copy Markdown
Contributor

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.

The docs/reference/agent-recovery.md was already updated as part of the original commit and does not need further changes.

Triggered by: #2877

Test Plan

  • Automated: doc-only changes, no code modified
  • Manual: verify STRUCTURE.md lists tool_output_cap.py and agent-tools.md cross-reference links to agent-recovery.md anchor

Authored-by: egg

…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

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM — doc-only PR, every factual claim verified against the code and target docs. No blocking issues.

What I verified

  • tool_output_cap.py exists at shared/egg_agent/tool_output_cap.py, and the STRUCTURE.md one-liner is accurate:
    • "Read/Grep" matches the dispatcher — check_builtin_tool_output_risk only handles Read and Grep (tool_output_cap.py:266-269). This is actually more precise than the module's own docstring, which loosely lists Edit/Write/Bash as built-ins too.
    • "1 MB SDK buffer", EGG_TOOL_OUTPUT_CAP / EGG_READ_CAP_BYTES, and #2876 all match the source (is_output_cap_disabled, _read_cap_bytes, module docstring).
  • STRUCTURE.md tree is correct: tool_interceptor.py correctly switched from └── to ├──, the new file is the └── terminal entry, and the listing matches the real egg_agent/ directory contents and alphabetical order.
  • agent-tools.md cross-reference resolves: the anchor #predictive-output-cap-pretooluse maps 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 in docs/reference/).
  • Issue references (#2876, #2805, #2804) are consistent with the linked section and the source.
  • PR-body claim that agent-recovery.md needs 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

@james-in-a-box

This comment has been minimized.

@james-in-a-box

Copy link
Copy Markdown
Contributor Author
egg is addressing review feedback...

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

Review feedback disposition

The only review on this PR is an LGTM from egg-reviewer[bot] (COMMENTED, "No blocking issues"). It verified every factual claim in the doc changes against the source — the tool_output_cap.py STRUCTURE.md entry, the Read/Grep dispatcher accuracy, the #2876/#2805/#2804 issue references, the STRUCTURE.md tree wiring, and the #predictive-output-cap-pretooluse cross-reference anchor.

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

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

egg feedback addressed. View run logs

1 previous review(s) hidden.

@jwbron
jwbron merged commit 60cd556 into main May 29, 2026
23 checks passed
james-in-a-box Bot added a commit that referenced this pull request May 30, 2026
…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>
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