Quickstart

This quickstart takes you from an empty workspace to a property that can collect crawler telemetry and answer agent queries.

Create a property

1. Sign in to CrawlConsole.
2. Open Properties and choose Add property.
3. Enter the canonical public URL for the site.
4. Keep the generated property key available for the installation step.

Use the exact production host. If both www.example.com and example.com resolve, choose the host used by your canonical URLs.

Install crawler analytics

Open the property, then go to Settings and Property Settings. Copy the installation snippet and add it to the shared layout or template that renders every public page.

<script
  async
  src="https://analytics.crawlconsole.com/tracker.js"
  data-project-key="YOUR_PROJECT_KEY"
></script>

Use the snippet shown in your property settings as the source of truth. It includes the correct project key and any current installation options.

Verify telemetry

Return to Property Settings and confirm that crawler telemetry changes from Pending to Connected. The first verified request can take a few minutes to appear after installation.

Then open Performance to review:

• total verified crawler requests;
• crawler operators and user agents;
• destination pages;
• recent requests;
• HTTP errors and repeated missing paths.

Connect an AI agent

Create an Agent API key from Settings and API Keys, then add the CrawlConsole MCP endpoint to your agent client.

{
  "mcpServers": {
    "crawlconsole": {
      "url": "https://crawlconsole.com/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_AGENT_API_KEY"
      }
    }
  }
}

Keep the key in a secret manager or local environment configuration. Do not commit it to a repository.

Run a first query

Ask your agent to list properties, select the property id for your site, and retrieve crawler analytics for the last 30 days. Property-specific tools require the canonical id returned by list_properties.

Next, read AI crawler analytics or MCP and agents.