docs(sdk): Document ACPAgent prompt context extensions and authentication#478
Conversation
Add documentation for the AgentContext prompt extensions feature (software-agent-sdk#2946) to the ACP Agent guide: - New 'Prompt Context (AgentContext)' section with usage example and explanation of the prompt assembly pipeline - Compatibility table showing which AgentContext fields work with ACP - New 'Authentication' section documenting ChatGPT subscription login priority and API key fallback - Updated 'What ACPAgent Does Not Support' to remove agent_context (now supported for prompt-only extensions) Co-authored-by: openhands <openhands@all-hands.dev>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
🟢 Good taste - Clear, well-structured documentation that properly documents the new ACPAgent features.
[RISK ASSESSMENT]
- [Overall PR]
⚠️ Risk Assessment: 🟢 LOW
Documentation-only change with no code modifications. The new sections follow established Mintlify conventions, use appropriate components (Note, tables, code highlights), and provide clear examples of the new prompt context and authentication features. The compatibility table is particularly helpful for users understanding which AgentContext fields work with ACPAgent.
VERDICT:
✅ Worth merging: Documentation accurately reflects the new features and follows repository conventions.
KEY INSIGHT:
The compatibility table and explicit explanation of which features are ACP-compatible prevents user confusion about the delegation model.
3 participants
Summary
Documents the new ACPAgent features from software-agent-sdk#2946 in the ACP Agent guide (
sdk/guides/agent-acp.mdx).Changes
New section: Prompt Context (AgentContext)
ACPAgentnow supportsagent_contextfor prompt-only extensions (skills, repo context, datetime, system/user message suffixes)AgentContextwith skills and a system message suffix_build_acp_prompt()→to_acp_prompt_context())AgentContextfields are ACP-compatible and which are rejected (e.g.secrets)New section: Authentication
~/.codex/auth.json) takes priority when presentANTHROPIC_API_KEY,OPENAI_API_KEY,GEMINI_API_KEY) serve as fallbackUpdated: What ACPAgent Does Not Support
agent_contextfrom the unsupported list (it is now supported for prompt-only extensions)This PR was created by an AI agent (OpenHands) on behalf of the user, in response to a review comment on software-agent-sdk#2946.