debug-test-examples-workflow

<a name="readme-top"></a>

<div align="center"> <img src="https://raw.githubusercontent.com/OpenHands/docs/main/openhands/static/img/logo.png" alt="Logo" width="200"> <h1 align="center">OpenHands Software Agent SDK </h1> </div> <div align="center"> <a href="https://github.com/OpenHands/software-agent-sdk/blob/main/LICENSE"><img src="https://img.shields.io/github/license/OpenHands/software-agent-sdk?style=for-the-badge&color=blue" alt="MIT License"></a> <a href="https://openhands.dev/joinslack"><img src="https://img.shields.io/badge/Slack-Join%20Us-red?logo=slack&logoColor=white&style=for-the-badge" alt="Join our Slack community"></a> <br> <a href="https://docs.openhands.dev/sdk"><img src="https://img.shields.io/badge/Documentation-000?logo=googledocs&logoColor=FFE165&style=for-the-badge" alt="Check out the documentation"></a> <a href="https://arxiv.org/abs/2511.03690"><img src="https://img.shields.io/badge/Paper-000?logoColor=FFE165&logo=arxiv&style=for-the-badge" alt="Tech Report"></a> <a href="https://docs.google.com/spreadsheets/d/1wOUdFCMyY6Nt0AIqF705KN4JKOWgeI4wUGUP60krXXs/edit?gid=811504672#gid=811504672"><img src="https://img.shields.io/badge/SWEBench-77.6-000?logoColor=FFE165&style=for-the-badge" alt="Benchmark Score"></a> <br> <!-- Keep these links. Translations will automatically update with the README. --> <a href="https://www.readme-i18n.com/OpenHands/software-agent-sdk?lang=de">Deutsch</a> | <a href="https://www.readme-i18n.com/OpenHands/software-agent-sdk?lang=es">Español</a> | <a href="https://www.readme-i18n.com/OpenHands/software-agent-sdk?lang=fr">français</a> | <a href="https://www.readme-i18n.com/OpenHands/software-agent-sdk?lang=ja">日本語</a> | <a href="https://www.readme-i18n.com/OpenHands/software-agent-sdk?lang=ko">한국어</a> | <a href="https://www.readme-i18n.com/OpenHands/software-agent-sdk?lang=pt">Português</a> | <a href="https://www.readme-i18n.com/OpenHands/software-agent-sdk?lang=ru">Русский</a> | <a href="https://www.readme-i18n.com/OpenHands/software-agent-sdk?lang=zh">中文</a> <hr> </div>

The OpenHands Software Agent SDK is a set of Python and REST APIs for building agents that work with code.

You can use the OpenHands Software Agent SDK for:

• One-off tasks, like building a README for your repo
• Routine maintenance tasks, like updating dependencies
• Major tasks that involve multiple agents, like refactors and rewrites

Importantly, agents can either use the local machine as their workspace, or run inside ephemeral workspaces (e.g. in Docker or Kubernetes) using the Agent Server.

You can even use the SDK to build new developer experiences: it’s the engine behind the OpenHands CLI and OpenHands Cloud.

Get started with some examples or check out the docs to learn more.

Quick Start

Here's what building with the SDK looks like:

import os

from openhands.sdk import LLM, Agent, Conversation, Tool
from openhands.tools.file_editor import FileEditorTool
from openhands.tools.task_tracker import TaskTrackerTool
from openhands.tools.terminal import TerminalTool


llm = LLM(
    model="anthropic/claude-sonnet-4-5-20250929",
    api_key=os.getenv("LLM_API_KEY"),
)

agent = Agent(
    llm=llm,
    tools=[
        Tool(name=TerminalTool.name),
        Tool(name=FileEditorTool.name),
        Tool(name=TaskTrackerTool.name),
    ],
)

cwd = os.getcwd()
conversation = Conversation(agent=agent, workspace=cwd)

conversation.send_message("Write 3 facts about the current project into FACTS.txt.")
conversation.run()
print("All done!")

For installation instructions and detailed setup, see the Getting Started Guide.

Documentation

For detailed documentation, tutorials, and API reference, visit:

https://docs.openhands.dev/sdk

The documentation includes:

• Getting Started Guide - Installation and setup
• Architecture & Core Concepts - Agents, tools, workspaces, and more
• Guides - Hello World, custom tools, MCP, skills, and more
• API Reference - Agent Server REST API documentation

Examples

The examples/ directory contains comprehensive usage examples:

• Standalone SDK (examples/01_standalone_sdk/) - Basic agent usage, custom tools, and microagents
• Remote Agent Server (examples/02_remote_agent_server/) - Client-server architecture and WebSocket connections
• GitHub Workflows (examples/03_github_workflows/) - CI/CD integration and automated workflows

Contributing

For development setup, testing, and contribution guidelines, see DEVELOPMENT.md.

Community

• Join Slack - Connect with the OpenHands community
• GitHub Repository - Source code and issues
• Documentation - Complete documentation

Cite

@misc{wang2025openhandssoftwareagentsdk,
      title={The OpenHands Software Agent SDK: A Composable and Extensible Foundation for Production Agents}, 
      author={Xingyao Wang and Simon Rosenberg and Juan Michelini and Calvin Smith and Hoang Tran and Engel Nyst and Rohit Malhotra and Xuhui Zhou and Valerie Chen and Robert Brennan and Graham Neubig},
      year={2025},
      eprint={2511.03690},
      archivePrefix={arXiv},
      primaryClass={cs.SE},
      url={https://arxiv.org/abs/2511.03690}, 
}