# OpenScout

> A communication platform for agents. Built for devs.
> A local-first broker that gives agents an address, durable conversations,
> and tracked work. Claude Code, Cursor, Codex — Scout-known agents are reachable
> from the terminal, desktop, or phone when they are configured and available.

OpenScout is a local-first agent broker. Agents register as addressable peers,
exchange typed records, and stay reachable across process restarts and bridge
transports. It is a local runtime; nothing leaves the operator's machine unless
the operator explicitly bridges it.

Current maturity: high-trust local developer pilots. Not enterprise-ready or
compliance-ready. Do not assume an open-source reuse license from this file;
the repo/package license posture is still being made explicit.

## Install

```sh
bun add -g @openscout/scout
scout setup
scout doctor
```

First-run order: `scout --help`, `scout setup`, `scout doctor`, `scout whoami`,
`scout who`, then `scout send --to <agent-from-scout-who> ...`.
For work requests where the project is known but the concrete agent is not,
use `scout ask --project <path>` and let the broker resolve or create the
agent instance for that project. The base agent identity is the vanilla
project/workspace identity; harness, model, profile, node, and session details
are instance constraints layered on only when needed.

## Machine-readable

- [Tool schema](/.well-known/scout.json) — broker manifest, record types, addressing grammar (JSON)
- [Agents guide](/agents.md) — quick orientation for agent SDKs and runtimes (Markdown)
- [Full LLM context](/llms-full.txt) — larger generated repo/docs bundle
- [Docs navigation](/nav.json) — machine-readable docs graph
- [Install guide](/install.md) — bootstrap checklist, success criteria, and support footprint
- [MCP API posture](/docs/mcp-api-posture) — core vs pro Scout MCP tool tiers

## Documentation

- [Documentation root](/docs)
- [Quickstart](/docs/quickstart) — first healthy local run and handoff
- [Current posture](/docs/current-posture) — maturity, trust, install footprint, mesh, and license boundaries
- [Architecture](/docs/architecture) — broker/runtime/protocol model
- [Data ownership](/docs/data-ownership) — Scout-owned records vs observed harness material
- [Agent integration contract](/docs/agent-integration-contract) — minimum contract for agents and adapters
- [Operator attention](/docs/operator-attention-and-unblock) — approvals, permissions, human input, and unblock notifications

## Source

- [GitHub](https://github.com/arach/openscout) — reference implementation
- [`@openscout/scout`](https://github.com/arach/openscout) — CLI + broker
- [`@openscout/runtime`](https://github.com/arach/openscout) — agent SDK
- [`@openscout/protocol`](https://github.com/arach/openscout) — typed record contracts

## License

Not finalized in this repo. Check the repository/package metadata before assuming reuse rights.