Getting Started

Quick Start

From zero to validated manifest in 5 minutes.


Install

bash
npm install @agentic-web-protocol/validator # or globally npm install -g @agentic-web-protocol/validator
bash
pip install agentic-web-protocol awp --version

Write your manifest

Create /.well-known/agentic-web-protocol.json in your project root:

/.well-known/agentic-web-protocol.json
{ "version": "1.0", "name": "Acme Docs", "description": "Technical documentation and API reference for the Acme platform.", "capabilities": ["content", "search", "api"], "endpoints": { "manifest": "/awp/manifest.json", "content": "/awp/content/", "api": "/awp/api/" }, "authentication": { "required": false, "methods": ["none"] }, "rate_limits": { "requests_per_minute": 60 } }

Validate

typescript
import { AWPValidator } from '@agentic-web-protocol/validator'; const v = new AWPValidator(); const result = v.validateDiscoveryManifest(manifest); if (result.valid) { console.log('✓ Valid'); } else { result.errors.forEach(e => console.error(`${e.path}: ${e.message}`)); }
python
from agentic_web_protocol import AWPValidator v = AWPValidator() result = v.validate_discovery_manifest(manifest) if result.valid: print("✓ Valid") else: for e in result.errors: print(f"✕ {e.path}: {e.message}")
bash
awp validate discovery .well-known/agentic-web-protocol.json awp score .well-known/agentic-web-protocol.json

Score your implementation

The scorer grades A–F based on completeness, token budget compliance, and content quality:

typescript
import { AWPValidator, Scorer } from '@agentic-web-protocol/validator'; const validator = new AWPValidator(); const scorer = new Scorer(); const result = validator.validateDiscoveryManifest(manifest); if (result.valid) { const score = scorer.score(manifest); console.log(`Score: ${score.letter} (${score.numeric}/100)`); // → Score: A (94/100) }

Next steps