Skip to main content
Glama

Letters Events Image

letters_events_image

Retrieve the image URL for a specific letter event using organisation, letter, and event IDs; returns a 302 redirect URL so callers can fetch the image themselves.

Instructions

Get an image of a letter event. GET /organisations/{organisationId}/deliveries/letters/{letterId}/events/{letterEventId}/image

Answers 302 to the actual image; the redirect is NOT followed. Returns {"redirect_url": ..., "status_code": 302} so the caller can fetch the image themselves.

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>",
      "letter_event_id": "<letter_event_id>"
    },
    "name": "letters_events_image"
  }
}

Input Schema

NameRequiredDescriptionDefault
letter_idYes
letter_event_idYes
organisation_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does disclose the key non-obvious behavior: the endpoint answers 302, the redirect is NOT followed, and the response body is {"redirect_url", "status_code"}. That is exactly the kind of surprise an agent needs warned about; it does not cover auth requirements or whether the redirect URL expires.

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?

Two short sentences, front-loaded with the purpose and followed by the critical redirect caveat. The raw endpoint path is mildly redundant but earns its place by clarifying the parameter hierarchy.

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

Completeness4/5

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

For a simple read tool with no output schema, the description covers the essential gotcha (no redirect following) and states the return shape. Missing only auth/permission notes and any lifetime caveat on the returned redirect_url.

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

Parameters2/5

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

Schema description coverage is 0% and all three parameters are bare strings, so the description must compensate. The embedded path template only hints at the org > letter > event hierarchy; it never explains what any of the three IDs are or where to obtain them, leaving the required-parameter semantics largely unexplained.

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 gives a specific verb and resource ('Get an image of a letter event') and reinforces it with the exact endpoint path, so the agent knows precisely what is retrieved. The 'letter' qualifier implicitly separates it from the email and ebill image siblings, but no sibling is named explicitly.

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?

There is no statement of when to call this instead of the event-listing siblings (letters_events, organisations_letters_events_*), nor any preconditions. Usage is only implied by the resource name, though the note that the caller must fetch the image themselves does convey a practical workflow constraint.

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