Skip to main content
Glama

Letters Events

letters_events

Retrieve a paginated collection of events for a specific letter and organisation, with query filters, sorting, pagination, and field selection.

Instructions

Get a collection of letter events. GET /organisations/{organisationId}/deliveries/letters/{letterId}/events

Paginated collection. page_number maps to page[number] and page_limit to page[limit]; query keys (language, sort, filter, q, include, fields[...]) pass through verbatim.

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": {
      "organisation_id": "<organisation_id>",
      "letter_id": "<letter_id>"
    },
    "name": "letters_events"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryNo
letter_idYes
page_limitNo
page_numberNo
organisation_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the burden itself; it does disclose that the endpoint is a GET and that the result is paginated, and explains how paging params translate to page[number]/page[limit]. It does not describe return contents, ordering, rate limits, or error behavior — gaps left open since no annotations or output schema exist.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short clauses: purpose, endpoint, then pagination/query mechanics — front-loaded and free of filler. The endpoint line is somewhat redundant with the purpose line but adds locational precision.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 5-parameter read tool with no annotations and no output schema, the description covers input mechanics well but says nothing about what an event record contains or how results are ordered. Adequate to invoke, thin for interpreting results.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description must compensate, and it largely does: it maps page_number/page_limit to their wire names and enumerates the allowed query keys (language, sort, filter, q, include, fields[...]) with the note that they pass through verbatim. organisation_id and letter_id are only implied by the path rather than explained, which keeps it from a 5.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Get a collection of letter events') and pins it to an exact endpoint, so the agent knows it retrieves event records for a single letter. It does not distinguish itself from closer siblings such as organisations_letters_events_sent or batches_events, so it stops short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no explicit guidance on when to use this versus the many sibling event endpoints (sent, delivered, issues, undeliverable, image), nor any prerequisites beyond the implied path parameters. Usage is only inferable from the endpoint template.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.