An agents.md file helps AI agents understand what the site does, what actions they are allowed to take, how to authenticate, and how to stay within technical limits such as rate limiting. This reduces failed integrations and sets clearer expectations.
Place the file here:
/Files/System/wwwroot/agents.md
Dynamicweb serves it at:
https://example.com/agents.md
Format
There is no enforced standard for agents.md yet. Write it as a practical guide for an automated system reading it cold. Include:
- What the site is
- What an agent can do
- How authentication works
- Which rate limits apply
- Who to contact for support
Example:
# Agent Guide — Acme Industrial Supplies
## What this site is
B2B e-commerce platform for industrial components. Registered business customers can browse
products, check live stock, and place orders.
## What agents can do
### Browse catalog
- List categories: `GET /api/products/categories`
- Search products: `GET /api/products?q={query}&category={slug}`
- Product detail: `GET /api/products/{id}`
### Check availability
- Stock level: `GET /api/products/{id}/stock`
### Place orders (authenticated)
- Create order: `POST /api/orders`
- Order status: `GET /api/orders/{orderId}`
## Authentication
Bearer token. Obtain a token via:
`POST /api/auth/token`
\```json
{ "username": "...", "password": "..." }
\```
Tokens expire after 60 minutes.
## Rate limits
100 requests per minute per IP address. Responses include `X-RateLimit-Remaining` headers.
## Contact
For API access or integration support: api@example.com
Tip
Even if your customer has no public API today, an agents.md file that clearly states the site's purpose and contact details is useful. It prevents AI agents from guessing and making incorrect assumptions about the site's capabilities.