# nimo full documentation > Complete machine-readable copy of the public nimo docs. Canonical docs index: https://heynimo.com/docs Short agent discovery file: https://heynimo.com/llms.txt Agent guide: https://heynimo.com/AGENTS.md Agent skill: https://heynimo.com/skill.md ## Product summary - nimo is an AI website performance agent. - nimo audits real visitor speed, monitors uptime, explains regressions, and helps users decide what to fix first. - nimo connects to Telegram, MCP clients, Google Search Console, Google Analytics, Ahrefs, Cloudflare, and custom MCP servers when configured. - Cloudflare changes require approval and are applied through chat with the Cloudflare MCP connection. ## How agents should use these docs - Start with /docs for onboarding and /docs/mcp for agent setup. - Use the public docs MCP at https://api.heynimo.com/docs-mcp when a client can connect MCP and only needs public documentation. - Use each page's Markdown URL when a concise page-level source is enough. - Use this full bundle when a client needs all public docs in one request. - Do not assume access to private account data. Authenticated MCP access requires a user-created API key. - Prefer exact product limits and caveats from the Billing and API keys section. ## Documentation pages ## Quick start nimo watches your site speed, explains what changed, and tells you what to fix first. Start here if you want the shortest path from account to useful answer. Canonical URL: https://heynimo.com/docs Markdown URL: https://heynimo.com/docs.md ### Summary The fastest path for a new user: create an account, add a site, run the first audit, connect Telegram, and ask the nimo agent a focused performance question. ### Key points - Create an account at /login. - Add one production site URL. - Run the first audit. - Connect Telegram from Settings. - Ask: What should I fix first on mobile, and why does it matter? ### Start in three minutes - Create your account at /login so nimo can save sites, history, alerts, and integrations. - Paste the public URL you want nimo to monitor. The dashboard starts the first audit and turns on uptime monitoring for that site. - Connect Telegram from Settings and press Start in Telegram. - When the first audit finishes, ask one focused question: What should I fix first on mobile, and why does it matter? ### What happens next - After the first audit, nimo shows a plain-language report with real visitor data from Chrome when available, simulated Lighthouse test data, prioritized recommendations, chat follow-ups, uptime status, and audit history. - Smaller or newer sites may not have enough Chrome field data yet. nimo says that clearly and uses the simulated test as a diagnostic baseline. ### First prompts to try - Ask short prompts and make one decision at a time. - Good prompts: What is the single biggest reason this page feels slow? Which slow page is most likely hurting search traffic or conversions? Compare my last two audits. Did the fix actually help? ### Keep it running - Use Telegram for chat, audits, site switching, and alerts. - Use MCP when Claude Code, Cursor, Windsurf, or another agent needs to read audit history and run checks. - Connect Google data for search and traffic context. - Connect Cloudflare when you want nimo to suggest edge fixes for images, compression, caching, and headers. ## Set up a site Add a site and run the first audit. nimo will monitor uptime, store history, and use that context when you ask questions. Canonical URL: https://heynimo.com/docs/setup Markdown URL: https://heynimo.com/docs/setup.md ### Summary Explains site onboarding, URL validation, automatic uptime checks, scheduled audits, and the difference between real visitor data and simulated test data. ### Key points - Use the public production URL visitors use. - Paid plans can use weekly, daily, or manual audit schedules. - Real visitor data is primary when Chrome has enough traffic for the page. - Simulated test data is diagnostic and useful when field data is missing. ### Add your site - Sign in and choose Add site. Use the public URL visitors use, including the protocol, for example https://example.com. - Start the first audit. nimo checks the URL, pulls available Chrome field data, runs a simulated test, and builds the report. - Read the plain-language verdict first. It answers what is slow, why it matters, and what to do next. - Add production pages when you want search and real visitor context. Staging pages can still be useful for quick simulated checks. ### Choose the right schedule - Paid plans can use weekly, daily, or manual audit schedules. - Use weekly audits when a site changes occasionally. - Use daily audits when the page is tied to paid traffic, high-value SEO traffic, checkout, lead capture, or client reporting. - Run a manual audit any time you make a change and want a before-after check. ### Understand the data sources - Real visitor data is Chrome field data. It shows what real visitors experienced and reflects many visits, not one test run. - Simulated test data is Lighthouse-style lab data. It helps diagnose why a page is slow, but it is not the same as what real visitors saw. - Page inspection lets nimo inspect structure, scripts, images, and common performance patterns when answering chat questions. - Google, Ahrefs, Cloudflare, and MCP connections add traffic, SEO, infrastructure, and workspace context. ### Manage site settings - Use site settings to change schedules, run manual audits, compare history, connect integrations, and remove sites you no longer want nimo to monitor. - Keep the first setup simple: add one important page first, then add more money pages or client sites after the recommendations make sense. ## Telegram Telegram is the main place to talk to nimo. Connect it once, then ask questions, run audits, switch sites, and get alerts without opening the dashboard. Canonical URL: https://heynimo.com/docs/telegram Markdown URL: https://heynimo.com/docs/telegram.md ### Summary Short setup and usage guide for Telegram, including account linking, site switching, audits, status checks, new chats, unlinking, and useful questions to ask. ### Key points - Create a Telegram link token from Settings. - Press Start in Telegram to finish linking. - Use /site, /addsite, /audit, /status, /newchat, and /unlink. - Ask short questions and let nimo answer from the active site's report history. ### Connect Telegram - Open Settings in the web app and find Telegram. - Click Connect. nimo creates a private Telegram deep link for your account. - Telegram opens the nimo chat. Press Start to finish linking. - If you have more than one site, use /site to choose which one nimo should answer about. ### Use the commands - /site switches the active site. - /addsite adds a new site from Telegram. - /audit runs an audit for the active site. - /status checks current site and connection status. - /newchat starts a fresh chat thread. - /unlink disconnects Telegram from your nimo account. ### Ask short questions - Telegram works best when the question is direct. - Good prompts: Why did my mobile LCP get worse this week? Run a new audit and tell me if the hero image fix helped. What is the next safest thing to fix? ### When nimo messages you - nimo reaches out for performance regressions, uptime incidents, completed audits, or fixes that need approval. - Uptime notifications are batched and quiet during late hours unless an incident has lasted long enough to be urgent. ## MCP for agents Use the public docs MCP when an agent only needs nimo documentation. Use the authenticated nimo MCP server when an agent needs your performance data. Canonical URL: https://heynimo.com/docs/mcp Markdown URL: https://heynimo.com/docs/mcp.md ### Summary Shows how to use the public docs MCP server, create a nimo API key, configure remote MCP clients with bearer auth, and use the nimo MCP tools for sites, audit reports, history, comparisons, and uptime. ### Key points - Use the public docs MCP at https://api.heynimo.com/docs-mcp when an agent only needs public nimo documentation. - Create an API key in Settings. Keys start with nimo_ and are shown once. - Connect an HTTP MCP client to https://api.heynimo.com/mcp-server. - Send Authorization: Bearer nimo_YOUR_KEY. - Tools include list_sites, get_site, get_audit_report, get_audit_history, compare_audits, run_audit, get_audit_status, and get_uptime_status. ### What the MCP server gives agents - The MCP server lets an agent inspect sites, read audit reports, compare history, start audits, and check uptime. - Ask your coding agent to read the latest nimo report before it changes code. It can target the page, metric, and recommendation that matter most. ### Public docs MCP - Use https://api.heynimo.com/docs-mcp when an agent only needs public nimo documentation. - This server is read-only and does not require an API key. - Tools include list_docs, search_docs, read_doc, and read_llms_full. - Use the authenticated nimo MCP server only when an agent needs account data such as sites, audits, history, or uptime status. ### Create an API key - Open Settings and find API keys. - Create a named key for a client such as Claude Code or Cursor. - Copy it once. nimo shows the key only once, and it starts with nimo_. - Paste it into the MCP client as a bearer token in the Authorization header. ### Connect your client - Claude Code command: claude mcp add nimo https://api.heynimo.com/mcp-server -t http -s project -H "Authorization:Bearer nimo_YOUR_KEY" - Generic MCP config: use url https://api.heynimo.com/mcp-server and header Authorization: Bearer nimo_YOUR_KEY. - For Windsurf, add the same server URL and bearer header in ~/.codeium/windsurf/mcp_config.json. ### Security notes - API keys are shown once. Store them in your agent secret store or local MCP config. - Revoke keys you no longer use. - Each user can have up to five keys. - MCP access requires an active paid or comped plan. - Treat MCP clients like any automation that can read account data and trigger audits. ## Audits An audit is nimo checking how your site performs, explaining what matters, and saving the result so future changes can be compared. Canonical URL: https://heynimo.com/docs/audits Markdown URL: https://heynimo.com/docs/audits.md ### Summary Covers full and quick audits, CrUX field data, Lighthouse lab diagnostics, audit progress, history, and before-after comparisons. ### Key points - Audits combine Chrome field data, simulated lab diagnostics, page inspection, and AI analysis. - Run audits from the dashboard, Telegram, or MCP. - Compare audits before and after fixes to verify improvement. ### Run an audit - Pick the site from the dashboard, /site in Telegram, or list_sites through MCP. - Start the audit from the UI, /audit, or the run_audit MCP tool. - A full audit pulls available Chrome field data, runs a simulated test, analyzes the result, and creates a report. - A quick audit is useful after a fix when you want a fast comparison. ### Read the results - nimo leads with a plain-language verdict, then shows metrics and recommendations. - LCP describes how long visitors wait before the main content appears. - CLS describes how much the page shifts while visitors try to read or click. - INP describes how responsive the page feels when visitors interact. - Diagnostics cover images, scripts, stylesheets, fonts, third parties, and page structure. - Lighthouse scores can move between runs. nimo focuses on metric values, history, and real visitor impact. ### Compare changes - Run an audit before and after a fix. - nimo can compare two audits and show what improved, what got worse, and what stayed the same. - Good prompt: Compare my last two audits. Which metrics changed enough to trust? ### Use audit history - Audit history helps nimo tell the difference between a one-off slow run and a real trend. - For important pages, run a manual audit before deploying a fix, then run another audit after the change ships. ## Monitoring and alerts nimo keeps watching after the first audit. It checks speed on a schedule, checks uptime every few minutes, and tells you when something needs attention. Canonical URL: https://heynimo.com/docs/monitoring Markdown URL: https://heynimo.com/docs/monitoring.md ### Summary Explains scheduled performance audits, degradation alerts, uptime checks every five minutes, incident status, batched notifications, and quiet hours. ### Key points - Scheduled audits build history and detect regressions. - Uptime checks run every five minutes. - Notifications are batched and quiet during 10pm to 8am Pacific unless urgent. ### Scheduled audits - Scheduled audits build the history nimo needs to spot regressions. - Use weekly audits for sites that change occasionally. - Use daily audits for important pages, frequent deployments, paid traffic, checkout, lead capture, or client reporting. - Use manual audits when you make a change and want a before-after check. ### Degradation alerts - nimo compares recent audits with previous results and alerts when metrics move beyond normal noise. - The alert explains what changed and what to check first. - Good prompt: Why did this alert fire, and what changed on the page? ### Uptime checks - Uptime starts automatically when you add a site. nimo checks every five minutes. - Up means the site responded. - Degraded means the site responded, but slowly. - Down means the site timed out, had DNS trouble, or returned a server error. - A 4xx response counts as reachable because many CDNs and WAFs reject automated requests even when the site is alive. ### Quiet hours - Uptime notifications are batched for 90 seconds so one user does not get a message for every site at once. - During 10pm to 8am Pacific time, non-urgent notifications wait unless an incident has lasted 30 minutes or more. - nimo uses batching and a circuit breaker to avoid false notification storms. ## Reports and sharing Reports are built for decisions. nimo tells you what is slow, why it matters, and what to fix first. Canonical URL: https://heynimo.com/docs/reports Markdown URL: https://heynimo.com/docs/reports.md ### Summary Describes nimo AI reports, prioritized recommendations, report sections, comparison views, public share links, and client-ready summaries. ### Key points - Reports include a verdict, metrics, deep dives, and prioritized recommendations. - Share links create public expiring URLs for reports and comparisons. - Use report comparisons for client before-after evidence. ### What a report includes - Verdict: a short explanation of the current state of the page. - Metrics: Core Web Vitals and supporting metrics from field and lab data. - Deep dives: images, scripts, fonts, third parties, page entities, search context, and traffic context when available. - Next steps: recommendations ranked by expected impact and practicality. ### Prioritized recommendations - nimo does not simply repeat every Lighthouse warning. - It ranks work by likely user impact, stack relevance, metric trend, and safety. - A recommendation can be important even when the Lighthouse score looks fine. nimo checks field data first when it exists. ### Share a report - Use share links to send a report or comparison to a client, teammate, or developer. - Open the report, create the share link, choose the expiry window, and send the link. - The recipient can view the report without signing in. ### Use reports with clients - For client work, save a before audit, make the change, run another audit, and share the comparison. - Good prompt: Summarize this report for a client in five bullets. Focus on business impact and the next fix. ## Chat with nimo Chat is where reports become useful. nimo knows your site context and can answer specific questions without making you translate performance jargon. Canonical URL: https://heynimo.com/docs/chat Markdown URL: https://heynimo.com/docs/chat.md ### Summary Explains how the nimo agent uses audit data, site history, uptime, page inspection, web tools, and connected integrations to answer performance questions. ### Key points - nimo chat can use audit data, history, uptime status, page inspection, preferences, and connected integrations. - Ask one focused question at a time. - Good prompts ask what changed, what to fix first, or whether a fix worked. ### What nimo knows - nimo can use the latest audit and report, audit history, uptime status, page inspection, web tools, saved preferences, and connected Google, Ahrefs, Cloudflare, and MCP integrations. ### Good questions to ask - Ask nimo to make a decision, explain a change, or choose the next fix. - Good prompts: What should I fix first if I only have one hour? Explain the LCP issue like I am sending it to a developer. Did the last deployment make this page faster or slower? ### Run work from chat - Depending on setup, nimo can trigger audits, inspect a page, check uptime, compare audits, and suggest Cloudflare optimizations. - nimo asks for approval before applying infrastructure changes. - Chat is most useful after an audit because the report gives nimo evidence and avoids generic advice. ### Keep conversations useful - Ask one question at a time. - Name the page or site if you manage several. - Ask for the reason behind each recommendation. - Ask for a smaller next step when an answer feels too broad. ## Integrations Integrations give nimo more context. Connect only what helps your workflow. Canonical URL: https://heynimo.com/docs/integrations Markdown URL: https://heynimo.com/docs/integrations.md ### Summary Covers Google Search Console, Google Analytics 4, Ahrefs MCP, Cloudflare MCP, custom MCP connections, and the current status of Slack and Notion. ### Key points - Google Search Console and Analytics add search and traffic context. - Ahrefs adds SEO data through MCP. - Cloudflare adds edge optimization through OAuth and MCP. - Custom MCP servers can add narrow workspace tools. - Slack and Notion are currently marked coming soon in the public Settings UI. ### Google Search Console and Analytics - Google Search Console adds search context. Google Analytics 4 adds traffic context. - Open Settings, choose Google integrations, authorize Google, and pick the account that owns the right properties. - If Analytics data is missing, reconnect Google so nimo can request the Analytics readonly scope. ### Ahrefs - Ahrefs adds SEO data such as domain rating, organic traffic, keywords, backlinks, and top pages. - Create an Ahrefs MCP key in Ahrefs, then paste it into nimo Settings. ### Cloudflare - Cloudflare is used for edge optimization. - Connect with OAuth. nimo asks for permission to read account and zone data, edit zone settings, and purge cache when it applies an approved fix through chat. ### Custom MCP servers - Use a custom MCP connection when your own tools or workspace data should be available in nimo chat. - Add the server URL, transport, and any required headers in Settings. - Keep custom MCP servers narrow. The best integrations answer one job clearly, such as finding docs, reading a CMS, or looking up internal release notes. ### Coming soon - Slack is planned for team chat and alerts, but it is not available in public Settings yet. - Notion is planned for workspace context, but it is not available in public Settings yet. ## Cloudflare optimization Cloudflare optimization is nimo's edge fix path. When your site runs behind Cloudflare, nimo can suggest changes and apply approved changes from chat. Canonical URL: https://heynimo.com/docs/cloudflare-optimization Markdown URL: https://heynimo.com/docs/cloudflare-optimization.md ### Summary Explains Cloudflare OAuth, the three-audit learning phase, supported edge optimizations, approval before chat-applied changes, verification after apply, rollback, and change history. ### Key points - Connect Cloudflare with OAuth. - nimo waits for a three-audit baseline before suggestions. - Supported fixes include image optimization, Brotli, Early Hints, Auto Minify, and Browser Cache TTL. - Every change requires approval before nimo applies it through chat; applied changes can be verified and rolled back through chat. ### Connect Cloudflare - Open Settings, go to Integrations, and choose Cloudflare. - Sign in with Cloudflare and allow account read, analytics read, zone read, zone settings read/edit, and cache purge. - nimo needs enough audit history before it suggests infrastructure changes. ### Learning phase - nimo waits for a three-audit baseline before suggesting Cloudflare changes. - The learning phase helps nimo avoid changing settings because of one noisy run. ### Supported fixes - Image Polish and WebP can improve image delivery at the edge when images are a real bottleneck. - Brotli compression can compress text assets so pages transfer less data. - Early Hints can let browsers begin loading important resources sooner. - Auto Minify can minify HTML, CSS, or JavaScript when it is safe for the site. - Browser Cache TTL can improve repeat visits by caching static assets longer. ### Approve and verify - nimo does not apply a Cloudflare change without approval. - Approval records your intent. To make the change, ask nimo in chat to apply the approved action. - nimo changes the Cloudflare setting through MCP and records the previous value. - Once the change is applied, nimo can queue a verification audit and log the before-after result when data exists. ### Roll back a change - Applied optimizations store the previous setting. - If a change causes trouble or does not help, ask nimo in chat to roll it back and record the rollback. ## Billing and API keys Plans control how many sites, audits, chat messages, and AI tokens your account can use. API keys are for agent and MCP access. Canonical URL: https://heynimo.com/docs/billing-and-api-keys Markdown URL: https://heynimo.com/docs/billing-and-api-keys.md ### Summary Summarizes Pro and Business limits, subscription management, usage counters, API key creation, one-time key display, key revocation, and bearer auth for MCP. ### Key points - Pro is $20/month: 10 sites, 50 audits/month, 200 chat messages/month. - Business is $199/month: 50 sites, 200 audits/month, 1,000 chat messages/month. - API keys are for MCP and agent access. They are stored as hashes and can be revoked. ### Plans - Pro costs $20/month and includes 10 sites, 50 audits/month, and 200 chat messages/month. - Business costs $199/month and includes 50 sites, 200 audits/month, and 1,000 chat messages/month. - Business raises the monthly token budget from 500K to 2M and is better for teams, agencies, and accounts that need more sites, audits, or chat volume. ### Usage limits - nimo tracks sites, audits, chat messages, and token usage. - If you hit a limit, upgrade or wait for the monthly reset. - Comped accounts may have limits handled separately. ### API keys - API keys power the nimo MCP server. - Keys start with nimo_, are shown only once, are stored as hashes, can be revoked from Settings, and are limited to five active keys per user. - Bearer auth requires an active paid or comped account. - Create the key in Settings, store it safely, and send it as Authorization: Bearer nimo_YOUR_KEY. ### Keep keys safe - Use one key per agent or environment. - Revoke keys when a laptop, teammate, project, or client no longer needs access. ## Current product caveats - Slack and Notion are currently marked coming soon in the public Settings UI. - API keys are shown once and require an active paid or comped account for MCP bearer auth. - Cloudflare optimization requires OAuth connection, approval before chat-applied changes, verification after apply, and rollback through chat.