Skip to main content
Glama

Preview a building permit alert

preview_permit_alert
Read-onlyIdempotent

What a building permit alert matches now, without running it: matchCount, newSinceLastRun, and maxPerRun (1,000). Does not use credits.

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": {
      "alertId": "<alertId>"
    },
    "name": "preview_permit_alert"
  }
}

Input Schema

NameRequiredDescriptionDefault
alertIdYesThe permit alert's public id ("palr_…"), from list_permit_alerts or create_permit_alert.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already cover the read-only, idempotent, non-destructive profile, yet the description still adds real behavior: the 1,000-result cap via maxPerRun and the fact that no credits are consumed. That cap and cost note are exactly the kind of operational context annotations cannot express.

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?

A single compact sentence with the core behavior front-loaded, followed by the returned fields and the cost caveat. Every clause carries information; nothing is 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?

For a one-parameter read tool with full annotations and no output schema, the description supplies the key return fields (matchCount, newSinceLastRun, maxPerRun) and the credit behavior. Only a hand-off to run_permit_alert for actual execution is 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?

There is a single parameter (alertId) with 100% schema description coverage, including the 'palr_…' id format and where to obtain it. The description adds no meaning beyond the schema, so the baseline 3 applies.

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?

States a specific verb-and-resource: it previews what a building permit alert currently matches, without executing a run. The phrase 'without running it' implicitly distinguishes it from the sibling run_permit_alert, though it never names that sibling explicitly.

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?

'Without running it' plus 'Does not use credits' gives a clear condition for choosing this over actually running the alert. It stops short of naming the alternative tool or stating exclusions (e.g., that it doesn't deliver or persist anything).

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