Skip to main content
Glama

getReport

Read-onlyIdempotent

Retrieves one entire report as JSON, with all of its issues, violators, and diagnoses. Use this instead of drilling down through listIssues, listViolators, and listDiagnoses when the full report is needed in one call. Returns the complete report data for the specified report identifier. The size of the report is disclosed by the listIssues tool.

Input Schema

NameRequiredDescriptionDefault
reportIDYesIdentifier of the report (example: 260503T0432-x9z)

Output Schema

NameRequiredDescriptionDefault
tool nameYes
this requestYes
tool collectionYes
response contentYes
response metadataYes
URLs of similar requests for web usersYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • addedOutput schema / definitions / ToolsFacts / properties / description / properties / how to generate more findings / properties / approval
      Added value: +{
      +  "type": "string"
      +}
    • removedOutput schema / definitions / ToolsFacts / properties / description / properties / how to generate more findings / properties / confirmation
      Removed value: -{
      -  "type": "string"
      -}
    • addedOutput schema / definitions / ToolsFacts / properties / description / properties / how to generate more findings / properties / order confirmation
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / definitions / ToolsFacts / properties / description / properties / how to generate more findings / properties / request confirmation
      Added value: +{
      +  "type": "string"
      +}
    • changedOutput schema / definitions / ToolsFacts / properties / description / properties / how to generate more findings / required
      Previous value: -[
      -  "new testing",
      -  "retesting",
      -  "latency",
      -  "confirmation"
      -]New value: +[
      +  "new testing",
      +  "retesting",
      +  "approval",
      +  "latency",
      +  "request confirmation",
      +  "order confirmation"
      +]
  2. Changed4 schema fields changed
    • removedInput schema / properties / jobID
      Removed value: -{
      -  "description": "Job identifier of the report (example: x9z)",
      -  "type": "string"
      -}
    • addedInput schema / properties / reportID
      Added value: +{
      +  "description": "Identifier of the report (example: 260503T0432-x9z)",
      +  "type": "string"
      +}
    • removedInput schema / properties / timeStamp
      Removed value: -{
      -  "description": "Timestamp of the report in YYMMDDTHHmm format (example: 260503T0432)",
      -  "type": "string"
      -}
    • changedInput schema / required
      Previous value: -[
      -  "timeStamp",
      -  "jobID"
      -]New value: +[
      +  "reportID"
      +]
  3. Changed2 schema fields changed
    • removedOutput schema / definitions / RequestReference / properties / method / const
      Removed value: -"GET"
    • addedOutput schema / definitions / RequestReference / properties / method / enum
      Added value: +[
      +  "GET",
      +  "POST"
      +]
  4. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world, so the safety profile is covered. The description adds value beyond that by disclosing the payload shape (all issues/violators/diagnoses in one response) and a size/cost caveat deferred to listIssues — a useful behavioral trait for a tool that may return very large payloads.

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

Conciseness3/5

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

Front-loaded well with the core purpose and the routing advice, but the third sentence ('Returns the complete report data for the specified report identifier') largely restates the first and earns little. The size note is useful but plumbed in awkwardly at the end.

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?

With rich annotations and an output schema present, the description needn't spell out return structure, and it appropriately covers purpose, alternative routing, and a size caveat. The only soft gap is the vague pointer that size is 'disclosed by the listIssues tool' rather than stating a threshold or pagination behavior.

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 description coverage is 100% and the single parameter has an example format, so the schema carries the burden. The description only restates it as 'the specified report identifier' and adds no format or validation detail beyond the schema.

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

Purpose5/5

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

States a specific verb+resource ('Retrieves one entire report as JSON') and enumerates the payload contents (issues, violators, diagnoses), which cleanly separates it from the list* siblings. An agent can distinguish it from listIssues/listViolators/listDiagnoses without opening any schema.

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

Usage Guidelines4/5

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

Explicitly names the alternatives to avoid ('instead of drilling down through listIssues, listViolators, and listDiagnoses') and the condition that selects this tool (full report needed in one call). It stops short of a hard when-not rule, only hinting via the note that report size is disclosed by listIssues.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.