# wardrik v0.1.0-rc.1 - Table of Contents

> Agents, governed: rules the model can't rewrite, approvals, budgets, and a record of what they did.

## Pages

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

- See it in action
  - [Wardrik in ten minutes](tour-demo.md)
  - [Rules the model can't rewrite](policies-demo.md)
  - [A person in the loop](approvals-demo.md)
  - [Give agents tools](tools-demo.md)
  - [Spend you can cap](budgets-demo.md)
  - [Agents that survive a crash](durability-demo.md)
  - [Agents that wake themselves](triggers-demo.md)
  - [See everything an agent did](events-demo.md)
  - [Who may do what](access-demo.md)

- Guides
  - [Run Wardrik](running-wardrik.md)
  - [Talk to agents](talking.md)
  - [Define agents](definitions.md)
  - [Trigger agents](triggers.md)
  - [Policies](policies.md)
  - [Orgs](orgs.md)
  - [Access](access.md)
  - [Operations](operations.md)
  - [Approvals](approvals.md)
  - [MCP servers](servers.md)
  - [Credentials and sign-ins](credentials.md)
  - [Events and the audit](events.md)

## Modules

- [Wardrik](Wardrik.md): Agents, governed: the agents your app runs, the policies they're held to, and the operations
people and programs reach them through.
- [Wardrik.AgentTools](Wardrik.AgentTools.md): Tools that let an agent work with agents: `agents/*` for the other agents in its org, and
`self/*` for itself.
- [Wardrik.Answers](Wardrik.Answers.md): Follows the run that answers a message, through the agent's log.
- [Wardrik.Authorizer](Wardrik.Authorizer.md): Decides whether a scope may take an action on a resource.
- [Wardrik.Catalog](Wardrik.Catalog.md): Maps each `WardrikProtocol` operation to its handler and its compiled input schema.
- [Wardrik.Ceiling](Wardrik.Ceiling.md): A budget all of an org's agents share. Set ceilings in the org's `Wardrik.OrgSettings`
- [Wardrik.Ceiling.Reached](Wardrik.Ceiling.Reached.md): The interrupt a model call waits on once its org's agents reach a ceiling's limit.
- [Wardrik.Channels](Wardrik.Channels.md): Installs Wardrik's chat apps into people's workspaces, from your app's own pages.
- [Wardrik.Children](Wardrik.Children.md): The processes Wardrik supervises, in start order
- [Wardrik.Compaction](Wardrik.Compaction.md): Middleware that summarises an agent's older history when a turn starts.
- [Wardrik.Declarations](Wardrik.Declarations.md): Agents defined outside the API, such as agent files a daemon reads.
- [Wardrik.Definitions](Wardrik.Definitions.md): Stores each agent's definition as it was given.
- [Wardrik.Delegation](Wardrik.Delegation.md): Sends an agent's answer back to the agent that asked with `agent_ask`.
- [Wardrik.Egress](Wardrik.Egress.md): Decides which URLs users may point Wardrik at, such as when an org adds an MCP server.
- [Wardrik.HTTP](Wardrik.HTTP.md): Serves Wardrik over HTTP. See `WardrikHTTP` for the routes.
- [Wardrik.JSON](Wardrik.JSON.md): Turns view results into JSON-ready operation results.
- [Wardrik.Keys](Wardrik.Keys.md): Finds the API keys an agent's code calls services with. Implements `WardrikCore.Keys`.
- [Wardrik.Listener](Wardrik.Listener.md): Follows agents' events into your app.
- [Wardrik.MCPTools](Wardrik.MCPTools.md): Gives an agent the tools of the MCP servers it names. Implements `WardrikCore.Capability`.
- [Wardrik.Notify](Wardrik.Notify.md): Tells people when an agent parks, fails or finishes while nobody is watching.
- [Wardrik.Notify.Follower](Wardrik.Notify.Follower.md): Follows every agent's log for `Wardrik.Notify.Server`.
- [Wardrik.Notify.Room](Wardrik.Notify.Room.md): Posts notices to a room in one of Wardrik's channels, with `c:Wardrik.Channel.notify/4`.
- [Wardrik.Notify.Server](Wardrik.Notify.Server.md): Sends notices. One runs per cluster.
- [Wardrik.Notify.Webhook](Wardrik.Notify.Webhook.md): Posts notices as JSON to a URL.
- [Wardrik.Operations.Agent](Wardrik.Operations.Agent.md): Operations on one agent: messaging it, deciding what it waits on, and reading it.
- [Wardrik.Operations.Agents](Wardrik.Operations.Agents.md): Operations over the agents that resource patterns cover: listing them and their events.
- [Wardrik.Operations.Changes](Wardrik.Operations.Changes.md): Records changes made through Wardrik in the audit, with who made them.
- [Wardrik.Operations.Channels](Wardrik.Operations.Channels.md): Passes chat apps' requests to Wardrik's channels.
- [Wardrik.Operations.Deployment](Wardrik.Operations.Deployment.md): Operations on the deployment: the audit, nodes, moving agents and reloading.
- [Wardrik.Operations.Lifecycle](Wardrik.Operations.Lifecycle.md): Operations on an agent's lifecycle: defining, starting, stopping, clearing and forgetting it,
and killing its tool calls.

- [Wardrik.Operations.Owners](Wardrik.Operations.Owners.md): Operations on what an org or person holds for their agents: connected accounts, secrets and
MCP servers.

- [Wardrik.Operations.Running](Wardrik.Operations.Running.md): Finds the agents operations act on, waking them from their definitions if needed.
- [Wardrik.Operations.Snapshot](Wardrik.Operations.Snapshot.md): Reads agents' status and logs for operations.
- [Wardrik.Operations.Tokens](Wardrik.Operations.Tokens.md): Operations on the deployment's API tokens: creating, listing and revoking.
- [Wardrik.Operations.Triggers](Wardrik.Operations.Triggers.md): Operations on an agent's triggers: setting, removing, and delivering webhooks.
- [Wardrik.Operations.Visible](Wardrik.Operations.Visible.md): Limits operations over many agents to what the scope may see.
- [Wardrik.OrgSettings](Wardrik.OrgSettings.md): An org's settings, as `c:Wardrik.Orgs.settings/2` returns them.
- [Wardrik.Orgs](Wardrik.Orgs.md): Gives each org its own settings, alongside the deployment's. See `Wardrik.OrgSettings`.
- [Wardrik.Runner](Wardrik.Runner.md): Runs operations the same way for every surface
- [Wardrik.Setup](Wardrik.Setup.md): Builds `%Wardrik{}` from `Wardrik.start_link/1`'s options, and each agent's options.
- [Wardrik.SignIns](Wardrik.SignIns.md): Resumes calls that wait on a sign-in, once the person signs in.
- [Wardrik.Sleeper](Wardrik.Sleeper.md): Puts defined agents to sleep after their idle timeout. An agent wakes when something asks it.

- [Wardrik.Spending](Wardrik.Spending.md): Counts what each agent spends per UTC day, in tokens and, where priced, dollars.
- [Wardrik.Statements](Wardrik.Statements.md): The default `Wardrik.Authorizer`. Allows what the scope's `Wardrik.Statement`s allow.
- [Wardrik.TriggerTarget](Wardrik.TriggerTarget.md): Delivers trigger prompts to agents. Implements `WardrikTriggers.Target`.
- [Wardrik.Workers](Wardrik.Workers.md): Tools offered by workers: programs that connect to Wardrik and run tool calls in their own
process, like MCP servers.
- [Wardrik.Workspaces](Wardrik.Workspaces.md): Gives agents files: a tree of their own, shared trees, and files read into every turn.

- Exceptions
  - [Wardrik.Workers.Lost](Wardrik.Workers.Lost.md): Raised when a worker goes away or times out during a call. The call may have run.
  - [Wardrik.Workers.Unavailable](Wardrik.Workers.Unavailable.md): Raised when no worker offers a tool as it's called. The call didn't run.