docs: fix agent-server Client SDK section with actual API#496
docs: fix agent-server Client SDK section with actual API#496VascoSch92 wants to merge 3 commits intomainfrom
Conversation
Replace non-existent AgentServerClient documentation with actual SDK usage. The previous documentation referenced a 'Client SDK' with AgentServerClient class that does not exist. This update replaces it with: - OpenHandsCloudWorkspace for OpenHands Cloud integration - APIRemoteWorkspace for custom runtime environments - RemoteConversation which is the actual API for remote agent execution Fixes #495 Co-authored-by: openhands <openhands@all-hands.dev>
This comment was marked as outdated.
This comment was marked as outdated.
- Replace usage examples with architecture diagram and pattern explanation - Add workspace types table showing dispatch behavior - Document RemoteConversation responsibilities - Link to existing guides for complete working examples Addresses review feedback about architecture docs focusing on design patterns rather than tutorial-style usage instructions. Co-authored-by: openhands <openhands@all-hands.dev>
This comment was marked as outdated.
This comment was marked as outdated.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Per sdk-arch-guidelines.md, link every component name to its source file. Co-authored-by: openhands <openhands@all-hands.dev>
all-hands-bot
left a comment
There was a problem hiding this comment.
🟢 Good taste - Successfully replaces fictional client SDK documentation with accurate workspace-based dispatch architecture.
The new content:
- Correctly documents the actual SDK components (RemoteConversation, workspace types)
- Follows architecture documentation guidelines (diagrams, component tables, links to source)
- Maintains clear separation between architecture (this page) and usage (linked guides)
- Resolves all previously identified issues
[RISK ASSESSMENT]
- [Overall PR]
⚠️ Risk Assessment: 🟢 LOW
Documentation-only change that corrects inaccurate information. No code changes, no breaking changes, no impact on functionality. The PR fixes a real problem (non-existent AgentServerClient) and replaces it with accurate architectural documentation.
VERDICT:
✅ Worth merging: Documentation is now accurate and follows best practices
KEY INSIGHT:
This PR demonstrates good engineering hygiene - fixing documentation to match reality rather than leaving users confused by references to non-existent APIs.
all-hands-bot
left a comment
There was a problem hiding this comment.
🟢 Good taste - Clean fix that replaces fictional client SDK documentation with accurate workspace-based dispatch architecture.
The PR successfully:
- Removes the non-existent
AgentServerClientclass documentation - Adds proper architecture-focused content (workspace-based dispatch pattern)
- Includes Mermaid diagram showing the Conversation factory pattern
- Links all components to GitHub source files
- Documents
RemoteConversationresponsibilities clearly - Links to usage guides for complete examples
- Follows architecture documentation guidelines
All previous review feedback has been incorporated. No issues found.
[RISK ASSESSMENT]
- [Overall PR]
⚠️ Risk Assessment: 🟢 LOW
Documentation-only change that removes incorrect information and replaces it with verified, accurate architecture documentation. No code modified. All referenced classes verified to exist and be importable.
VERDICT:
✅ Worth merging: Fixes real documentation issue with accurate, well-structured architecture content.
KEY INSIGHT:
Elegant solution that transforms fictional API documentation into a clear architectural explanation of the workspace-based dispatch pattern - exactly what architecture docs should be.
Summary
This PR fixes the outdated "Client SDK" documentation in the Agent Server architecture page.
Problem
The documentation at https://docs.openhands.dev/sdk/arch/agent-server#client-sdk referenced a non-existent
AgentServerClientclass:As reported in #495, there is no such client SDK module in the
openhands-sdkoropenhands-agent-serverpackages.Solution
Replace the fictional client SDK documentation with the actual SDK usage patterns:
OpenHandsCloudWorkspace- For connecting to OpenHands CloudAPIRemoteWorkspace- For custom runtime environmentsRemoteConversation- The actual class returned when using remote workspacesThe new documentation shows the correct pattern where
Conversation()factory automatically returns aRemoteConversationwhen given a remote workspace.Testing
openhands.clientmodule does not exist (ModuleNotFoundError)RemoteConversation,OpenHandsCloudWorkspace, andAPIRemoteWorkspacedo exist and are importableapi-sandbox.mdx,cloud-workspace.mdx)Fixes #495
This PR was created by an AI agent (OpenHands) on behalf of the user.
@VascoSch92 can click here to continue refining the PR