watchlists.add

Live

Per-counterparty subscription shorthand.

CategorySubscriptions
JSON-RPCtools/call
EndpointPOST /mcp
Sourcepackages/subscriptions/src/tools/watchlists-add.ts

Description

alert_on accepts any subset of new_episode, commitment_due, trust_change. Per ADR-0021 §subscriptions.

Input schema

FieldTypeRequiredDescription
counterparty_idstringyesCounterparty to watch.
alert_onArray<'new_episode' | 'commitment_due' | 'trust_change'>noDefault: all three.

Output shape

typescript
{ watchlist_entry_id: string }

Example call

JSON-RPC tools/call request body (omit the JSON-RPC envelope when using an SDK; the SDK adds it for you):

jsontools/call params
{ "name": "watchlists.add", "arguments": { "counterparty_id": "entity_01HXSARAH", "alert_on": ["new_episode", "commitment_due"] } }

Example response

Tool results are always wrapped as content[0].text with a stringified JSON body. The shape below is what you get back from JSON.parse(result.content[0].text):

jsonparsed result body
{ "watchlist_entry_id": "wlst_01H..." }

Errors this tool can return

CodeMeaning
invalid_argumentsTool input failed Zod validation.
unauthorizedMissing or invalid bearer token.
quota_exceededPer-minute, daily call, or daily inference budget exceeded.
not_foundThe requested resource (action_id, decision_id, counterparty_id, etc.) was not found.

See the full error catalog for resolution steps on each code, plus the standard transport-layer responses (401, 429).