> For the complete documentation index, see [llms.txt](https://docs.layeronecloud.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.layeronecloud.com/ai/agent-guide.md).

# Agent guide

Which page to read for the change you are about to make, and when to read nothing at all.

This page exists so an AI agent can load **one** page instead of the whole site. Read the row that matches the work in front of you. Use the connected **GitBook MCP** to read the matching page in the **LayerOne LLC Docs** site. GitBook MCP access is mandatory for every task. If it is missing, disconnected, unauthenticated, or denied access, stop work and ask the user to restore it. Do not use local files, cached docs, or direct website fetches as a fallback. Resume only after a successful MCP access check. Do not read the whole site.

## First: does this change need docs at all? <a href="#first-does-this-change-need-docs-at-all" id="first-does-this-change-need-docs-at-all"></a>

**After confirming MCP access**, skip reference reading for straightforward work: copy, labels, CSS tweaks, one-line fixes, renames, and other local edits that do not change billing, auth, provisioning or API behaviour. Reading a reference page for a label change wastes context you will need later in the task.

**Read one matching page** for a major feature, or for any change to money, authentication, provisioning, or the client API.

## Platform: pick one page <a href="#platform-pick-one-page" id="platform-pick-one-page"></a>

| You are touching                                             | Read                                                                      |
| ------------------------------------------------------------ | ------------------------------------------------------------------------- |
| Sign-in, registration, password reset, sessions              | [Users and sign-in](/platform/identity/users-and-sign-in.md)              |
| Admin vs client mode, the console hostname                   | [Access modes](/platform/identity/access-modes.md)                        |
| Staff permissions, Support vs Ticketing only                 | [Staff roles](/platform/identity/staff-roles.md)                          |
| TOTP, passkeys, MFA enrolment                                | [Two-factor](/platform/identity/two-factor.md)                            |
| Organizations, tenants, per-member access                    | [Organizations and tenants](/platform/identity/organizations.md)          |
| OIDC, identity audit coverage                                | [Audit and OIDC](/platform/identity/audit-and-oidc.md)                    |
| Public site, CMS, blog, SEO, looking glass, status pages     | [Sites and public website](/platform/public-site.md)                      |
| Monitors, checks, outages, uptime, incidents                 | [Monitoring](/platform/monitoring.md)                                     |
| Products, plans, pricing rules, orders, checkout             | [Billing model and catalog](/platform/billing/model-and-catalog.md)       |
| Stripe, PayPal, saved payment methods, webhooks              | [Payments](/platform/billing/payments.md)                                 |
| Credit ledger, `Subscription` rows, hourly metering          | [Ledger and metering](/platform/billing/ledger-and-metering.md)           |
| The $0.00 floor, grace, suspension, termination              | [Credit automation](/platform/billing/credit-automation.md)               |
| Statements, receipts, bandwidth pool, tenure rewards         | [Statements and pools](/platform/billing/statements-and-pools.md)         |
| Referrals, affiliates, promo codes                           | [Referrals and promotions](/platform/billing/referrals-and-promotions.md) |
| Revenue reporting, insights, automatic charges, KYC          | [Revenue and reports](/platform/billing/revenue-and-reports.md)           |
| Provisioning jobs, the Proxmox adapter, deploy options       | [Provisioning](/platform/vps/provisioning.md)                             |
| Start/stop/reboot, plan upgrades, reinstall, destroy         | [VM lifecycle](/platform/vps/lifecycle.md)                                |
| IPAM, floating IPs, rDNS, firewall groups, private networks  | [Networking](/platform/vps/networking.md)                                 |
| VNC console, usage metrics, RRD history, NIC inventory       | [Console and metrics](/platform/vps/console-and-metrics.md)               |
| Unmanaged VMs, operator-created services, resource sync      | [Operator management](/platform/vps/operator-management.md)               |
| Managed services, microvm vs KVM, GitHub deploys, the canvas | [Managed services](/platform/vps/managed-services.md)                     |
| ISO library, backups, snapshots, retention                   | [Images and backups](/platform/vps/images-and-backups.md)                 |
| One-click marketplace apps, power polling, dev hypervisors   | [Marketplace](/platform/vps/marketplace.md)                               |
| Hosting catalog, node control plane, activation              | [Hosting provisioning](/platform/web-hosting/provisioning.md)             |
| Hosting management jobs, files, databases, applications      | [Hosting management](/platform/web-hosting/management.md)                 |
| Hosted mail, customer DNS zones, certificates                | [Email and DNS](/platform/web-hosting/email-and-dns.md)                   |
| Service removal, node sudo policy, agent distribution        | [Nodes](/platform/web-hosting/nodes.md)                                   |
| `/api/v1/`, `/api/v2/`, API keys, request metering           | [Client API](/platform/client-api.md)                                     |
| Tickets, live chat, the assistant, help center               | [Support](/platform/support.md)                                           |
| Transactional email, campaigns, merge fields, Teams          | [Email and notifications](/platform/email-and-notifications.md)           |
| DDoS incidents, port scans, Aegis telemetry                  | [Aegis](/platform/aegis.md)                                               |
| Audit log, session recordings, health checks, workers        | [Observability](/platform/observability.md)                               |
| Console CSS, tokens, nav, dark mode, Tailwind                | [Design system](/platform/design-system.md)                               |
| Writing or running tests                                     | [Testing and QC](/platform/testing.md)                                    |
| Environment variables                                        | [Environment variables](/platform/reference/environment-variables.md)     |
| A `manage.py` command                                        | [Management commands](/platform/reference/management-commands.md)         |
| Celery Beat schedule                                         | [Scheduled tasks](/platform/reference/scheduled-tasks.md)                 |

## The other three systems <a href="#the-other-three-systems" id="the-other-three-systems"></a>

| You are touching                                   | Read                                                                        |
| -------------------------------------------------- | --------------------------------------------------------------------------- |
| `apps/paas/` — apps, builds, releases, routing     | [Application platform architecture](/paas/architecture.md)                  |
| The tunnel, the zone, customer domains at the edge | [Cloudflare setup](/paas/cloudflare-setup.md)                               |
| `agents/web-server/` — the CloudLinux node tree    | [Node agent architecture](/node-agent/architecture.md)                      |
| Installing or updating a node agent                | [Node agent install](/node-agent/install.md)                                |
| Network Monitor server, agent or sensor behaviour  | [Trust and data flow](/network-monitor/architecture/trust-and-data-flow.md) |
| Monitor retention, memory, alerting thresholds     | [Network Monitor operations](/network-monitor/operations/central-server.md) |

## Additional projects and setup <a href="#additional-projects-and-setup" id="additional-projects-and-setup"></a>

| Work                                        | Read through GitBook MCP                                                           |
| ------------------------------------------- | ---------------------------------------------------------------------------------- |
| Platform setup and deployment               | [Platform setup](/platform/setup.md)                                               |
| Monitoring / Looking Glass agent            | [LayerOne Agents](/monitoring-agent.md)                                            |
| CloudLinux agent setup                      | [Node agent setup](/node-agent/setup.md)                                           |
| Application replica router                  | [Replica router](/paas/router.md)                                                  |
| Network Monitor setup or performance checks | [Setup](/network-monitor/setup.md), [performance](/network-monitor/performance.md) |
| Proxmox microVM package                     | [pve-microvm](/pve-microvm.md)                                                     |

## Rules that apply to every change <a href="#rules-that-apply-to-every-change" id="rules-that-apply-to-every-change"></a>

Before you touch money, authentication, provisioning or the API, read [**invariants**](/ai/invariants.md). They are short and they are the rules most likely to be broken by a change that looks locally correct.

## Documentation is part of the change <a href="#documentation-is-part-of-the-change" id="documentation-is-part-of-the-change"></a>

All feature, setup, operational, and developer documentation is authored in GitBook's **LayerOne LLC Docs** site through the connected **GitBook MCP**. When adding or changing a feature, create a change request to update its existing pages or add the missing documentation as part of the same task. Preserve numbered sections, rationale, behavior contracts, and working links. Read back the draft, then merge the documentation change request to publish.

Git Sync automatically exports published content to [LayerOne-LLC/Documentation](https://github.com/LayerOne-LLC/Documentation) on `main`. Do not author documentation by editing or pushing GitHub files. The local `../LayerOne Docs` checkout is an export, not the editing path. Report published GitBook changes and synchronization status alongside code diffs. Manual Git commits/pushes remain prohibited; GitBook publication and its automatic Git Sync are the intended workflow. If MCP access is unavailable, stop work until the user restores it.

## Section numbers in code comments <a href="#section-numbers-in-code-comments" id="section-numbers-in-code-comments"></a>

The platform reference used to be one file with numbered sections, and code comments, commit messages and older notes still say things like `§6.12`. The [section map](/ai/section-map.md) resolves every number to a page here.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.layeronecloud.com/ai/agent-guide.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.