EasyAEO - AI 友善度診斷與修復

Developer Documentation

Integrate EasyAEO into your workflow with MCP, REST API, and API Keys.

Overview

EasyAEO provides a Model Context Protocol (MCP) HTTP Server and REST API, enabling AI agents like Claude Code and Cursor to programmatically diagnose, patch, verify, and report on your site's AI search readiness.

Quick Start

Sign up and log in to EasyAEO
Create an API Key (Dashboard → Settings → API Keys)
Store your key securely (shown only once at creation)
Connect Claude Code or Cursor using the MCP configuration below

Go to API Keys

Authentication

All API requests require a Bearer token. Use your API Key (format: eaeo_sk_xxxxxxxx) in the Authorization header.

Authorization: Bearer eaeo_sk_xxxxxxxx

MCP Integration

Claude Code CLI

claude mcp add --transport http easyaeo https://api.easyaeo.com/mcp --header "Authorization: Bearer <YOUR_API_KEY>"

Cursor MCP

Add to your Cursor MCP settings (JSON):

{
  "mcpServers": {
    "easyaeo": {
      "url": "https://api.easyaeo.com/mcp",
      "headers": {
        "Authorization": "Bearer <YOUR_API_KEY>"
      }
    }
  }
}

Available Tools

Tool	Description
aeo.scan_url	Scan a deployed URL. Returns scanId, status, siteId.
aeo.get_scan	Query scan status by scanId. Returns reportId when done.
aeo.get_report	Get full report JSON (topBlockers, findings, fixes).
aeo.get_fix_bundle	Get fix code bundle (head_bundle / nextjs_app_router / split).
aeo.propose_patches	Generate unified diff patches for Next.js or generic HTML.
aeo.verify	Verify specific ruleIds after applying fixes. Returns deltaScore.
aeo.analyze_html	Offline HTML lint (for localhost/preview, no SSRF).

Typical Workflow

aeo.scan_url({ url, pages: 1 }) → scanId
Poll aeo.get_scan({ scanId }) until status === 'done'
aeo.get_report({ reportId }) → full report
Apply fixes, then aeo.verify({ url, ruleIds }) to confirm

REST API

POST /api/api-keys— Create a new API key (returns plain key once)

GET /api/api-keys— List your API keys (no plain text)

DELETE /api/api-keys/[id]— Revoke an API key

GET /api/usage— Get monthly usage (scans, tool calls)

Rate Limits & Quotas

Plan	Scans/month	Calls/min
Free	3/month	20/min
Starter	30/month	100/min
Pro	200/month	500/min

Security Best Practices

Never commit API keys to version control
Use environment variables or secure storage
Rotate keys immediately if exposed
Revoke unused keys from Dashboard

Go to API Keys