Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ This repository contains a TypeScript client library for the OpenHands Agent Ser

The client is designed to mirror the structure and functionality of the Python SDK (`software-agent-sdk`) while providing idiomatic TypeScript/JavaScript APIs with full type safety and modern development tooling.

## Cross-Repository Boundaries

This repository owns the browser-compatible TypeScript client for the OpenHands Agent Server API. The canonical API implementation and behavior belong to [`OpenHands/software-agent-sdk`](https://github.com/OpenHands/software-agent-sdk); [`OpenHands/OpenHands`](https://github.com/OpenHands/OpenHands) consumes this client for Agent Canvas UI; and [`OpenHands/extensions`](https://github.com/OpenHands/extensions) owns reusable skills, plugins, automations, and integrations; [`OpenHands/automation`](https://github.com/OpenHands/automation) owns scheduling, webhooks, run history, and dispatching.

The normal flow is SDK/Agent Server → OpenAPI contract → this client → Agent Canvas. Keep backend behavior and endpoints in the SDK, typed API access here, UI in Agent Canvas, and automation lifecycle behavior in `automation`. If a PR is opened in the wrong repository, explicitly recommend closing and moving it to the owning repository rather than merging it here.

All pull requests must follow the repository's contribution and applicable code-review guidance.

## Key Features

- **Complete API Coverage**: Implements all endpoints from the OpenHands Agent Server OpenAPI specification
Expand Down
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,10 @@ python scripts/check-acp-drift.py

## Pull requests

- Confirm the change belongs in `typescript-client`: backend behavior and endpoints belong in [`software-agent-sdk`](https://github.com/OpenHands/software-agent-sdk), UI belongs in [`OpenHands/OpenHands`](https://github.com/OpenHands/OpenHands), and scheduling/webhooks/dispatch belong in [`OpenHands/automation`](https://github.com/OpenHands/automation).
- If a PR is opened in the wrong repository, recommend closing and moving it to the repository that owns the change.
- Open focused PRs with a clear description of what changed and why.
- Make sure the relevant checks pass before requesting review.
- Follow the repository's applicable code-review guidance and make sure the relevant checks pass before requesting review.
- Use conventional prefixes in the PR title when possible, such as `feat`,
`fix`, `docs`, `refactor`, `test`, `build`, `ci`, or `chore`.
- Include screenshots or recordings when changing user-facing example apps or
Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,13 @@ Pinned PR CI is reproducible and required. A separate weekly
`main` commit, records that SHA, and opens or updates an informational drift
issue. Ordinary client PRs never generate from the moving SDK branch.


## Repository boundaries

This repository owns the browser-compatible typed client for the OpenHands Agent Server API. [`OpenHands/software-agent-sdk`](https://github.com/OpenHands/software-agent-sdk) owns the canonical API implementation, Agent Server, and agent behavior; [`OpenHands/OpenHands`](https://github.com/OpenHands/OpenHands) consumes this client for Agent Canvas UI; and [`OpenHands/extensions`](https://github.com/OpenHands/extensions) owns reusable skills, plugins, automations, and integrations; [`OpenHands/automation`](https://github.com/OpenHands/automation) owns scheduling, webhooks, run history, and dispatching.

The normal flow is SDK/Agent Server → OpenAPI contract → this client → Agent Canvas. Add typed endpoint access here, backend behavior in the SDK, UI in Canvas, and automation lifecycle behavior in `automation`. A PR opened in the wrong repository should be closed and moved to the repository that owns the change.

## Quick Start

### Start an AgentServer
Expand Down
Loading