Skip to content

[docs] docs: sync unified enclave features and capped tool descriptions - #10388

Merged
lpcox merged 3 commits into
mainfrom
doc-sync-enclave-features-179c9fcbd1ecf825
Oct 21, 2026
Merged

lpcox merged 3 commits into
mainfrom
doc-sync-enclave-features-179c9fcbd1ecf825

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Caution

Protected files were modified in this change.
This pull request is in request-review mode and requires explicit human scrutiny before merge.

Protected files: README.md

Summary

This PR synchronizes documentation with recent code changes to the unified enclave architecture and tool description handling.

Changes Made

README.md

  • Added Unified enclaves to Feature highlights section
  • Highlighted cost control capability via --max-num-tool-calls
  • Mentioned key features: repository seedling and dynamic admission

docs/enclaves-architecture.md

  • Clarified that capped-limit tool description text must match exactly during readiness handshake
  • Improved clarity on the broker advisory mechanism for configured limits

Verification

Reviewed and verified the following documentation remains consistent:

  1. awf-config-spec.md §14.2a - Tool call cap specification correctly documents:

    • Scope (run-wide budget)
    • Counting mechanism (all attempted, well-formed calls)
    • Advisory text in tool descriptions
    • Denial behavior with in-band error
    • Persistence and exemptions
  2. INTEGRATION-TESTS.md - Correctly documents:

    • MCP server's empty HTTP 202 acknowledgment for JSON-RPC notifications
    • Preservation of notifications/initialized and cancellation messages
    • Fixture regression testing for notification acknowledgment handling
  3. RELEASE_TEMPLATE.md - Remains consistent with current CLI features and installation instructions

Code Changes Referenced

Testing

  • All documentation links verified to reference correct sections
  • Feature descriptions validated against implementation in source code
  • No broken internal documentation cross-references
  • README feature list now comprehensively covers all major AWF capabilities

Generated by Documentation Maintainer · copilot · haiku45 · 31.7 AIC · ⊞ 5.6K · ◷

- Add unified enclaves to Feature highlights in README.md with mention of
  cost control via --max-num-tool-calls, repository seedling, and dynamic admission
- Clarify that tool description text for capped limits must match exactly
  during readiness handshake in enclaves-architecture.md

Addresses recent code changes:
- Commit 0f185e3: match capped enclave tool
  descriptions during readiness (#10386)
- Commit c915e89: preserve enclave gateway
  notification acknowledgments (#10383)

Verified that:
- Tool descriptions are correctly documented in awf-config-spec.md §14.2a
- MCP notification acknowledgment handling is documented in INTEGRATION-TESTS.md
- Release template remains consistent with current CLI features

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added ai-generated documentation Improvements or additions to documentation labels Oct 21, 2026

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Protected files were modified in this pull request and require manual scrutiny before merge.

Please verify that each protected-file change is intentional, policy-compliant, and safe:

  • Protected files: README.md

Copilot AI 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.

🔵 Needs a closer look

The protected README change requires explicit human scrutiny before merge.

1 open issue
What changed in this PR

Updates AWF documentation to reflect existing unified enclave capabilities and readiness behavior.

Changes:

  • Adds unified enclaves and tool-call cost controls to feature highlights.
  • Clarifies exact matching of capped tool descriptions during readiness.
File Description
README.md Adds unified enclave feature highlights.
docs/​enclaves-architecture.md Clarifies cap-advisory wording in the readiness contract.

Review effort: Max

Comment thread README.md Outdated
@lpcox

lpcox commented Oct 21, 2026

Copy link
Copy Markdown
Collaborator

@copilot address review feedback

Co-authored-by: lpcox <15877973+lpcox@users.noreply.github.com>

Copilot AI commented Oct 21, 2026

Copy link
Copy Markdown
Contributor

@copilot address review feedback

Updated the README wording to “repository seeding” in commit b1505da.

@github-actions

Copy link
Copy Markdown
Contributor Author

✅ Copilot review passed with no inline comments.

@github-actions[bot] Add the ready-for-aw label to this PR to trigger agentic CI smoke tests.

@github-actions

github-actions Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor Author

Documentation Preview

Documentation has been built for this PR.

Download preview artifact

To view locally:

  1. Download the docs-preview-pr-10388 artifact from the workflow run
  2. Unzip and open index.html in your browser

Built from commit 17c5945

@lpcox

lpcox commented Oct 21, 2026

Copy link
Copy Markdown
Collaborator

@copilot merge main and resolve conflicts

…ures-179c9fcbd1ecf825

Co-authored-by: lpcox <15877973+lpcox@users.noreply.github.com>

Copilot AI commented Oct 21, 2026

Copy link
Copy Markdown
Contributor

@copilot merge main and resolve conflicts

Merged main without conflicts in merge commit ede7631 (two parents). Router Go tests pass; the targeted TypeScript test could not run because required dependencies are unavailable and the installed TypeScript version is incompatible with the config.

@lpcox
lpcox merged commit 473ccb7 into main Oct 21, 2026
24 of 25 checks passed
@lpcox
lpcox deleted the doc-sync-enclave-features-179c9fcbd1ecf825 branch October 21, 2026 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-generated documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants