Skip to main content
Glama

Letters List

letters_list

Retrieve paginated letters for an organisation, with query options for sorting, filtering, searching, and field selection.

Instructions

List letters. GET /organisations/{organisationId}/deliveries/letters

Paginated collection. page_number maps to page[number] and page_limit to page[limit]; query keys (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>"
    },
    "name": "letters_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryNo
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 full behavioral burden, and it does disclose two real traits: the operation is a GET (read-only) and results are a paginated collection. It says nothing about authorisation scope, rate limits, default/maximum page size, or what a response entry looks like, so the disclosure is partial rather than complete.

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?

The purpose and endpoint lead, followed by the pagination and query passthrough rules in two compact sentences; nothing is padded. Minor noise from the doubled backtick markup and a line break mid-sentence keeps it short of ideal formatting.

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 four-parameter list tool with no annotations and no output schema, the description covers pagination and query passthrough but omits return shape, sort/filter defaults, and pagination limits. It is adequate to invoke correctly but thin on what the agent will get back or how large a page can be.

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 description coverage is 0%, so the description must compensate, and it does for three of four parameters: page_number maps to page[number], page_limit to page[limit], and query is a passthrough with concrete example keys (sort, filter, q, include, fields[...]). Only organisation_id is left unstated, and its meaning is self-evident from the required field and endpoint path.

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?

The description opens with a specific verb and resource ('List letters') and pins it to the concrete endpoint GET /organisations/{organisationId}/deliveries/letters, so an agent knows exactly what is being fetched. It does not explicitly distinguish itself from nearby siblings such as letters_show or batches_list, but the collection-vs-single-resource distinction is implicit in 'List' and 'Paginated collection'.

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 statement of when to use this tool versus alternatives like letters_show or letters_events, nor any prerequisite or exclusion guidance. The agent can infer it retrieves a paginated letter collection, but nothing tells it which situations call for this call over a sibling.

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