Skip to main content
Glama

read_announcement

Read-onlyIdempotent

Read and analyze a specific NZX announcement. Extracts summary, key figures, sentiment, entities, and risk flags using AI. Provide the announcement_id (e.g. "12345") from search_announcements results. Returns cached results if previously extracted.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
announcement_idYesThe announcement_id from search_announcements results

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesThe tool payload. Null when the call did not produce one — read meta.availability_status to find out why, and do not treat null as zero, empty or "none found".
metaYes
toolYesTool that produced this result.
schema_versionYesEnvelope contract version. Bumps only on a breaking shape change.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "data": {
      +      "description": "The tool payload. Null when the call did not produce one — read meta.availability_status to find out why, and do not treat null as zero, empty or \"none found\"."
      +    },
      +    "meta": {
      +      "additionalProperties": true,
      +      "properties": {
      +        "availability_status": {
      +          "description": "ok: complete payload. truncated: payload exceeded the transport cap and was cut. parse_failed: payload is text this server could not parse as JSON. error: the tool raised.",
      +          "enum": [
      +            "ok",
      +            "truncated",
      +            "parse_failed",
      +            "error"
      +          ],
      +          "type": "string"
      +        },
      +        "encoding": {
      +          "description": "toon = pipe-delimited tabular encoding; header row names the columns.",
      +          "enum": [
      +            "json",
      +            "toon"
      +          ],
      +          "type": "string"
      +        },
      +        "provenance": {
      +          "description": "Whether the figures can cite a source document. \"undeclared\" means no claim has been made for this endpoint yet — it is not a claim that the data is unsourced.",
      +          "enum": [
      +            "direct",
      +            "label",
      +            "reachable",
      +            "none",
      +            "undeclared"
      +          ],
      +          "type": "string"
      +        },
      +        "retrieved_at": {
      +          "description": "When this platform produced the answer — NOT the as-at date of the data.",
      +          "format": "date-time",
      +          "type": "string"
      +        },
      +        "warnings": {
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "required": [
      +        "retrieved_at",
      +        "availability_status",
      +        "provenance"
      +      ],
      +      "type": "object"
      +    },
      +    "schema_version": {
      +      "description": "Envelope contract version. Bumps only on a breaking shape change.",
      +      "type": "string"
      +    },
      +    "tool": {
      +      "description": "Tool that produced this result.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "schema_version",
      +    "tool",
      +    "data",
      +    "meta"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare this as read-only, idempotent, and non-destructive. The description adds meaningful behavioral details beyond these hints: it performs AI-based extraction of summary, sentiment, entities, and risk flags, and it may return cached results. No contradiction with annotations exists.

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

Conciseness5/5

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

Three sentences with no filler. The purpose is front-loaded, followed by the key behavioral details (AI extraction, cache behavior) and parameter sourcing. Every sentence earns its place.

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?

For a single-parameter read-only tool with a rich output schema, the description covers what the tool does, how to obtain the required input, and the main behavioral nuance (caching). Nothing material is missing for correct invocation.

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 100% and the schema already documents the announcement_id parameter. The description adds value by specifying the source of the ID (search_announcements results) and providing a concrete example ('12345'), which helps the agent supply a correctly scoped value.

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?

The description uses a specific verb-resource pair ('Read and analyze a specific NZX announcement') and clearly distinguishes this from the sibling search_announcements tool by focusing on analysis of a single existing announcement. The listed outputs (summary, key figures, sentiment, entities, risk flags) make the tool's purpose unambiguous.

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?

The description explicitly instructs the agent to obtain the announcement_id from search_announcements results, which establishes the intended workflow and dependency. It does not explicitly state when not to use this tool versus the sibling get_* tools, but the guidance is clear enough for selection.

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.