docs: add sealed probes guide - #6734
Merged
Merged
Conversation
Document sealed probe configuration, budgets, schemas, timing, and failures. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: ca8d9d74-46ab-48db-b05f-640cbc6d47be
Contributor
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a user guide for the sealed-probes feature introduced in stacked PR #6728.
Changes:
- Documents architecture, configuration, sensitivity budgets, schemas, timing, and failure semantics.
- Provides invocation guidance and examples.
Show a summary per file
| File | Description |
|---|---|
docs-site/src/content/docs/guides/sealed-probes.md |
Adds the sealed-probes guide. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 5
- Review effort level: Medium
|
|
||
| An `internal` repository with a 64-bit budget can fund 12 consecutive boolean questions (60 bits), leaving 4 bits for one `const` question. If every query uses a `const` schema, it can fund 16 questions. | ||
|
|
||
| `maxInvocations` is a separate, independent operational limit. It counts every response -- including those rejected by schema validation, budget exhaustion, or malformed requests -- and is unrelated to the bit ledger. |
|
|
||
| When sealed probes are enabled the agent container receives: | ||
|
|
||
| - A Unix socket directory (read-write) mounted at `$AWF_SEALED_PROBE_SOCKET` |
|
|
||
| - `--repo` must appear exactly once. The value must be a valid `owner/repo` slug matching a configured repository. | ||
| - `--schema` must appear exactly once. The value is a JSON document (at most 4096 bytes) conforming to the finite schema DSL. | ||
| - The probe script arrives on **stdin**. Interactive terminals are rejected. |
| {"status":"error"} | ||
| ``` | ||
|
|
||
| **Probe environment.** The script runs as an unprivileged user (uid 65534) with no network and a read-only filesystem, except for `/probe`. The repository tree is at `/probe/repo/`. The script must write exactly one JSON value conforming to the declared schema to `/probe/out`. Stdout and stderr are discarded and never reach the agent. |
| | Max `union` variants | 16 | | ||
| | Max literal string length | 64 bytes | | ||
|
|
||
| In practice the 4096-byte size limit is the binding constraint for wide `enum` or `object` schemas well before the count limits are reached. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Validation
cd docs-site && npm run buildnpx markdownlint-cli2 docs-site/src/content/docs/guides/sealed-probes.mdStacking
This documentation PR is stacked on #6728 because sealed probes are not yet on
main.