Get Started

Quick Start

Get your entity discoverable by AI agents in 2 minutes.

1. Generate your entity-card.json

Run the CLI in your project directory:

npx a2e init

The CLI will:

  • Detect your framework (Next.js, Nuxt, Vite, Astro, Express...)
  • Ask for your entity details (domain, name, category)
  • Configure your MCP connection(s)
  • Create the file in the right location

2. Validate

npx a2e validate

3. Deploy

Deploy your site. The file will be available at:

https://your-domain.com/.well-known/entity-card.json

Example Output

Here's what the CLI generates:

{
  "$schema": "https://raw.githubusercontent.com/a2e-protocol/a2e-protocol-spec/main/schema/entity-card.schema.json",
  "a2e": "0.1",
  "entity": {
    "domain": "acme-restaurant.com",
    "name": "Acme Restaurant",
    "category": "restaurant",
    "description": "French cuisine in Paris"
  },
  "mcps": [
    {
      "endpoint": "https://mcp.booking-provider.com",
      "capabilities": ["reservations", "availability", "menu"],
      "entity_ref": "acme-123"
    }
  ]
}

Next Steps