Protocol

Schema Reference

All 6 AWP schemas — every field, every constraint, every example.


Recommended Folder Structure

AWP relies on predictable paths. This is the standard directory layout for an AWP-compliant website:

Project Structure
/ (Root of your website) ├── .well-known/ │ └── agentic-web-protocol.json # 1. Discovery Manifest (Entry point) └── awp/ ├── manifest.json # 2. Full Site Manifest ├── content/ │ ├── structure.json # 3. Content Navigation Tree │ └── feeds/ │ └── updates.json # 4. Incremental Updates Log ├── api/ │ └── tools/ │ └── functions.json # 5. Callable AI Functions └── mcp/ └── mcp.json # 6. Model Context Protocol config

Core Manifests

These two files form the absolute foundation of your agentic integration.

1. Discovery Manifest

Published at /.well-known/agentic-web-protocol.json. The first file any AWP-aware agent fetches.

FieldTypeRequiredDescription
versionstringrequiredSemver string e.g. "1.0"
namestringrequiredHuman-readable site name. Max 200 chars.
descriptionstringrequiredBrief description. 10–500 chars.
capabilitiesstring[]requiredcontent | api | search | mcp | analytics
endpointsobjectrequiredPath map. manifest field is required inside.
authenticationobjectoptionalAuth requirements for agents.
rate_limitsobjectoptionalPer-minute and per-day request limits.
agent_instructionsuri-refoptionalPath to etiquette file for agents.
updated_atdatetimeoptionalISO 8601 timestamp of last update.
discovery.example.json
{ "version": "1.0", "name": "ML Research Hub", "description": "Comprehensive ML research, tutorials, and datasets for AI agents.", "capabilities": ["content", "search", "api", "mcp"], "endpoints": { "manifest": "/awp/manifest.json", "content": "/awp/content/", "api": "/awp/api/", "mcp": "/awp/mcp/mcp.json" }, "authentication": { "required": true, "methods": ["api_key"], "registration": "/awp/auth/register" }, "rate_limits": { "requests_per_minute": 60, "requests_per_day": 10000, "tokens_per_request": 4096 }, "agent_instructions": "/awp/instructions.md", "updated_at": "2025-01-15T10:30:00Z" }

2. Full Manifest

Lives at /awp/manifest.json. Contains full site metadata, capability config, CORS, and caching hints.

FieldTypeRequired
awp_versionstringrequired
siteobjectrequired
contentobjectrequired
capabilitiesobject[]required
apiobjectoptional
cache_controlobjectoptional
corsobjectoptional
agent_hintsobjectoptional

Content & Navigation

Schemas designed to help AI agents read and traverse your website's documentation and pages.

3. Content Structure

Lives at /awp/content/structure.json. Maps your entire content tree.

structure.example.json
{ "version": "1.0", "site_name": "ML Research Hub", "generated_at": "2025-01-15T10:30:00Z", "total_pages": 142, "total_tokens": 850000, "sections": [ { "id": "tutorials", "title": "Tutorials", "token_count": 120000, "pages": [ { "title": "Getting Started with PyTorch", "path": "/tutorials/pytorch-intro", "token_count": 3200, "tags": ["pytorch", "beginner"] } ] } ] }

4. Updates Schema

Lives at /awp/content/feeds/updates.json. Incremental change log so agents can sync without re-fetching everything.

updates.example.json
{ "version": "1.0", "last_sync": "2025-01-15T10:30:00Z", "sync_interval_seconds": 86400, "changes": [ { "type": "created", "id": "page-transformer-guide", "timestamp": "2025-01-15T09:00:00Z", "path": "/tutorials/transformers", "title": "Transformer Architecture Deep Dive", "token_count": 5200 } ], "has_more": false }

Tools & Execution

Schemas that expose interactive capabilities, APIs, and secure tool execution pointers to LLMs.

5. Functions Schema

Lives at /awp/api/tools/functions.json. Declares callable API functions — agents can invoke these directly.

functions.example.json
{ "version": "1.0", "functions": [ { "name": "search_content", "description": "Full-text search across all site content. Returns ranked results.", "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "Natural language query" }, "limit": { "type": "integer", "description": "Max results (1-50)", "default": 10 } }, "required": ["query"] }, "tags": ["search", "content"] } ] }

6. MCP Schema

Lives at /awp/mcp/mcp.json. Minimal pointer: where the MCP server is and how to authenticate.

FieldTypeRequiredDescription
urlurirequiredFull URL to the MCP server endpoint
transportenumrequiredhttp (recommended) | sse (legacy) | stdio
authenticationobjectoptionalAuth type and credential delivery config
mcp_versionstringoptionalMCP protocol version e.g. "2024-11-05"