Skip to main content
Glama

catalog_describe

Describes a catalog entry in full—schema, freshness, lineage, and sample records—to discover label names before creating a trigger or reading an unfamiliar source.

Instructions

Describe one catalog entry in full: schema (event types + typed fields, inferred from stored events), freshness, lineage, and sample records. Handles look like source:logs or trigger:error_spike. Use this to discover label names before creating a trigger or reading an unfamiliar source.

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": {
      "handle": "<handle>"
    },
    "name": "catalog_describe"
  }
}

Input Schema

NameRequiredDescriptionDefault
handleYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.57.0

TDQS

A4.1/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It does disclose one meaningful behavioral trait — that the schema is 'inferred from stored events' rather than declared — plus the fact that sample records are returned. It never states read-only semantics, behavior on an unknown handle, or cost/latency, which a zero-annotation tool ideally would.

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 short sentences, front-loaded with the payload contents, then the handle format, then the usage cue. Every sentence earns its place; the parenthetical '(event types + typed fields, inferred from stored events)' is slightly dense but informative rather than filler.

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 an output schema present, the description covers purpose, handle syntax, and the discovery workflow, so an agent has enough to call it correctly. Missing only edge-case behavior (invalid handle, missing entry) and confirmation that the call is side-effect free.

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 description coverage is 0% and the single 'handle' parameter is undocumented structurally, so the description must compensate — and it does by giving the expected format with two concrete examples ('source:logs', 'trigger:error_spike'). That is real meaning beyond the schema, though it does not say whether handles are case-sensitive or how to obtain one.

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 and resource ('Describe one catalog entry in full') and enumerates exactly what comes back: schema with event types and typed fields, freshness, lineage, sample records. An agent can tell this apart from catalog_list (listing) without opening either 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?

Gives a concrete when-to-use: 'discover label names before creating a trigger or reading an unfamiliar source.' That ties the tool to named downstream actions. No explicit when-not or a direct pointer to catalog_list for enumeration, so it stops short of the top band.

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