Contracts#
A contract is the shape two sides agree on: the JSON a service returns, the parameters a tool takes, the behaviour every implementation of an interface has to honour. These pages are what you read when you consume one of those shapes or write something new against it – a CI job that parses a health report, a connector for a control system OSPREY does not ship, a script that loads a channel database. For the day-to-day work of configuring any of it, the how-to guides are the better starting point.
osprey health --json ContractThe exact shape of the JSON document osprey health --json writes, the
exit codes that go with it, and how to consume both from a CI job.
What every connector must implement at its edges: how large array values come back, how a write reports whether it took effect and which safety gates it passes first, and the archiver’s historical-data contract.
How a tool asked for several things says what it did not answer: the
missing map, the nothing_answered error, and the tools that
carry them.
The execute and execute_file MCP tool parameters, the JSON a
successful run returns, and how a failing one reports itself.
The MCP tools that reach the logbook search service, the structure of a search result, the capabilities endpoint the web interface reads, and the database schema every entry is stored in.
The JSON schema each channel database pipeline expects, the
config.yml keys that select a pipeline and point it at its database,
and how the active pipeline is served to the agent as one
channel-finder MCP server.
What the facility graph stores, how its names are spelled, and what each
of the four graph MCP tools returns.
What a package declares to register a measurement kind, what the build judges and writes for it, and the signal roles, engine record words and scenario stops a kind leans on.
The JSON body a chat bridge fires at the dispatcher: the conversation so far, the message being replied to, the attached and replayed files, and the notes that account for what did not fit.
Which tools hold the run lock, where it lives, what a second run is told, and what a stopped run leaves.
How each safety decision lands in the agent record and its archive, the fields of every entry, who can read them, and what the trail does not promise.
The session hold record and where it lives, the routes and frames of the flag dialog, where the hold refuses a write, and what a verdict’s audit entry holds.
The dock engine the web terminal vendors from CANOPY’s screen runtime, the server’s copy of its layout rules, and how the copies are pinned.