Skip to main content
Glama

Letters Show

letters_show

Fetch details for one letter by organisation and letter ID, returning the unchanged JSON:API document and passing include and field query parameters through verbatim.

Instructions

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

Returns the JSON:API document for a single letter, unchanged. query keys (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_show"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryNo
letter_idYes
organisation_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations supplied, the description carries the disclosure burden and does reasonably well: the GET verb establishes a read, and it states the return is the JSON:API document for a single letter returned unchanged, plus that query keys are passed through verbatim. It adds no notes on auth scope, error responses, or whether unchanged means raw upstream payload including errors.

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?

It is short and front-loaded, leading with the purpose before the endpoint and the query passthrough note. The endpoint string and the "unchanged" clause both earn their place, though the phrasing is slightly redundant between "Returns the JSON:API document" and "the JSON:API document for a single letter".

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

Completeness5/5

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

The tool is a simple two-ID read with an optional query bag, and since no output schema exists, the description correctly spends its budget explaining the response shape and the passthrough semantics of query. Nothing an agent needs to call it correctly appears to be missing.

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

Parameters3/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. It does this well for the only genuinely ambiguous parameter, query, explaining that include and fields[...] keys pass through verbatim, and the path template clarifies where organisation_id and letter_id are consumed. It still adds no format or validity constraints for the two ID parameters beyond their position in the URL.

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 uses a specific verb and resource ("Get details of a letter") and anchors it with the exact endpoint path and the letterId segment, which makes clear this is a single-resource fetch rather than a listing. It stops short of naming the sibling list tool, so the contrast with letters_list is left to inference.

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

Usage Guidelines3/5

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

Usage is implied by "details of a letter" plus the path template containing {letterId}, which signals it is for known IDs. There is no explicit statement of when to prefer this over letters_list or the letters_events family, and no prerequisite or error-condition guidance.

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