docs(enterprise): add Configuring ACP Agents guide - #759
Draft
jpshackelford wants to merge 3 commits into
Draft
Conversation
Document how to route Claude Code, Codex, and Gemini CLI ACP agents through a customer-managed LiteLLM/Bedrock proxy on OpenHands Enterprise. Covers where the ACP subprocess runs (inside the sandbox), the per-provider API key + base URL settings, which precedence credentials to leave blank, and the model-identifier handshake between each CLI and the proxy. 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. |
Refocus the guide around the Settings -> Agent page and real user scenarios instead of architecture internals: - Rename to enterprise/integrations/acp-agents.mdx (broader than LiteLLM) - Add OpenHands-agent vs ACP-agent comparison and a plain-language explanation of what the ACP agent is and that it runs in the sandbox - Describe the actual Settings -> Agent controls (Preset, Command, Model, Credentials) using the real UI labels - Present three configuration scenarios as tabs: provider subscription, provider API key, and your own LiteLLM/Bedrock proxy - Add a 'Which credential wins' section and an FAQ covering the common questions (no external keys with LiteLLM, per-agent model routing, model-identifier handshake, model-not-found, ignored proxy) Co-authored-by: openhands <openhands@all-hands.dev>
Make the CODEX_AUTH_JSON sign-in step more consumable: copy the file straight to the clipboard with 'cat ~/.codex/auth.json | pbcopy' and paste, with a Linux equivalent. Also applies to Gemini's SA JSON blob. Co-authored-by: openhands <openhands@all-hands.dev>
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
Adds a user-facing OpenHands Enterprise guide, Configuring ACP Agents (
enterprise/integrations/acp-agents.mdx), covering how to set up Claude Code, Codex, and Gemini CLI on OHE. It answers the customer thread (Sina / C3, self-hosted OHE 1.54.0), including the "point ACP CLIs at our LiteLLM/Bedrock proxy" scenario.Approach
Written as a configuration + FAQ guide grounded in the actual Settings → Agent page (Preset, Command, Model, Credentials), rather than an architecture deep-dive. It keeps a short, plain-language explanation of what an ACP agent is and how it differs from the OpenHands agent, then focuses on getting people configured correctly.
What the guide covers
Accuracy / grounding
Cross-checked against the OHE frontend Settings → Agent implementation (
agent-settings.tsx,acp-credentials-section.tsx,use-acp-credential-form.ts,acp-provider-secrets.ts, and the i18n strings) and the SDK behavior inOpenHands/software-agent-sdk(settings/acp_providers.py,agent/acp_agent.py).Navigation
Added to Enterprise → Integrations in
docs.json(file renamed from the initialacp-litellm.mdxtoacp-agents.mdxto reflect the broader scope).Reviewer
Requesting @simonrosenberg as the ACP expert to confirm the routing details and the credential-precedence guidance.
This PR was created by an AI agent (OpenHands) on behalf of the requester.