# wardrik_protocol v0.1.0-rc.6 - Table of Contents

> What Wardrik sends and takes: its events, as CloudEvents, and its operations, as OpenAPI.

## Pages

- [WardrikProtocol](readme.md)
- [Changelog](changelog.md)

## Modules

- [Wardrik.Activity](Wardrik.Activity.md): What an agent is doing now.
- [Wardrik.Agent](Wardrik.Agent.md): An agent, and the operations on one.
- [Wardrik.AgentResolved](Wardrik.AgentResolved.md): What an agent gets from the app that runs it: who it works for, its policies, MCP servers,
notify targets, channels and workspaces.

- [Wardrik.AgentRuntime](Wardrik.AgentRuntime.md): Resource use of a running agent. The numbers cover the agent's process, its current turn and
its running tool calls.

- [Wardrik.Agents](Wardrik.Agents.md): Operations on every agent the scope can see.
- [Wardrik.Audit](Wardrik.Audit.md): Operations on the deployment's audit log.
- [Wardrik.Authorization](Wardrik.Authorization.md): Where a person signs in for a call that waits on it: the `url`, and the `code` for a device sign-in.
- [Wardrik.Call](Wardrik.Call.md): A tool call an agent is running: its `id`, the tool's `name`, and `elapsed_ms`.
- [Wardrik.Channel](Wardrik.Channel.md): A behaviour for chat apps, like Slack, that people reach agents through.
- [Wardrik.Channel.Installation](Wardrik.Channel.Installation.md): A channel added to one workspace, such as a Slack app added to one Slack workspace.
- [Wardrik.Channel.Installations](Wardrik.Channel.Installations.md): A behaviour for storing the workspaces a channel is added to, each with its token.
- [Wardrik.Channel.Installations.Request](Wardrik.Channel.Installations.Request.md): Which installations a `Wardrik.Channel.Installations` callback acts on: the one in `workspace`,
or those `owner` added.
- [Wardrik.Channel.Notification](Wardrik.Channel.Notification.md): What `c:Wardrik.Channel.notify/2` posts: `notice`, in `room` of `workspace`.
- [Wardrik.ChannelResponse](Wardrik.ChannelResponse.md): A channel's response to its chat app: the `status`, `headers` and `body` to send unchanged.
- [Wardrik.Decision](Wardrik.Decision.md): A decided call: its `id`, and its `decision`, `:approved` or `:rejected`.
- [Wardrik.Definition](Wardrik.Definition.md): What an agent is and what it may do.
- [Wardrik.Deployment](Wardrik.Deployment.md): Operations on the deployment: listing its nodes, reading their resource use, and reloading
every agent's definition.
- [Wardrik.Event](Wardrik.Event.md): One event, as a CloudEvent.
- [Wardrik.Events](Wardrik.Events.md): Operations on the events of the agents named.
- [Wardrik.Forgotten](Wardrik.Forgotten.md): The result of forgetting many agents. `forgotten` lists the IDs forgotten. `kept` and `failed`
list `{id, why}` pairs.

- [Wardrik.Hook](Wardrik.Hook.md): Delivers a service's request to an agent's webhook trigger.
- [Wardrik.Interrupt](Wardrik.Interrupt.md): A call an agent waits on a person for.
- [Wardrik.Interrupts](Wardrik.Interrupts.md): Operations on the calls waiting on a person, across every agent the scope can see.
- [Wardrik.Message](Wardrik.Message.md): A message sent to an agent: its `id`, and the `cursor` its answer comes after.
- [Wardrik.Node](Wardrik.Node.md): One of the deployment's nodes: its `name`, and how many `agents` run on it.
- [Wardrik.NodeRuntime](Wardrik.NodeRuntime.md): Resource use of one node.
- [Wardrik.Nodes](Wardrik.Nodes.md): The deployment's `nodes`, how many of the agents on them are `running`, `idle` or `parked`, and
how many are `asleep`.

- [Wardrik.Notice](Wardrik.Notice.md): Tells someone what an agent did while nobody watched.
- [Wardrik.Page](Wardrik.Page.md): A page of `events`, and `next`, where to read on from.
- [Wardrik.Reply](Wardrik.Reply.md): An agent's answer: its `text`, the `message` it answers, and the `run` that wrote it.
- [Wardrik.Run](Wardrik.Run.md): One run of an agent: how it ended, how long it took, and what it used and cost.
- [Wardrik.Runs](Wardrik.Runs.md): An agent's `runs`, newest first, and their `totals`.
- [Wardrik.Runs.Totals](Wardrik.Runs.Totals.md): Totals across an agent's runs.
- [Wardrik.Runtime](Wardrik.Runtime.md): What `deployment.runtime` returns: resource use for each node in `nodes`, and the running
agents that use the most memory in `agents`.

- [Wardrik.Scope](Wardrik.Scope.md): Who an operation runs for. Every operation takes one.
- [Wardrik.Server](Wardrik.Server.md): A behaviour for what runs Wardrik's operations. `Wardrik` implements it.
- [Wardrik.Server.Follow](Wardrik.Server.Follow.md): What `c:Wardrik.Server.follow/2` sends and follows: `input` to `agent`, or to its
`conversation`, in `scope`.
- [Wardrik.Server.Request](Wardrik.Server.Request.md): An operation for `c:Wardrik.Server.run/1` or `c:Wardrik.Server.stream/1` to run: `operation`,
with `input`, in `scope`.
- [Wardrik.Timeline](Wardrik.Timeline.md): An agent's conversation as a person reads it, oldest first.
- [Wardrik.Trigger](Wardrik.Trigger.md): Asks an agent something without anyone typing. A trigger fires
- [Wardrik.Trigger.Webhook](Wardrik.Trigger.Webhook.md): A trigger's webhook. `secret` is a credential's name, as `${NAME}`. `verify` is `:shared` or
`:standard`.

- [WardrikProtocol](WardrikProtocol.md): Wardrik's wire format: events as CloudEvents, and operations as OpenAPI.

- Exceptions
  - [Wardrik.Error](Wardrik.Error.md): An operation's failure, as the protocol's `error`.