Skip to content

Latest commit

 

History

217 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Agent Lighthouse

Lighthouse, but for AI agents.

Audit whether ChatGPT, Claude, Perplexity, MCP clients, AI crawlers, and agentic browsers can discover, parse, cite, and act on your website.

npm version npm downloads CI Docs License: Apache-2.0

Documentation · npm · Share a site score · Brand kit

Agent Lighthouse HTML report with the AI lighthouse logo, score summary, and website checks

An example report. Its scores describe one past scan, not the site's current state.


⚡ Quickstart

Requires Node.js 22.22.2+ (22.x), 24.15.0+ (24.x), or 26+.

# Terminal report, plus HTML and JSON reports in ./reports
npx @forkpoint/agent-lighthouse https://example.com

# Open the HTML report in your browser
npx @forkpoint/agent-lighthouse https://example.com --view

# Fail (exit 1) below a score, for CI
npx @forkpoint/agent-lighthouse https://staging.example.com --min-score 85

221 audits cover llms.txt, robots.txt crawler policy, Schema.org, OpenAPI discovery, WebMCP action surfaces, AEO/GEO content structure, agentic commerce, and operability. Every flag is in the CLI reference; config files and SDK options are in configuration; how the score is built is in scoring.


Agentic readiness skill

The agent-lighthouse skill lets a coding agent turn a report into verified fixes, on any website stack. It traces findings through source files and hosting settings, and keeps local fixes apart from deployed scan results.

Install it from this repository's marketplace. In Claude Code:

claude plugin marketplace add ForkPoint/agent-lighthouse
claude plugin install agent-lighthouse@agent-lighthouse

In Codex:

codex plugin marketplace add ForkPoint/agent-lighthouse
codex plugin add agent-lighthouse@agent-lighthouse

From a local checkout, pass /absolute/path/to/agent-lighthouse to marketplace add. Start a new chat after installing. The CLI and MCP npm packages are separate. See the installation and workflow guide.


🎯 What Agent Lighthouse Checks

Agent Lighthouse evaluates websites across 8 agent-journey categories grouped into 3 readiness pillars:

├── 1. Agentic Readiness
│   ├── Access & Crawl Control (robots.txt rules for GPTBot, ClaudeBot, PerplexityBot, blocks, status codes)
│   ├── Machine Discovery (llms.txt, llms-full.txt, sitemaps, feeds, .well-known surfaces)
│   ├── Agent Interfaces (WebMCP manifests, OpenAPI specs, agents.json, search actions)
│   └── Agentic Commerce (product offers, availability, checkout and payment surfaces)
│
├── 2. AI Search Optimization
│   ├── Content Extraction (clean main content, semantic structure, render and response cost)
│   ├── Structured Data (Schema.org Product, Offer, SKU, GTIN, Organization, JSON-LD validity)
│   └── Answer Readiness (direct answerability, step lists, tables, unique data, citations)
│
└── 3. Technical Foundation
    └── Agent Operability & Safety (HTTPS, security.txt, tdmrep, stability, broken agent endpoints)

📦 Packages & Architecture

A pnpm monorepo published under the @forkpoint scope:

Package npm Package Description
packages/cli @forkpoint/agent-lighthouse Main CLI binary (npx @forkpoint/agent-lighthouse <url>).
packages/core @forkpoint/agent-lighthouse-core Core gatherer-audit engine, scoring algorithms, and types.
packages/report @forkpoint/agent-lighthouse-report Standalone HTML, Markdown, and unified report view-model.
packages/mcp @forkpoint/agent-lighthouse-mcp Model Context Protocol (MCP) server for Claude / Cursor / IDEs.

🛡️ GitHub Actions CI

- uses: ForkPoint/agent-lighthouse@main
  with:
    url: https://staging.example.com
    min-score: "85"
    github-token: ${{ secrets.GITHUB_TOKEN }}

The action writes terminal, HTML, JSON, and Markdown reports. With github-token it comments the Markdown summary on the pull request. Inputs and pinning are in the GitHub Action guide.


💻 Programmatic Node.js / TypeScript SDK

import { runScan } from "@forkpoint/agent-lighthouse-core";
import {
  buildReportView,
  generateHtmlReport,
} from "@forkpoint/agent-lighthouse-report";

const report = await runScan("https://example.com");
const view = buildReportView(report);

// overallScore is null when the scan saw too little to judge the site
console.log(`Overall Score: ${view.overallScore}/100 (${view.scoreTier})`);

const html = generateHtmlReport(report); // standalone HTML report

Options are in programmatic options.


🤖 Model Context Protocol (MCP) Server

Let Claude Desktop, Cursor or another MCP client run scans through the audit_website tool:

{
  "mcpServers": {
    "agent-lighthouse": {
      "command": "npx",
      "args": ["-y", "@forkpoint/agent-lighthouse-mcp"]
    }
  }
}

📣 Share Your Score

Reports are standalone files: attach them to pull requests, send them to clients, or publish a before/after. Put the score in a README with a badge. Share a public site's result through the site score template.

More: media kit (boilerplate, screenshots, logos) · store benchmark · brand guide · brand kit download


🛠️ Development

git clone https://github.com/ForkPoint/agent-lighthouse.git
cd agent-lighthouse
pnpm install
pnpm build
pnpm test   # AL_SKIP_NETWORK=1 skips the live-site scans

Contributor rules, including how to add an audit, are in CLAUDE.md.


📄 License

Apache-2.0 © ForkPoint

Releases

Packages

Used by

Contributors

Languages