Document Agent Server orchestration clients and workspace-independent automation

Open

#792 opened on Sep 12, 2026 1 comment 0 reactions 1 assignee View on GitHub

@neubig is already working on this.

Since Sep 14, 2026.

Assessment

This issue has not been assessed yet.

Description

Desired Behavior

Document the public Python Agent Server control/runtime clients from OpenHands/software-agent-sdk#5009, including workspace-independent operation, scoped credentials, saved-profile creation, command dispatch/output, and release. Explain when to use these orchestration clients versus the existing Conversation/Workspace APIs.

Acceptance Criteria

Add a guide with executable sync and async examples using public SDK methods, without constructing runtime HTTP paths.
Explain that local and Docker workspaces use the same bundle-facing contract and that runtime selection belongs to the dispatcher/server.
Describe credential handoff, scope, lifecycle ownership, and the release/version dependency.
Link the guide from Agent Server documentation and cross-reference the SDK PR.

This issue is ready-for-dev.

Dominant language: MDX
Stars: 12
Forks: 55
Avg merge: 21h 11m
Merged PRs (30d): 33

Contributor guide

No contributing guide indexed for this repository

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.