Opt Installation into Canary
agency_installation_opt_into_canaryMarks the client's installation as a canary, so it can receive package updates before other clients of the same agency. Requires the client owner and accepted set to true. It applies no update by itself.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"partnerId": "<partnerId>",
"installationId": "<installationId>",
"expectedRevision": "<expectedRevision>",
"accepted": "<accepted>"
},
"name": "agency_installation_opt_into_canary"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| accepted | Yes | Must be true to confirm the owner opts in. | |
| partnerId | Yes | The agency (partner) workspace ID. | |
| installationId | Yes | The agency package installation to act on. | |
| expectedRevision | Yes | The installation revision you last read. The call is rejected if the installation has changed since. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present when success is false | |
| receipt | No | ||
| success | Yes | Whether the tool completed successfully |