Skip to content

docs(coding-agent): document subagent escalation behavior - #122

Merged
Issacboy123 merged 1 commit into
fix/complete-subagent-coordinationfrom
docs/document-subagent-escalations
Aug 28, 2026
Merged

Issacboy123 merged 1 commit into
fix/complete-subagent-coordinationfrom
docs/document-subagent-escalations

Conversation

@Issacboy123

Copy link
Copy Markdown
Contributor

Summary

This PR explains how child-to-parent escalation reports work and when children should use them. It covers report limits, delivery while the parent is active or idle, behavior while the parent waits for children, and availability after a saved child is woken. It also clarifies that reports are hidden but still untrusted session data and records the feature in the coding-agent changelog.

This PR is stacked on fix/complete-subagent-coordination, which completes escalation-aware coordinated waiting.

Reasoning

The usage guide is the natural home for operational behavior, while the sessions and SDK guides clarify persistence and construction boundaries where users already encounter subagents. Describing acknowledgement, hidden delivery, and storage separately avoids implying model consumption, crash durability, secrecy, or redaction beyond the implemented guarantees.

Changes

  • Documented the child-only tool, material-report guidance, 1,000-character per-message limit, multiple-report support, and 8,000-character pending aggregate limit.
  • Documented FIFO active delivery, coalescing boundaries, non-interruption of sampling, and coordinated-wait resumption with exactly-once terminal results.
  • Documented non-triggering idle behavior for saved and in-memory sessions and restored or replacement availability after explicit wake.
  • Clarified that reports are untrusted, successful acknowledgement is not consumption, and hidden root messages and child tool arguments remain normal session data.
  • Reserved escalate_to_parent in the SDK documentation and added an Unreleased coding-agent changelog entry.

Testing

  • node ../../node_modules/vitest/dist/cli.js --run test/suite/subagent-parent-messaging.test.ts test/suite/subagent-services.test.ts test/suite/subagent-registration.test.ts test/suite/subagent-actions.test.ts test/suite/subagent-coordination.test.ts test/suite/subagent-persistence.test.ts test/suite/agent-session-queue.test.ts test/subagent-controller.test.ts
  • npm.cmd run check
  • git diff --check

@Issacboy123 Issacboy123 added documentation Improvements or additions to documentation tool-calling coding-agent labels Aug 25, 2026
@Issacboy123 Issacboy123 self-assigned this Aug 25, 2026
@Pepps233
Pepps233 force-pushed the docs/document-subagent-escalations branch from 088299f to f22697b Compare August 25, 2026 14:36
@Pepps233
Pepps233 self-requested a review August 25, 2026 18:35
@Issacboy123
Issacboy123 force-pushed the docs/document-subagent-escalations branch from 187dd69 to 1d4b235 Compare August 27, 2026 10:54
@Issacboy123
Issacboy123 force-pushed the docs/document-subagent-escalations branch from 1d4b235 to 35a70ac Compare August 27, 2026 23:11
@Issacboy123
Issacboy123 merged commit b044cb8 into main Aug 28, 2026
2 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

coding-agent documentation Improvements or additions to documentation tool-calling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants