Skip to content

Update the token-steering and max-ai-credits docs for AWF's on-by-default budget notices #77053

Closed

Description

@rabeckett

AWF's budget notices warn the agent when a run's AI credits or time are nearly spent. Up to AWF v0.29.11 they are off unless the AWF config turns them on. From the next AWF release they are on by default (github/gh-aw-firewall#11486), and only an explicit false turns them off.

gh-aw already turns notices on for every workflow with a credit budget, and writes enableTokenSteering: false when a workflow sets sandbox.agent.token-steering: false. When a workflow sets max-ai-credits: -1, gh-aw leaves the setting out. With AWF releases after v0.29.11, those workflows will therefore get notices too: time notices against the agent deadline, and credit notices against AWF's hard cap. That's intended, since notices should be on by default. token-steering: false stays the way to turn them off. No code change is needed, but several docs describe the old behaviour.

What we'd like

  • token-steering descriptions. The "Token steering (sandbox.agent.token-steering)" section of docs/src/content/docs/reference/sandbox.md, the Token Steering entry in docs/src/content/docs/reference/glossary.md, and the token-steering description in pkg/parser/schemas/main_workflow_schema.json (which generates frontmatter-full.md) all say that turning the setting off preserves "the explicitly configured provider and model". Steering never changes the provider or model. They should say that the setting controls AWF's budget notices, that the notices are on by default, and that token-steering: false turns them off.
  • What the notices do. The sandbox.md paragraph describing the notices, and the max-ai-credits section of docs/src/content/docs/reference/frontmatter.md ("budget-warning messages at 80%, 90%, 95%, and 99% of the budget"), need updating for AWF releases after v0.29.11. Each conversation in the run, sub-agents included, gets each notice once. The notice states how much budget or time is left, then says what to do. A further notice comes when about five requests' worth of credits, or about five minutes, remain.
  • max-ai-credits: -1. frontmatter.md says a negative value disables "both budget enforcement and steering". With AWF releases after v0.29.11, it disables only the budget, and notices continue unless token-steering: false is set. The same applies to the comment in pkg/workflow/awf_config_build.go that says -1 disables token steering.

gh-aw can keep writing enableTokenSteering, which AWF keeps as an alias of the new apiProxy.steering.budget.

Related: github/gh-aw-firewall#11442, github/gh-aw-firewall#11486

Activity

  1. locked and limited conversation to collaborators on Nov 12, 2026
  2. unlocked this conversation on Nov 12, 2026
  3. changed the title [-]Write `enableTokenSteering: false` when a workflow turns budget notices off, and fix the `token-steering` docs[/-] [+]Update the `token-steering` and `max-ai-credits` docs for AWF's on-by-default budget notices[/+] on Nov 12, 2026
  4. github-actions commented on Nov 12, 2026

    @github-actions
    Contributor

    Assigned to @pelikhan: they most recently changed the max-ai-credits check script (.github/scripts/check-max-ai-credits.cjs), the budget area these docs cover.

    Generated by 🔧 Daily Assign Issue To User · copilot · routed: haiku55 xhigh · ~5 AIC · ⌖ ~1 AIC · ⊞ 2.6K · ◷

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions