docs(fleets): add Fleets setup page#1136
Conversation
Concise, example-driven guide to running agents on dedicated machines (e.g. a Mac mini with Claude Code and Codex) instead of a laptop. Covers defining a node, `fleet serve`, verifying registration, spawning onto it, and adding actions/triggers. Adds a "Fleets" group to the docs nav. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
📝 WalkthroughWalkthroughAdds ChangesFleets Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@web/content/docs/fleets.mdx`:
- Around line 59-63: The documentation currently describes `spawn` as an MCP
tool alongside `query_nodes`, which misrepresents the architecture. Clarify that
`query_nodes` is the MCP discovery tool used to find nodes by capability, while
`spawn` is a node capability/action for launching agents on nodes (either by
name or by letting the workspace select one with the required capability).
Review and align any later sections or card copy in the document that reference
these concepts to use consistent terminology.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 1c2dc661-ae6e-483a-9c39-003b840f9d21
📒 Files selected for processing (2)
web/content/docs/fleets.mdxweb/lib/docs-nav.ts
| Agents reach the fleet through their MCP tools — no extra wiring: | ||
|
|
||
| - **`query_nodes`** — find nodes by capability (`which node can spawn:codex?`). | ||
| - **`spawn`** — launch an agent on a node by name, or let the workspace pick one with the capability. | ||
|
|
There was a problem hiding this comment.
Describe spawn as a node capability, not a standalone MCP tool.
The fleet spec treats spawning as node capability/action wiring; query_nodes is the MCP discovery tool. This paragraph makes spawn sound like a direct protocol primitive, which will mislead readers. Please align the later card copy with the same wording.
Suggested wording
-Agents reach the fleet through their MCP tools — no extra wiring:
-- **`query_nodes`** — find nodes by capability (`which node can spawn:codex?`).
-- **`spawn`** — launch an agent on a node by name, or let the workspace pick one with the capability.
+Agents reach the fleet through MCP discovery, and spawning is exposed as a node capability:
+- **`query_nodes`** — find nodes by capability (`which node can spawn:codex?`).
+- **`spawn` capability** — launch an agent on a node by name, or let the workspace pick one with the capability.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@web/content/docs/fleets.mdx` around lines 59 - 63, The documentation
currently describes `spawn` as an MCP tool alongside `query_nodes`, which
misrepresents the architecture. Clarify that `query_nodes` is the MCP discovery
tool used to find nodes by capability, while `spawn` is a node capability/action
for launching agents on nodes (either by name or by letting the workspace select
one with the required capability). Review and align any later sections or card
copy in the document that reference these concepts to use consistent
terminology.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: eb1fdcb147
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| On the machine (the Mac mini), install the harness CLIs (`claude`, `codex`) on `PATH`, then: | ||
|
|
||
| ```bash | ||
| npm install @agent-relay/fleet @agent-relay/harnesses zod |
There was a problem hiding this comment.
Install the CLI before using its fleet commands
In a fresh node setup, this install command does not install the agent-relay binary used by the next steps; that bin is provided by the agent-relay package (packages/cli/package.json), not by @agent-relay/fleet or @agent-relay/harnesses. Users following this page from scratch will hit agent-relay: command not found when they try to run agent-relay fleet serve, so include the CLI install or show an npx/local invocation.
Useful? React with 👍 / 👎.
| Serve it — this process *is* the node, so keep it running: | ||
|
|
||
| ```bash | ||
| RELAY_WORKSPACE_KEY=rk_live_... agent-relay fleet serve ./macmini.node.ts |
There was a problem hiding this comment.
Export the workspace key for follow-up fleet commands
With this one-command environment assignment, RELAY_WORKSPACE_KEY is visible only to the long-running fleet serve process. The verification command below (agent-relay fleet nodes) is SDK-backed and needs its own workspace key via env/--workspace-key unless the user already has an active workspace configured, so a fresh second shell will fail instead of confirming registration; show export RELAY_WORKSPACE_KEY=... or pass the key to fleet nodes.
Useful? React with 👍 / 👎.
|
Preview deployed!
This preview will be cleaned up when the PR is merged or closed. |
Adds a concise, example-driven Fleets docs page and a "Fleets" nav group.
Explains why nodes exist (agents need a host that outlives your laptop) and walks through the most common setup — a Mac mini in the workspace running Claude Code and Codex as harnesses:
defineNodewithspawn:claude/spawn:codex, thenfleet serve; verify withfleet nodes/fleet status.query_nodesandspawnfrom an agent.action(...)+onMessage(...).Noteon the off-by-defaultfleet_nodes_enabledflag.496 words, high signal-to-noise per review feedback. Only
web/content/docs/fleets.mdxandweb/lib/docs-nav.tschanged.🤖 Generated with Claude Code