Publish the contract
If an interface matters, describe its shape somewhere software can verify.
Is Agenticis-agentic.com
The score is an at-a-glance summary; the individual checks and evidence are the useful part of the report.
Notes from the Is Agentic checks and report format.
Plan a request
Ask both agents to fetch the latest report.
Prose onlyBad
Reports API
Use our report endpoint to work with scores. Pass a website and get its report.
“Use the report endpoint”Typed contractGood
- operationId
- getLatestReport
- method
- GET
- path
- /api/v1/report
- query
- url: uri, required
- 200
- Report
- 404
- Problem
openapi: 3.1.0paths:
/api/v1/report:
get:
operationId: getLatestReport
summary: Return the latest completed report
parameters:
- in: query
name: url
required: true
schema: { type: string, format: uri }
responses:
'200': { $ref: '#/components/responses/Report' }
'404': { $ref: '#/components/responses/Problem' }
Why it matters, pros and cons
Why it matters
Prose teaches intent. A contract removes ambiguity. Keeping both is better than asking either one to do the other’s job.
Pros
- Inputs and failures can be validated.
- Generated clients share one source of truth.
- Operation names become durable vocabulary.
Cons
- A stale contract is worse than no contract.
- Tiny internal interfaces may not need a public spec.
- Examples still matter beside the schema.