API Reference

Developer API

AgentReady exposes a public REST API and MCP server. The scan endpoint is free and requires no authentication for anonymous use. Authenticated endpoints require a Clerk JWT.

OpenAPI Spec (JSON) Interactive Docs (Swagger)

Base URL

https://agentfyo.com

Endpoints

POST/api/scanOptional (Bearer token)

Scan a store URL and return AI readiness score, breakdown, and JSON-LD fixes.

Request body

{ "url": "https://yourstore.com" }

Response

{
  "status": "success",
  "data": {
    "total_score": 47,
    "score_breakdown": {
      "structured_data": { "score": 8, "max": 40 },
      "agent_readiness": { "score": 18, "max": 25 },
      "content_readability": { "score": 14, "max": 20 },
      "entity_signals": { "score": 7, "max": 15 }
    },
    "suggested_fixes": ["Add JSON-LD Product schema", "..."],
    "generated_schema": "{ ... }"
  }
}

GET/api/v1/public/feed/{slug}None (public)

Retrieve the AI product feed for a store as Schema.org ItemList JSON-LD.

Response

{
  "@context": "https://schema.org/",
  "@type": "ItemList",
  "numberOfItems": 42,
  "itemListElement": [
    { "@type": "ListItem", "position": 1, "item": { "@type": "Product", ... } }
  ]
}

GET/api/v1/historyRequired (Bearer token)

Retrieve scan history for the authenticated user.

Response

[{ "id": 1, "url": "...", "total_score": 47, "created_at": "..." }]

MCP Server for AI Agents

AgentReady exposes an MCP (Model Context Protocol) server so AI agents — Claude, ChatGPT plugins, Perplexity, and custom agents — can scan stores, retrieve scores, and generate schemas without a browser. This enables direct AI integration for automated AI visibility optimization workflows.

Available tools

scan_store(url)Score a store and return the full AI readiness analysis (0-100)

get_score(scan_id)Retrieve a previously run scan by ID with detailed breakdown

generate_schema(product_url)Generate optimized JSON-LD schema for a product URL

compare_stores(url1, url2)Compare AI visibility between two stores

Add to Claude Desktop / claude_desktop_config.json:

{
  "mcpServers": {
    "agentready": {
      "url": "https://agentfyo.com/mcp",
      "type": "streamable-http"
    }
  }
}

Get your API key

Create Account →