docs(sdk): Add guide for custom tools with remote agent server #177
Conversation
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
This guide documents how to use custom tools with a remote agent server by building a custom Docker image that includes tool implementations. Covers: - Overview and use cases for custom tools with remote servers - Architecture and workflow - Step-by-step implementation guide - Dynamic tool registration - Production deployment best practices - Troubleshooting common issues - Real-world example (bug reporting bot) References the complete example in the SDK repository: examples/02_remote_agent_server/05_custom_tool/ Relates to: OpenHands/software-agent-sdk#1381 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
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
This PR adds comprehensive documentation for using custom tools with remote agent servers in the OpenHands SDK.
Changes
New Guide
Added
sdk/guides/custom-tools-remote-agent.mdcovering:@register_toolUpdated Sidebar
Related PRs
Use Case
Addresses a common user need: collecting structured data from agent runs (e.g., bug reports from QA bots, test results, audit findings) where enforcing a specific schema is critical for downstream processing.
Co-authored-by: openhands openhands@all-hands.dev
@xingyaoww can click here to continue refining the PR