Skip to content

docs: add approval-bound action metadata example - #2278

Open
jw-ond wants to merge 1 commit into
ag-ui-protocol:mainfrom
jw-ond:codex/governed-approval-example
Open

docs: add approval-bound action metadata example#2278
jw-ond wants to merge 1 commit into
ag-ui-protocol:mainfrom
jw-ond:codex/governed-approval-example

Conversation

@jw-ond

@jw-ond jw-ond commented Jul 29, 2026

Copy link
Copy Markdown

Summary

Adds a worked example to the Interrupts documentation showing how sensitive tool-call approvals can be bound to a proposed action fingerprint.

The new section uses existing AG-UI concepts only:

  • interrupt metadata carries the proposed action fingerprint and policy metadata
  • resume payload echoes the approved fingerprint and can carry a verifier receipt
  • the enforcing agent or server recomputes the actual execution fingerprint before emitting ToolCallResult
  • action drift should terminate with RunError instead of a successful result

This does not add new protocol fields or governance semantics to AG-UI. It documents a practical pattern using metadata and resume payloads that are already part of the interrupt lifecycle.

Notes

Running Prettier on docs/concepts/interrupts.mdx also rewrapped existing prose and tables in the same file. The substantive addition is the Approval-bound action metadata section.

Test plan

  • npx prettier --check docs/concepts/interrupts.mdx
  • git diff --check

@jw-ond
jw-ond requested a review from a team as a code owner July 29, 2026 19:13
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