The guides teach one task at a time. The package references describe method shapes,
configuration and errors in more detail. Match them to your installed release;
GitHub main may include changes newer than the published package.
| Interface | Guide and reference |
|---|---|
| Harness startup and shutdown | Desktop tutorial · TypeScript reference · Rust reference |
| Providers and credentials | Models and keys |
| Agent definitions and tool callbacks | Tools and MCP |
| Session creation, follow-ups and recovery | Sessions |
| Structured messages and files | Attachments |
| Delegation and coordinated work | Sub-agents and teams |
| Streaming, cancellation and interruptions | Streaming and retries |
| Approvals and review | Agent alignment |
| Recording and export | Observability |
| Remote service and management | Service CLI · Deployment |
Find the exact types
The npm package includes TypeScript declarations. Use your editor’s Go to Definition
on Harness, Agent, Session or a configuration type to read the installed
version. Generate Rust API documentation from your pinned checkout with:
cargo doc --manifest-path harness/Cargo.toml -p openworker-sdk --no-deps --openFor release pins and native runtime requirements, see versions and installation.