counterparty.list

Live

Paginated enumeration of counterparties with filters.

CategoryCounterparty
JSON-RPCtools/call
EndpointPOST /mcp
Sourcepackages/mcp-tools/src/tools/counterparty-list.ts

Description

Filter by free-text query, entity_type, and minimum trust pair level. Default page size 25; max 100. Per ADR-0021 §read-API Family B.

Input schema

FieldTypeRequiredDescription
querystringnoFree-text query against display_name + recent_summary.
entity_typestringnoDefault 'person'.
has_trust_pair_at_least1 | 2 | 3noFilter for counterparties with at least one trust pair at this level.
limitintegernoDefault 25; max 100.
cursorstringnoPagination cursor.

Output shape

typescript
{ items: Array<{ counterparty_id: string; display_name: string; entity_type: string; trust_pair_count: number }>; next_cursor?: 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": "counterparty.list", "arguments": { "has_trust_pair_at_least": 2, "limit": 5 } }

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
{
  "items": [
    { "counterparty_id": "entity_01HXSARAH", "display_name": "Sarah Chen", "entity_type": "person", "trust_pair_count": 3 }
  ]
}

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.

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