--- slug: /pulse/docs-for-agents title: Docs for agents source: pulse --- # Docs for agents Use this guide to find Pulse documentation, choose the right agent tool, and start work in a repository. ## Read the documentation 1. Fetch [`/llms.txt`](/llms.txt) from the docs site's origin. It lists published pages under the same categories and products as the sidebar. 2. Find the product relevant to the task. 3. Fetch the page's `.md` link. Preserve the source and path exactly as listed in the index. 4. Follow the page's upstream repository link when you need current code or instructions for that repository. For example, with `PULSE_DOCS_URL` set to your docs site's origin: ```bash curl -fsS "$PULSE_DOCS_URL/llms.txt" curl -fsS "$PULSE_DOCS_URL/pulse-pipe/docs/24-user-guide.md" curl -fsS "$PULSE_DOCS_URL/phosphor/readme.md" ``` The HTML routes render through a client-side application. A plain HTTP fetch of an HTML route does not contain the page body. Use the static Markdown endpoints for reading without a browser. ### Find the right scope Read the [platform overview](/pulse/index.md) for product responsibilities. Use the [repository directory](/pulse/repository-directory.md) to locate source code, including libraries without a standalone product page. The navigation categories describe purpose: Production, Operations, and Development. [Pulse CLI](/pulse-cli/overview.md) appears separately under Developer tools. These categories are different from the architectural pillars of infrastructure, orchestration, and capabilities. ### Available formats | Endpoint | Content | | --- | --- | | [`/llms.txt`](/llms.txt) | Page index with Markdown links and short excerpts, grouped by category and product. | | `//.md` | One page's original Markdown with added `slug`, `title`, and `source` frontmatter. | | [`/llms-full.txt`](/llms-full.txt) | All published pages concatenated, with each page's slug, title, and source. Use when the task needs the full corpus. | | [`/robots.txt`](/robots.txt) | The site's crawler and AI content signals. | Append `.md` to the page path before a fragment or query string. For example, `/rship/core-concepts/terms#executor` becomes `/rship/core-concepts/terms.md#executor`. Links inside the Markdown retain their source form. Some point to HTML routes or upstream files that are not imported here. Use `/llms.txt` to confirm published Markdown paths. Resolve root-relative links against the docs site's origin. `Accept: text/markdown` does not select a Markdown response on this site. Request the explicit `.md` path. In a browser, the **Agents toolkit** provides **Copy as Markdown**, **Open MD in new tab**, and links that open Claude or ChatGPT with the page URL. Those links provide context to a separate conversation; they do not connect the model to Pulse services. ## Choose the right tool Reading this site does not establish a connection to a running Pulse service. Discover the tools and connection state available in your current agent session. | Need | Tool or product | Responsibility | | --- | --- | --- | | Coordinate with live agent sessions | [Marshal](/marshal/readme.md) | Presence and messaging across agents, harnesses, and machines. | | Track work and dependencies | [Levi](/levi/readme.md) | Tasks, claims, and completion tied to Git ancestry. | | Create an isolated checkout | [Pulse CLI](/pulse-cli/overview.md) | Materialize selected repositories through `pulse work`. | | Discover and call application operations | [Myko MCP](/myko-mcp/overview.md) | Access the operations registered by the connected Myko application. | | Run durable remote agent sessions | [Pulse Agents](/pulse-agents/overview.md) | Session execution, transcripts, approvals, and the Console. | | Operate the Unreal render fleet | [Pulse Cluster](https://github.com/ignition-is-go/pulse-cluster) | Durable recipes, admitted lifecycle operations, and PulseNode actions. | | Provision or converge infrastructure | [Pulse Deploy](/pulse-deploy/automation.md) | Terraform and Ansible configuration, diagnostics, repair, and maintenance. | ### Discover Myko operations before calling them Myko MCP exposes `connection_status`, `search`, and `execute`. The operations behind those tools depend on the connected application and its filters. 1. Inspect `connection_status` to confirm the connection. 2. Use `search` to find the relevant query, view, report, or command. 3. Request detailed search results to get wire argument names, result wrappers, and validated examples when available. 4. Use `execute` with the discovered operation contract. Return the fields needed for the task. Do not assume that every Myko application registers the same operations. A successful documentation fetch does not prove that an application is reachable or that an operation is available. The in-server MCP endpoint is `/myko/mcp` on the application's Myko gateway. Obtain its host, port, and connection configuration from that application's deployment. See [Myko's MCP reference](/myko/readme.md) for transports and client configuration. ### Use the current fleet control plane Pulse Cluster owns Unreal cluster intent and lifecycle. PulseNode performs typed host actions and project materialization. Ansible owns infrastructure convergence, diagnostics, repair, and bounded maintenance. Use the deployed `pulse cluster --help` and the [Pulse Cluster source documentation](https://github.com/ignition-is-go/pulse-cluster) for the current command surface. See [Pulse Deploy automation](/pulse-deploy/automation.md) for the boundary between fleet lifecycle and infrastructure convergence. ## Start repository work 1. Read the workspace's instructions and inspect the task with `levi next --json` when choosing work. 2. Create a scoped checkout with `pulse work create --task `. For work without a task, use `--name `. 3. Enter the printed path. Read the target repository's `AGENTS.md`, or its legacy `CLAUDE.md`. 4. Commit changes inside the repository that owns them. Use `pulse work add ` if the task needs another repository. [Pulse CLI workspaces](/pulse-cli/workspaces.md) covers checkout creation, local dependency overrides, and retirement. The `pulse` tooling repository follows the same isolated-checkout rule as the managed repositories. For foundational repositories such as `myko`, `hyphae`, or `harness`, inspect Marshal's live roster as required by the workspace instructions. Follow those instructions for task completion and workspace retirement. ## Check source freshness This site aggregates selected files. Some pages are checked-in snapshots; others are fetched from a configured upstream ref when the docs site builds. It is not a live mirror of every repository or deployment. For implementation work, verify the checked-out source, dependency versions, and deployed command surface. Repository instructions apply to that checkout. Imported prose and examples can describe an older version. The site's `robots.txt` currently declares `ai-train=yes`, `search=yes`, and `ai-input=yes`. These content signals describe documentation usage. They do not grant repository access or permission to operate infrastructure.