Skip to main content
Mermail exposes public discovery routes so agents and tools can understand the service before calling protected APIs.

Human and AI-readable indexes

PathPurpose
/llms.txtShort AI-readable index
/llms-full.txtLonger concatenated index
/auth.mdAgent registration and auth details
/_agent-home.mdAgent-oriented landing page

API metadata

PathPurpose
/openapi.jsonPublic OpenAPI document
/docs/openapi.jsonSame OpenAPI document under docs path
/.well-known/api-catalogAPI catalog metadata
/.well-known/oauth-authorization-serverOAuth authorization server metadata
/.well-known/oauth-protected-resourceProtected resource metadata
/.well-known/openid-configurationOpenID Connect metadata
/.well-known/jwks.jsonJSON Web Key Set metadata

Commerce and agent protocols

PathPurpose
/.well-known/ucpUniversal Commerce Protocol metadata
/.well-known/acp.jsonAgent Commerce Protocol metadata
/.well-known/mcp/server-card.jsonMCP server card
/.well-known/agent-skills/index.jsonAgent skill index
Use discovery documents for integration setup. Do not hardcode hosts when a document returns absolute URLs for the current deployment.