Agent tools
Give an agent the workflow and exact contract it must implement.
Use Markdown to explain the task and OpenAPI to define the call. Neither replaces server-side validation.
Available sources
llms.txtlists the public APIs and guides.llms-full.txtcollects public documentation in one file.- A page menu can copy or open its Markdown.
OpenAPI contracts
Provide only the contract for the API the agent will use. Admin, Storefront, and Auth do not share every authentication, context, pagination, or error rule.
What to take from each source
| Source | Use it for |
|---|---|
| Markdown guide | Workflow order, decisions, and operating constraints. |
| OpenAPI | Method, path, parameters, body, schemas, responses, and published security. |
| Endpoint page | Readable presentation of that operation's contract. |
If a permission, example, or rule is absent from these sources, the agent should mark it as unknown. It must not invent one from the endpoint name.
Recommended instruction
Implement this operation from the attached guide and OpenAPI.
Preserve the method, path, operationId, parameters, and schemas.
Do not invent fields, permissions, responses, or examples.
Distinguish Admin, Storefront, and Auth.
Before retrying, check whether the operation is idempotent.Workflow
- Choose one API and one operation.
- Attach the workflow guide and the OpenAPI fragment for that operation.
- Ask for a typed client that uses only fields from the contract.
- Run it with development credentials and data.
- Compare the actual request and response with the published contract.
Do not infer authorization
An operation appearing in OpenAPI does not grant access. Use published security and the server response; do not assume permission names the contract does not declare.
Do not share a client_secret, access token, personal data, or production
response in the prompt. Replace values before attaching examples.