> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fau.run/developer/llms.txt
> Use this file to discover all available pages before exploring further.

# For protocol developers

> Run a node or relay, build macOS/iOS clients, or extend the FAU codebase.

## You are here because

You want to **operate or build** the software that realizes protocol `fau/1` — not only
call it as an agent.

**Primary goals (pick one):**

1. Spin up a **node** (user Mac mail gateway)
2. Spin up a **relay** (public rendezvous)
3. Build or fork a **client** (macOS shell or iOS/Android approval app)
4. **Extend** the codebase without breaking invariants

## Paste into Cursor / Claude / Codex

Copy this prompt (or open it in Cursor). The agent should pull the linked docs before changing code.

Build / run FAU — with docs as context

Help me work on Federated Agent Use (protocol `fau/1`) as a protocol developer.

Repo: [https://github.com/ranagwho/Federated-Agent-Use.git](https://github.com/ranagwho/Federated-Agent-Use.git)
Docs: [https://docs.fau.run](https://docs.fau.run)

Read these pages first (fetch as Markdown if your client supports it):

* [https://docs.fau.run/concepts](https://docs.fau.run/concepts)
* [https://docs.fau.run/protocol/overview](https://docs.fau.run/protocol/overview)
* [https://docs.fau.run/developers/getting-started](https://docs.fau.run/developers/getting-started)
* [https://docs.fau.run/developers/run-node](https://docs.fau.run/developers/run-node)
* [https://docs.fau.run/developers/run-relay](https://docs.fau.run/developers/run-relay)
* [https://docs.fau.run/developers/build-macos](https://docs.fau.run/developers/build-macos)
* [https://docs.fau.run/developers/build-mobile](https://docs.fau.run/developers/build-mobile)
* [https://docs.fau.run/developers/extend](https://docs.fau.run/developers/extend)
* [https://docs.fau.run/protocol/spec](https://docs.fau.run/protocol/spec)
* [https://docs.fau.run/protocol/security](https://docs.fau.run/protocol/security)

I will pick one goal: run a node, run a relay, build the macOS client, build the mobile
approval app, or extend the codebase. Preserve custody invariants (mail on the Mac;
blind relay; gateway before the model; device-signed approvals). Do not invent wire
formats — follow the spec and `fixtures/*.json` vectors.

## Start with the map

1. **[Concepts](https://docs.fau.run/developer/concepts.md)** — mental model, goals, non-goals, invariants (required)
2. **[Protocol overview](https://docs.fau.run/developer/protocol/overview.md)** — components, ownership, flows, failures
3. Then jump to the how-to that matches your goal:

| Goal | Start here |
| - | - |
| First local success (demo, no Gmail) | [Developer getting started](https://docs.fau.run/developer/developers/getting-started.md) |
| Run / package a user node | [Run a node](https://docs.fau.run/developer/developers/run-node.md) |
| Deploy a relay | [Run a relay](https://docs.fau.run/developer/developers/run-relay.md) |
| macOS menu bar + NodeRuntime | [Build the macOS client](https://docs.fau.run/developer/developers/build-macos.md) |
| Phone / Android approval app | [Build a mobile client](https://docs.fau.run/developer/developers/build-mobile.md) |
| Change policy, tools, store | [Extend the codebase](https://docs.fau.run/developer/developers/extend.md) |

## Mental model

FAU is a **protocol**. The repo is one conforming implementation:

| Piece | Role |
| - | - |
| Relay | Blind doorbell (SNI forward + resolve) |
| Node | House (mail, grants, MCP, `/papi`) |
| macOS app | Supervisor (launchd, Keychain, pair QR) |
| Mobile app | Door lock (device-signed approvals) |

Normative contracts: [Wire specification](https://docs.fau.run/developer/protocol/spec.md), [Security](https://docs.fau.run/developer/protocol/security.md),
[Device signing vectors](https://docs.fau.run/developer/reference/device-signing.md).

## Not this section

Only integrating an assistant that calls MCP → [For agents](https://docs.fau.run/developer/agents.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.