OSPRIDocs
Developers

How every new tool should connect

Build once; support the app, scripts and assistants consistently.

Ship one set of operations

The app, API, MCP and supported Excel clients call the same domain operations. Keep calculations and record ownership in the product, not copied into each interface.

Every operation documents

  • Its purpose, required permission and whether it changes anything.
  • Exact inputs, outputs, units, version and errors.
  • Run IDs, status states, pause/resume/cancel support and evidence links.
  • Limits, paging, timeout and safe retry behavior.
  • Usage/cost attribution and whether a cost is measured, estimated or unknown.

Before release

  1. Run a real workflow through the app, HTTP, command line, Python, Node.js and the actual supported MCP client.
  2. Read the same saved run from another client. Compare the result and evidence.
  3. Prove viewer write denial, revoked access denial and other-workspace isolation.
  4. Test duplicate/uncertain requests and every supported lifecycle action.
  5. Check the export/add-in separately, generate the reference and run its examples in CI.
  6. Preserve current login and ownership behavior; rehearse rollback and restore into an isolated target.
  7. Have a teammate follow the quickstart without an undocumented step.

Keep planned behavior separate from tested behavior. A failed or skipped required test leaves the release requirement open.

On this page