AgentReady Protocol

{
  "schema_version": "1.0",
  "name": "Your Product Name",
  "description": "Brief description of your product for agents",
  "url": "https://yoursite.com",
  "logo_url": "https://yoursite.com/logo.png",
  "contact_email": "support@yoursite.com",

  "manifest_url": "https://yoursite.com/.well-known/agent-manifest.json",

  "capabilities": {
    "auth_methods": ["api_key", "oauth2"],
    "has_api": true,
    "has_docs": true,
    "has_widget": true
  },

  "verification": {
    "dns_txt": "agentready=abc123",
    "meta_tag": "agentready-verification"
  }
}

{
  "schema_version": "1.0",
  "name": "Your Product Name",
  "description": "Help agents understand what your product does",

  "onboarding": {
    "start_url": "https://yoursite.com/signup",
    "steps": [
      {
        "id": "signup",
        "title": "Create Account",
        "url": "https://yoursite.com/signup",
        "description": "Create a free account to get started"
      },
      {
        "id": "api_key",
        "title": "Get API Key",
        "url": "https://yoursite.com/settings/api",
        "description": "Generate an API key from the settings page"
      },
      {
        "id": "quickstart",
        "title": "Follow Quickstart",
        "url": "https://yoursite.com/docs/quickstart",
        "description": "Complete the quickstart guide"
      }
    ]
  },

  "docs": {
    "canonical": [
      {
        "title": "API Reference",
        "url": "https://yoursite.com/docs/api",
        "priority": "high"
      },
      {
        "title": "Authentication",
        "url": "https://yoursite.com/docs/auth",
        "priority": "high"
      },
      {
        "title": "Examples",
        "url": "https://yoursite.com/docs/examples",
        "priority": "medium"
      }
    ],
    "avoid": [
      "https://yoursite.com/blog/*",
      "https://community.yoursite.com/*"
    ]
  },

  "guardrails": {
    "require_confirmation": [
      "delete",
      "payment",
      "subscription_change"
    ],
    "prohibited_actions": [
      "share_api_key",
      "modify_billing"
    ],
    "rate_limits": {
      "requests_per_minute": 60
    }
  },

  "prompt": "You are onboarding to {{name}}.\n\nFollow ONLY the official path:\n{{#each onboarding.steps}}\n{{@index}}. {{url}}\n{{/each}}\n\nRules:\n- Ask before destructive actions.\n- Prefer official docs over blog posts."
}

<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "WebApplication",
  "name": "Your Product Name",
  "url": "https://yoursite.com",
  "applicationCategory": "BusinessApplication",
  "additionalProperty": {
    "@type": "PropertyValue",
    "name": "agentready:manifest",
    "value": "https://yoursite.com/.well-known/agent-manifest.json"
  }
}
</script>

<!-- Primary discovery -->
<meta name="agentready:manifest" content="https://yoursite.com/.well-known/agent-manifest.json">

<!-- Quick info for agents -->
<meta name="agentready:name" content="Your Product Name">
<meta name="agentready:version" content="1.0">
<meta name="agentready:start" content="https://yoursite.com/signup">

<!-- Verification -->
<meta name="agentready-verification" content="abc123">

<!-- Modal triggers -->
<button data-open-modal>Open Agent Modal</button>
<button data-close-modal>Close</button>

<!-- Action hints -->
<button data-agent-action="signup">Sign Up</button>
<button data-agent-action="get-api-key">Get API Key</button>

<!-- Semantic hints -->
<form data-agent-form="signup">...</form>
<input data-agent-field="email" type="email">
<input data-agent-field="api-key" type="text" readonly>

<!-- Navigation hints -->
<nav data-agent-nav="primary">...</nav>
<a data-agent-link="docs" href="/docs">Documentation</a>

<!-- Content hints -->
<main data-agent-content="primary">...</main>
<aside data-agent-content="sidebar">...</aside>

<!-- Dangerous action warnings -->
<button data-agent-danger="true" data-agent-confirm="Are you sure?">
  Delete Account
</button>

<!-- Modal backdrop (required) -->
<div id="backdrop" role="dialog" aria-modal="true">
  ...modal content...
</div>

<!-- Prompt display (required) -->
<pre id="modalPrompt">Your agent prompt here</pre>

<!-- Download button (required) -->
<button id="downloadManifestBtn">Download manifest</button>

<!-- Toast notification (optional but recommended) -->
<div id="toast" role="status" aria-live="polite">Done</div>

// Open the widget modal
window.AgentReady.openModal();

// Close the widget modal
window.AgentReady.closeModal();

// Copy prompt to clipboard
window.AgentReady.copyPrompt();

// Download the manifest file
window.AgentReady.downloadManifest();

// Show toast notification
window.AgentReady.showToast("Message copied!");

// Get manifest data
const manifest = await window.AgentReady.getManifest();

// Check if widget is open
const isOpen = window.AgentReady.isModalOpen();

// Configure widget
window.AgentReady.configure({
  manifestUrl: "/.well-known/agent-manifest.json",
  theme: "light",
  position: "bottom-right"
});