This example shows how to model a private API where security, auditability, and blast-radius control matter more than broad discoverability.
accounts.lookupaccounts.status.getdeployments.list
- Keep provider code behind a narrow adapter layer so internal headers and auth details do not leak into tool modules.
- Favor allow-listed identifiers over broad search when the API exposes sensitive records.
- Treat every list endpoint as a policy decision: cursor limits, redaction, and audit logging should be explicit.
- Prefer service-to-service tokens with short rotation windows.
- Log request correlation IDs and caller identity for every mutating action.
- Document environment ownership and incident routing inside the derived repo.
See tool-catalog.json for a minimal catalog sketch.