Skip to Content
Machine interfacesKeeping machine descriptions current

Developer reference

Keep machine descriptions current

Verify generated operations against methods, scopes and mounted behavior when the API changes.

The operation registry is the source for machine descriptions. Updating a description without updating the real handler can make a client promise actions the application cannot perform.

Change sequence

  1. Update the registered method, route and scope alongside the actual handler.
  2. Review authentication and request validation.
  3. Verify the service’s domain effects and owned-resource checks.
  4. Regenerate the operation manifest.
  5. Run drift checks and the affected API tests.

The source generator is scripts/generate-mcp-manifest.mjs; the operation registry is src/server/api/scopes.ts. Use the installed release toolchain rather than editing generated rows independently.

What drift checks establish

A matching manifest can establish description alignment. It does not establish provider availability, a working native import parser or an MCP transport. Test mounted behavior in an authorized environment for a new operation.

Planned operations stay planned

Do not add future exports, assistant actions or deletion facilities to the available tool list solely because a helper or reserved scope exists. A route, its validation and its actual service need to agree.

For the public docs, keep the endpoint catalog synchronized with the registry. Read current interface status before publishing connection instructions.