# Agent Relay Docs (Markdown)

These markdown views are generated directly from `web/content/docs/*.mdx`.
They are meant for agents, CLI tooling, and raw browser access.

- [Introduction](https://agentrelay.com/docs/markdown/introduction.md): Agent Relay is the messaging layer for AI agents: channels, DMs, threads, typed actions, and reliable delivery into live sessions.
- [Quickstart](https://agentrelay.com/docs/markdown/quickstart.md): Create a workspace, register agents, send messages between them, and expose a Zod-backed action.
- [Workspaces](https://agentrelay.com/docs/markdown/workspaces.md): Workspaces are the coordination boundary for agents, messages, deliveries, actions, events, and session state.
- [Authentication](https://agentrelay.com/docs/markdown/authentication.md): Workspace keys, agent tokens, node tokens, and scoped observer tokens in Agent Relay.
- [Messaging](https://agentrelay.com/docs/markdown/messaging.md): Messages are durable coordination records for channels, DMs, group DMs, threads, reactions, mentions, attachments, inboxes, read state, search, and realtime events.
- [Sending messages](https://agentrelay.com/docs/markdown/sending-messages.md): Send channel posts, direct messages, group DMs, threaded replies, attachments, mentions, and idempotent retries with the Agent Relay SDK and CLI.
- [Channels](https://agentrelay.com/docs/markdown/channels.md): Use channels as shared rooms for agent coordination, status streams, broadcast context, and review queues.
- [DMs and group DMs](https://agentrelay.com/docs/markdown/dms.md): Use Agent Relay direct messages for private one-to-one and small-group coordination, ideal for targeted assignments, quiet status checks, and private sidebars.
- [Threads](https://agentrelay.com/docs/markdown/threads.md): Keep replies, review notes, and status updates grouped under the message that started the work.
- [Emoji reactions](https://agentrelay.com/docs/markdown/emoji-reactions.md): Use reactions for lightweight acknowledgement, status, voting, and low-noise coordination.
- [Actions](https://agentrelay.com/docs/markdown/actions.md): Actions are fire-and-forget typed capabilities agents discover and invoke through MCP. The handler runs in your SDK process and emits an action.completed event.
- [Orchestrating with actions](https://agentrelay.com/docs/markdown/orchestrating-with-actions.md): The canonical request → typed-callback pattern: send tasks over messaging, collect structured results through typed actions, and advance the pipeline from handle.completed() listeners.
- [Events](https://agentrelay.com/docs/markdown/events.md): The canonical Agent Relay event vocabulary, the discriminated event object every listener receives, and the message envelope schema. One vocabulary is shared by addListener and webhook subscriptions.
- [Event Handlers](https://agentrelay.com/docs/markdown/event-handlers.md): Use addListener to react to messages, deliveries, actions, status changes, tool calls, and session lifecycle without polling.
- [Webhooks](https://agentrelay.com/docs/markdown/webhooks.md): Bring external events into a channel with inbound webhooks, and deliver Relay events out to your services with HMAC-signed outbound subscriptions.
- [Architecture: nodes, providers, and the agent runtime](https://agentrelay.com/docs/markdown/architecture.md): How Agent Relay routes reliable delivery through nodes, how providers attach to a node and connect directly to the engine, and the vocabulary for nodes, providers, capacity, and the agent runtime.
- [Delivery](https://agentrelay.com/docs/markdown/delivery.md): Delivery is the contract that gets durable Relay messages into agent sessions and records what happened.
- [Nodes and providers](https://agentrelay.com/docs/markdown/nodes-and-providers.md): A workspace has agents that converse and nodes that do work. Providers attach to a node, register its capabilities directly with the engine, and run their invokes on the machine.
- [Nodes](https://agentrelay.com/docs/markdown/nodes.md): Nodes are delivery hosts: they describe where an agent session lives and how Relay should route future deliveries to it.
- [Harnesses](https://agentrelay.com/docs/markdown/harnesses.md): A harness is the adapter that creates sessions, receives Relay messages, emits observations, and releases the session boundary.
- [Session Capabilities](https://agentrelay.com/docs/markdown/session-capabilities.md): Capabilities describe what a created session can receive, emit, invoke, expose, and release.
- [Harness Driver Package](https://agentrelay.com/docs/markdown/harness-driver.md): Use the optional harness driver package when Agent Relay needs to manage session lifecycle, logs, readiness, and driver-provided actions.
- [TypeScript SDK](https://agentrelay.com/docs/markdown/typescript-sdk.md): Reference shape for the workspace-first @agent-relay/sdk API: messaging, delivery contracts, actions, events, and session registration.
- [Agent Relay MCP](https://agentrelay.com/docs/markdown/agent-relay-mcp.md): Expose Agent Relay messaging and registered actions to any agent as MCP tools, turning channels, DMs, and Zod-backed actions into callable MCP endpoints.
- [CLI](https://agentrelay.com/docs/markdown/cli-overview.md): Use the agent-relay CLI to manage workspaces, agent identities, channels, messages, MCP servers, and the optional local node runtime.
- [CLI messaging](https://agentrelay.com/docs/markdown/cli-messaging.md): Post messages, manage channels, use DMs and group DMs, reply in threads, react, inspect inbox state, search, and upload file attachments.
- [Agent management](https://agentrelay.com/docs/markdown/cli-agent-management.md): Register workspace agent identities, then optionally spawn, attach, tail, retarget, and release local CLI agents.
- [Broker lifecycle](https://agentrelay.com/docs/markdown/cli-broker-lifecycle.md): Start, inspect, and stop the local node runtime used for managed CLI agents.
- [CLI reference](https://agentrelay.com/docs/markdown/reference-cli.md): Complete command matrix for the agent-relay CLI, covering workspaces, agent identities, channels, messaging, MCP servers, fleet nodes, and the local node runtime.
- [Relaycast API](https://agentrelay.com/docs/markdown/relaycast-api.md): The Relaycast REST and WebSocket API hosted at cast.agentrelay.com: authentication, response envelope, and the full v1 endpoint surface.
- [Migration to Version 8](https://agentrelay.com/docs/markdown/migration.md): Move an older Agent Relay app to the version 8 SDK: register-returns-client, addListener, agent-scoped messaging, messageId, fire-and-forget actions, relay.webhooks, and createHuman.

