Skip to main content
Glama

NZXplorer (Remote)

get_keyword_alerts

Read-onlyIdempotent

Get the authenticated user's keyword alerts and recent matches. Returns alert configurations and announcements that matched their keywords. Use when asked about their alerts, keyword notifications, or what announcements matched their keywords.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_keyword_alerts"
  }
}

Input Schema

NameRequiredDescriptionDefault
include_matchesNoInclude recent alert matches (default false)

Output 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
    • changedOutput schema / properties / meta / properties / provenance / description
      Previous value: -"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."New value: +"Whether the figures can cite a source document. \"direct\": every returned row carries its own document URL (see meta.sources). \"reachable\": some do, or the documents sit beside figures that are not rows. \"undeclared\": no document URL was found in this payload — it is not a claim that the data is unsourced."
    • addedOutput schema / properties / meta / properties / sources
      Added value: +{
      +  "description": "Primary documents (NZX announcements, annual reports) whose URLs appear in this payload. Cite these with their date when you quote a figure. A listed document was returned with the data; it is not proof that a given sentence of your answer came from it.",
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "date": {
      +        "description": "YYYY-MM-DD, or null when the row has no date.",
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "kind": {
      +        "enum": [
      +          "announcement",
      +          "annual_report",
      +          "document"
      +        ],
      +        "type": "string"
      +      },
      +      "title": {
      +        "type": "string"
      +      },
      +      "url": {
      +        "format": "uri",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "url",
      +      "title",
      +      "date",
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
  2. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive, and closed-world, so the safety profile is covered structurally. The description adds useful scope information by stating the data belongs to the authenticated user (no user parameter, no cross-account access) and that matches are recent. Beyond that it offers no pagination, limits, or authentication detail, so the added value is moderate.

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?

Three tight sentences with the core behavior front-loaded and no filler. The middle sentence slightly restates the first by re-describing the return content, but it is brief and informative rather than redundant padding.

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?

This is a simple single-optional-boolean read tool with an output schema, so return shapes need not be spelled out. The description covers ownership scope, return content, and when to call it — enough for an agent to invoke correctly, with only minor gaps around result size or recency window.

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?

There is a single parameter with 100% schema description coverage, including its default of false, so the schema carries the semantics. The description's phrase 'and recent matches' hints that matches may be included but never names include_matches or explains the difference in output when it is false, so it adds little beyond the schema.

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 the authenticated user's keyword alerts') and adds what is returned ('alert configurations and announcements that matched their keywords'). It is clear what the tool does, though it does not explicitly contrast with nearby tools like get_announcement_alerts.

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 final sentence gives concrete trigger phrasing: 'Use when asked about their alerts, keyword notifications, or what announcements matched their keywords.' That is clear when-to-use guidance, but there are no when-not conditions or named alternatives.

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.

Resources