Skip to content

docs(enterprise): add Configuring ACP Agents guide - #759

Draft
jpshackelford wants to merge 3 commits into
mainfrom
docs/acp-litellm-configuration
Draft

docs(enterprise): add Configuring ACP Agents guide#759
jpshackelford wants to merge 3 commits into
mainfrom
docs/acp-litellm-configuration

Conversation

@jpshackelford

@jpshackelford jpshackelford commented Aug 25, 2026

Copy link
Copy Markdown
Member

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

  • OpenHands agent vs. ACP agent — quick comparison table; ACP runs the provider's own CLI inside the sandbox, and each ACP agent manages its own model routing (OHE's central model config applies to the OpenHands agent).
  • The Settings → Agent page — the real controls a user sees.
  • Three configuration scenarios (tabs):
    1. Provider subscription (Claude Pro/Max, ChatGPT, Google)
    2. Provider API key (Anthropic/OpenAI/Google)
    3. Your own LiteLLM / Bedrock proxy — the self-hosted BYO-proxy path
  • Which credential wins — the sign-in credential takes priority over the API key + base URL; the section spells out exactly which fields to leave blank per provider.
  • FAQ — no external keys needed with LiteLLM, per-agent model routing, the model-identifier handshake (no translation layer; the proxy just needs the model registered under the CLI's native name), model-not-found, "my proxy is ignored," changes apply to new conversations, enabling ACP, and custom servers.

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 in OpenHands/software-agent-sdk (settings/acp_providers.py, agent/acp_agent.py).

Navigation

Added to Enterprise → Integrations in docs.json (file renamed from the initial acp-litellm.mdx to acp-agents.mdx to 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.

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>
@jpshackelford jpshackelford added documentation Improvements or additions to documentation enterprise integrations labels Aug 25, 2026 — with OpenHands AI
@mintlify

mintlify Bot commented Aug 25, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview Aug 25, 2026, 2:49 PM

💡 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>
@jpshackelford jpshackelford changed the title docs(enterprise): add ACP agents with LiteLLM configuration guide docs(enterprise): add Configuring ACP Agents guide Aug 25, 2026
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enterprise integrations

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants