Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
0b7467e
docs: standardize SDK guides format and merge reasoning documentation
xingyaoww Oct 21, 2025
41be81b
remove agent-server api
xingyaoww Oct 21, 2025
c91e368
done with llm and condenser
xingyaoww Oct 21, 2025
ae0881e
sync(openapi): agent-sdk/main cab92fc
all-hands-bot Oct 21, 2025
bed1ef2
rename tab to sdk
xingyaoww Oct 21, 2025
35f7b0b
Merge branch 'main' into xw/sdk
xingyaoww Oct 21, 2025
a215e48
Merge commit '35f7b0b67170ee67cec4620cdd4095004827e00f' into xw/sdk
xingyaoww Oct 21, 2025
6fc72c7
merge convo cost
xingyaoww Oct 21, 2025
c26f0a4
merge confirmation mode
xingyaoww Oct 21, 2025
1e64616
docs: sync code blocks from agent-sdk examples
github-actions[bot] Oct 21, 2025
8461f56
link to llm registry
xingyaoww Oct 21, 2025
fc560a9
rename and some improvements
xingyaoww Oct 21, 2025
0375219
fix image input
xingyaoww Oct 21, 2025
66ab264
fix pause and resume
xingyaoww Oct 21, 2025
307870c
improve secrets
xingyaoww Oct 21, 2025
0a26347
done with interactive terminal
xingyaoww Oct 21, 2025
0c2d58d
audited browser-use doc
xingyaoww Oct 21, 2025
a98faaa
add stuck detector
xingyaoww Oct 21, 2025
0602d16
improve custom planning agent
xingyaoww Oct 21, 2025
d503f1c
rename
xingyaoww Oct 21, 2025
7d8635f
fix broken link
xingyaoww Oct 21, 2025
a651e92
remove stuff not ready yet
xingyaoww Oct 21, 2025
f37b3e1
fix typo
xingyaoww Oct 22, 2025
45f3c0b
docs: sync code blocks from agent-sdk examples
github-actions[bot] Oct 22, 2025
8a71612
Merge branch 'main' into xw/sdk
xingyaoww Oct 22, 2025
ee1eccc
Merge commit 'b419a23b49be3ee1b701e018d026643fc9c98e90' into xw/sdk
xingyaoww Oct 22, 2025
6450938
make llm routing expandable
xingyaoww Oct 22, 2025
d8890e1
Revert "remove stuff not ready yet"
xingyaoww Oct 22, 2025
45ab46e
Merge commit '114842042edeead65560d6622d6af5f307126f85' into xw/sdk
xingyaoww Oct 22, 2025
e4dd99f
rename to agent-sdk
xingyaoww Oct 22, 2025
f66f005
initial rewrite
xingyaoww Oct 22, 2025
5a28398
rename
xingyaoww Oct 22, 2025
6424cbc
improve agent-server overview
xingyaoww Oct 22, 2025
64f58d5
audited local server
xingyaoww Oct 22, 2025
51f83bc
improve remote agent server doc
xingyaoww Oct 22, 2025
d3b2687
remove
xingyaoww Oct 22, 2025
f61e250
tweak
xingyaoww Oct 22, 2025
029ded2
simplify docker sandbox documentation
xingyaoww Oct 22, 2025
db6de52
tweaks
xingyaoww Oct 22, 2025
383a3e6
improve docs
xingyaoww Oct 22, 2025
83c8bad
remove arch docs
xingyaoww Oct 22, 2025
dc53f31
allow sync code block to work with abitrary file
xingyaoww Oct 22, 2025
7616ccf
fix
xingyaoww Oct 22, 2025
2ccaabf
update workflow
xingyaoww Oct 22, 2025
e834c05
Merge branch 'main' into xw/workflows
xingyaoww Oct 23, 2025
972d3cd
Revise TODO Management guide for OpenHands Agent
simonrosenberg Oct 23, 2025
6a41785
docs: sync code blocks from agent-sdk examples
github-actions[bot] Oct 23, 2025
37880d4
Revise PR Review guide for clarity and detail
simonrosenberg Oct 23, 2025
89b0452
Replace routine-maintenance.mdx with assign-reviews.mdx
openhands-agent Oct 23, 2025
34eb647
Simplify assign reviews guide content
simonrosenberg Oct 23, 2025
71a3365
Update description of OpenHands Agent's TODO handling
simonrosenberg Oct 23, 2025
5b64e51
Fix grammar in PR review guide
simonrosenberg Oct 23, 2025
d9f2ad3
Update description for assigning reviewers
simonrosenberg Oct 23, 2025
83271a8
Simplify feedback description in PR review guide
simonrosenberg Oct 23, 2025
422dcd6
Update wording for TODO comment scanning description
simonrosenberg Oct 23, 2025
d48eb0b
Apply suggestion from @xingyaoww
xingyaoww Oct 23, 2025
efe24fc
Update sdk/guides/github-workflows/pr-review.mdx
xingyaoww Oct 23, 2025
811929b
Merge branch 'main' into xw/workflows
enyst Oct 23, 2025
20f8afc
Update links in assign-reviews documentation
simonrosenberg Oct 23, 2025
52e3218
Reorder related files in assign-reviews.mdx
simonrosenberg Oct 23, 2025
6b6a689
Clarify GitHub workflow and related files
simonrosenberg Oct 23, 2025
573a145
Update GitHub link for assign reviews example
simonrosenberg Oct 23, 2025
011afce
Fix link formatting in assign-reviews.mdx
simonrosenberg Oct 23, 2025
63c44d0
Update assign-reviews.mdx
simonrosenberg Oct 23, 2025
48cb424
docs(sdk): point agent-sdk links to OpenHands/agent-sdk and fix incor…
enyst Oct 23, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,9 @@
{
"group": "GitHub Workflows",
"pages": [
"sdk/guides/github-workflows/assign-reviews",
"sdk/guides/github-workflows/pr-review",
"sdk/guides/github-workflows/todo-management"
]
}
]
Expand Down
30 changes: 30 additions & 0 deletions sdk/guides/github-workflows/assign-reviews.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Assign Reviews
description: Automatically assign relevant reviewers to pull requests using OpenHands Agent
---

<Note>
This example is available on GitHub: [.github/workflows/assign-reviews.yml](https://github.com/OpenHands/agent-sdk/blob/main/.github/workflows/assign-reviews.yml)
</Note>

Automatically assign relevant reviewers to pull requests based on code changes and file ownership using OpenHands Agent.
This workflow uses the basic action workflow template that allows to perform any basic action with the OpenHands Agent.

## Quick Start

```bash
# 1. Copy workflow to your repository
cp examples/03_github_workflows/04_assign_reviews/workflow.yml .github/workflows/assign-reviews.yml

# 2. Configure secrets in GitHub Settings → Secrets
# Add: LLM_API_KEY

# 3. Configure GitHub Actions permissions
# Settings → Actions → General → Workflow permissions
# Enable: "Read and write permissions"
```

## Related Files

- [Basic Action Agent Script](https://github.com/OpenHands/agent-sdk/blob/main/examples/03_github_workflows/01_basic_action/agent_script.py)
- [Workflow File](https://github.com/OpenHands/agent-sdk/blob/main/.github/workflows/assign-reviews.yml)
39 changes: 39 additions & 0 deletions sdk/guides/github-workflows/pr-review.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: PR Review
description: Use OpenHands Agent to generate meaningful pull request review
---

<Note>
This example is available on GitHub: [examples/03_github_workflows/02_pr_review/](https://github.com/OpenHands/agent-sdk/tree/main/examples/03_github_workflows/02_pr_review)
</Note>

Automatically review pull requests when labeled with `review-this`, providing feedback on code quality, security, and best practices.

```yaml icon="yaml" expandable agent-sdk/examples/03_github_workflows/01_basic_action/workflow.yml

```

## Quick Start

```bash
# 1. Copy workflow to your repository
cp examples/03_github_workflows/02_pr_review/workflow.yml .github/workflows/pr-review.yml

# 2. Configure secrets in GitHub Settings → Secrets
# Add: LLM_API_KEY

# 3. Create a "review-this" label in your repository
# Go to Issues → Labels → New label
```

## Features

- **Automatic Trigger** - Reviews start when `review-this` label is added and is posted on the PR in only 2 or 3 minutes
- **Comprehensive Analysis** - Analyzes the changes given the repository context. Covers code quality, security, best practices
- **GitHub Integration** - Posts comments directly to the PR

## Related Files

- [Agent Script](https://github.com/OpenHands/agent-sdk/blob/main/examples/03_github_workflows/02_pr_review/agent_script.py)
- [Workflow File](https://github.com/OpenHands/agent-sdk/blob/main/examples/03_github_workflows/02_pr_review/workflow.yml)
- [Prompt Template](https://github.com/OpenHands/agent-sdk/blob/main/examples/03_github_workflows/02_pr_review/prompt.py)
48 changes: 48 additions & 0 deletions sdk/guides/github-workflows/todo-management.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: TODO Management
description: Implement TODOs using OpenHands Agent
---

<Note>
This example is available on GitHub: [examples/03_github_workflows/03_todo_management/](https://github.com/OpenHands/agent-sdk/tree/main/examples/03_github_workflows/03_todo_management)
</Note>

Scan your codebase for TODO comments and let the OpenHands Agent implement them, creating a pull request for each TODO and picking relevant reviewers based on code changes and file ownership

## Quick Start

```bash
# 1. Copy workflow to your repository
cp examples/03_github_workflows/03_todo_management/workflow.yml .github/workflows/todo-management.yml

# 2. Configure secrets in GitHub Settings → Secrets
# Add: LLM_API_KEY

# 3. Configure GitHub Actions permissions
# Settings → Actions → General → Workflow permissions
# Enable: "Read and write permissions" + "Allow GitHub Actions to create and approve pull requests"

# 4. Add TODO comments to your code
# Example: # TODO(openhands): Add input validation for user email
```

The workflow is configurable and any identifier can be used in place of `TODO(openhands)`

## Features

- **Scanning** - Finds matching TODO comments with configurable identifiers and extracts the TODO description.
- **Implementation** - Sends the TODO description to the OpenHands Agent that automatically implements it
- **PR Management** - Creates feature branches, pull requests and picks most relevant reviewers

## Best Practices

- **Start Small** - Begin with `MAX_TODOS: 1` to test the workflow
- **Clear Descriptions** - Write descriptive TODO comments
- **Review PRs** - Always review the generated PRs before merging

## Related Documentation

- [Agent Script](https://github.com/OpenHands/agent-sdk/blob/main/examples/03_github_workflows/03_todo_management/agent_script.py)
- [Scanner Script](https://github.com/OpenHands/agent-sdk/blob/main/examples/03_github_workflows/03_todo_management/scanner.py)
- [Workflow File](https://github.com/OpenHands/agent-sdk/blob/main/examples/03_github_workflows/03_todo_management/workflow.yml)
- [Prompt Template](https://github.com/OpenHands/agent-sdk/blob/main/examples/03_github_workflows/03_todo_management/prompt.py)