Documentation
README
API Compatibility Review Framework
Assess API changes by surface โ the MCP tool surface (dynamically re-discovered by clients) and the REST surface (hardcoded clients) have different compatibility models. Do not apply REST-style breaking-change caution to MCP tools, and do not apply MCP's rename-friendliness to REST.
Step 1: Classify the Change
Determine which surface(s) the change touches:
- MCP tools โ
application/tools/tool definitions,parameterSchema, tooldescriptionstrings - REST API โ
interfaces/api/v1/routes/,interfaces/api/v1/dto/Dtos.kt,openapi.yaml
A single change (e.g., a domain model field rename) can touch both surfaces independently โ assess each.
This is the opening of the README. Read the full README on GitHub.