Capability Discovery Endpoint
The .well-known/ucp endpoint allows AI agents to discover your UCP capabilities without prior knowledge of your implementation.
Standard Endpoints Structure
Basic Capability File
Create .well-known/ucp (or .well-known/ucp.json) with:
{
"version": "1.0",
"capabilities": {
"product_catalog": {
"endpoint": "https://yourdomain.com/ucp/products",
"format": "json",
"version": "1.0"
},
"checkout": {
"endpoint": "https://yourdomain.com/ucp/checkout",
"supported_methods": ["POST"],
"version": "1.0"
},
"shipping": {
"endpoint": "https://yourdomain.com/ucp/shipping",
"supported_methods": ["POST"],
"version": "1.0"
}
}
}
Required Capabilities
- product_catalog: Endpoint for product discovery
- checkout: Endpoint for purchase initiation
Optional Capabilities
- shipping: Shipping options and calculations
- returns: Return initiation and tracking
- orders: Order history and tracking
- reviews: Product reviews and ratings
Implementation Examples
Example 1: Basic Setup
{
"version": "1.0",
"capabilities": {
"product_catalog": {
"endpoint": "https://example.com/api/ucp/products"
},
"checkout": {
"endpoint": "https://example.com/api/ucp/checkout"
}
}
}
Example 2: Full Capabilities
{
"version": "1.0",
"capabilities": {
"product_catalog": {
"endpoint": "https://example.com/api/ucp/products",
"format": "json",
"supports_search": true,
"supports_filters": ["category", "price", "availability"]
},
"checkout": {
"endpoint": "https://example.com/api/ucp/checkout",
"supported_methods": ["POST"],
"requires_authentication": false
},
"shipping": {
"endpoint": "https://example.com/api/ucp/shipping",
"supported_methods": ["POST"]
},
"orders": {
"endpoint": "https://example.com/api/ucp/orders",
"supported_methods": ["GET", "POST"]
}
}
}
Common Mistakes
Mistake 1: Wrong File Location
Problem: File not accessible at .well-known/ucp
Solution: Ensure .well-known directory is in web root and accessible via HTTP.
Mistake 2: Invalid JSON
Problem: JSON syntax errors prevent parsing
Solution: Validate JSON before deploying. Use a JSON validator.
Mistake 3: Missing Required Capabilities
Problem: AI agents can't discover products or checkout
Solution: Always include product_catalog and checkout capabilities.
Mistake 4: Incorrect Endpoint URLs
Problem: Endpoints return 404 errors
Solution: Verify endpoint URLs are correct and accessible.
Testing
Test Capability Discovery
curl https://yourdomain.com/.well-known/ucp
Verify Endpoints
Test each endpoint listed in capabilities:
curl https://yourdomain.com/ucp/products
curl -X POST https://yourdomain.com/ucp/checkout
Next Steps