Quick Start

Get your app discoverable by AI agents in 5 minutes.

Create your manifest

Create a file at /.well-known/oap.json in your app's public root. Use the interactive generator or write it by hand:

/.well-known/oap.json

{
  "oap_version": "0.1",
  "identity": {
    "name": "Your App Name",
    "tagline": "One-line description (max 120 chars)",
    "description": "What your app does — written for AI comprehension (max 500 chars)",
    "url": "https://yourapp.com"
  },
  "builder": {
    "name": "Your Name or Company"
  },
  "capabilities": {
    "summary": "Detailed natural language description for semantic matching...",
    "solves": [
      "problem your app solves #1",
      "problem your app solves #2",
      "problem your app solves #3"
    ],
    "ideal_for": [
      "target user #1",
      "target user #2"
    ],
    "categories": ["your-category"],
    "differentiators": ["what makes you unique"]
  },
  "pricing": {
    "model": "freemium",
    "trial": { "available": true }
  },
  "trust": {
    "data_practices": {
      "collects": ["email addresses"],
      "stores_in": "US-based cloud",
      "shares_with": ["none"]
    },
    "security": {
      "authentication": ["email/password"]
    },
    "external_connections": ["AI language model API"]
  },
  "integration": {
    "api": { "available": false }
  },
  "verification": {
    "health_endpoint": "https://yourapp.com/api/health"
  }
}

Or use the CLI generator: node tools/generate.js

Deploy your manifest

Make sure your manifest is accessible at https://yourapp.com/.well-known/oap.json. Most frameworks serve static files from a public/ directory.

# Test that your manifest is accessible
curl https://yourapp.com/.well-known/oap.json | jq .

# Validate it against the spec
node tools/validate.js https://yourapp.com/.well-known/oap.json

Add DNS TXT record (optional)

Add a TXT record at _oap.yourapp.com to prove domain ownership. This is optional but increases trust signals for AI agents.

DNS TXT Record

_oap.yourapp.com  TXT  "v=oap1; cat=your-category; manifest=https://yourapp.com/.well-known/oap.json"

Register with the OAP Registry

curl -X POST https://registry.oap.dev/api/v1/register \
  -H "Content-Type: application/json" \
  -d '{"url": "https://yourapp.com"}'

Verify

Check that your app appears in the registry:

# Check your app details
curl https://registry.oap.dev/api/v1/apps/yourapp.com | jq .

# Search for your app
curl "https://registry.oap.dev/api/v1/search?q=your+app+name" | jq .

For AI Coding Tools

You can tell your AI coding assistant: “Add OAP support to my app. Read the spec at oap.dev/spec and create a manifest at .well-known/oap.json that accurately describes this application.”