OpenHands frontend-api-contracts

This skill should be used when the user asks to "add an API call", "change a backend", "update settings persistence", "change conversation events", "fix backend auth", "add Agent Server support", or changes src/api, backend registry, Cloud/runtime transport, settings, secrets, compatibility, or conversation resume behavior.

install

source · Clone the upstream repo

git clone https://github.com/OpenHands/OpenHands

Claude Code · Install into ~/.claude/skills/

T=$(mktemp -d) && git clone --depth=1 https://github.com/OpenHands/OpenHands "$T" && mkdir -p ~/.claude/skills && cp -r "$T/.agents/skills/frontend-api-contracts" ~/.claude/skills/all-hands-ai-openhands-frontend-api-contracts && rm -rf "$T"

manifest: .agents/skills/frontend-api-contracts/SKILL.md

source content

Frontend API and Backend Contracts

Keep Canvas as a typed consumer of Agent Server and Cloud contracts. Preserve repository ownership, compatibility floors, transport boundaries, authentication modes, and durable state invariants.

Workflow

Read
```
references/guide.md
```
before modifying frontend API access, backend selection, settings, secrets, Agent Server compatibility, or Cloud runtime behavior.
Determine whether the contract belongs in
```
software-agent-sdk
```
and its TypeScript client before adding Canvas code.
Use typed clients and centralized option builders for Agent Server/runtime calls; use
```
callCloudProxy
```
only for Cloud App-API calls.
Raise
```
compatibility.minimumAgentServer
```
when Canvas begins requiring new server behavior.
Verify Local and Cloud paths, authentication, persistence transitions, and affected conversation modes.
Run the direct-call guard and focused API/state tests.

Reference

references/guide.md
— API transport rules, allowed exceptions, published-client constraints, compatibility conventions, backend registry and auth behavior, settings/secrets persistence, backend UI invariants, and Cloud resume gating.