|
| 1 | +# agentimization |
| 2 | + |
| 3 | +GEO audit for agent-ready websites and projects |
| 4 | + |
| 5 | +## Description |
| 6 | + |
| 7 | +Use when deploying a website, before committing docs changes, or when the user wants to check if their site is discoverable by AI agents (Claude, ChatGPT, Perplexity, etc.). Runs 35 checks across 8 categories: content discoverability, markdown availability, content structure, page size, URL stability, authentication, GEO signals, and agent protocols. Outputs a 0–100 score with actionable fix suggestions. |
| 8 | + |
| 9 | +## Quick Start |
| 10 | + |
| 11 | +Run `npx -y agentimization@latest .` to audit the current project locally. |
| 12 | + |
| 13 | +If the score is below 70, fix the highest-impact failures first — prioritize content discoverability and agent protocols. |
| 14 | + |
| 15 | +Run `npx -y agentimization@latest https://example.com --json` to audit a live site and get structured results. |
| 16 | + |
| 17 | +```bash |
| 18 | +# Audit local project |
| 19 | +npx -y agentimization@latest . |
| 20 | + |
| 21 | +# Audit a live site |
| 22 | +npx -y agentimization@latest https://example.com |
| 23 | + |
| 24 | +# Get JSON output for programmatic use |
| 25 | +npx -y agentimization@latest . --json |
| 26 | +``` |
| 27 | + |
| 28 | +## Commands and Options |
| 29 | + |
| 30 | +| Flag | Purpose | |
| 31 | +|------|---------| |
| 32 | +| `.` or `./docs` | Scan a local directory | |
| 33 | +| `https://...` | Audit a live site over HTTP | |
| 34 | +| `--json` | Output raw JSON (for CI/piping) | |
| 35 | +| `--md` | Output markdown report (paste into an AI agent) | |
| 36 | +| `--category <cat>` | Only run checks in one category | |
| 37 | +| `--sample-size <n>` | Number of pages to sample (default: 10) | |
| 38 | + |
| 39 | +## Categories |
| 40 | + |
| 41 | +| Category | What it checks | |
| 42 | +|----------|---------------| |
| 43 | +| content-discoverability | llms.txt, sitemap, robots.txt | |
| 44 | +| markdown-availability | .md URLs, content negotiation | |
| 45 | +| content-structure | headings, code fences, tabs | |
| 46 | +| page-size | SSR vs CSR, HTML/MD size, boilerplate ratio | |
| 47 | +| url-stability | status codes, redirects, caching | |
| 48 | +| authentication | auth gates, alternative access | |
| 49 | +| geo-signals | structured data, E-E-A-T, citations, FAQ schema | |
| 50 | +| agent-protocols | AGENTS.md, MCP server card, API catalog, content signals, Link headers | |
| 51 | + |
| 52 | +## Workflow |
| 53 | + |
| 54 | +1. Run `npx -y agentimization@latest . --json` to get the audit results |
| 55 | +2. Parse the JSON output to identify failures and warnings |
| 56 | +3. Fix issues by category — start with `content-discoverability` (llms.txt, sitemap) and `agent-protocols` (MCP server card, API catalog) as these have the highest impact |
| 57 | +4. For each failed check, the `suggestion` field contains the specific fix |
| 58 | +5. Re-run the audit to verify the score improved |
| 59 | + |
| 60 | +## Common Fixes |
| 61 | + |
| 62 | +- **Missing llms.txt**: Create a `llms.txt` at the project root with `# Title`, `> Description`, and `## Section` headings linking to key pages |
| 63 | +- **No sitemap**: Generate a `sitemap.xml` listing all public pages |
| 64 | +- **No MCP server card**: Add `.well-known/mcp/server-card.json` describing your server's tools and capabilities |
| 65 | +- **No structured data**: Add JSON-LD `<script type="application/ld+json">` with Article, WebPage, or Organization schema |
| 66 | +- **Client-side rendering**: Use SSR or SSG so AI crawlers can read the HTML without executing JavaScript |
| 67 | +- **Missing canonical URLs**: Add `<link rel="canonical" href="...">` to every page |
| 68 | + |
| 69 | +## Metadata |
| 70 | + |
| 71 | +- **name**: agentimization |
| 72 | +- **description**: Use when deploying a website, before committing docs changes, or when the user wants to check if their site is discoverable by AI agents. Runs 35 checks across 8 categories and outputs a GEO score with fix suggestions. |
| 73 | +- **version**: 0.1.0 |
0 commit comments