Skip to main content
Glama

describe_metric

Read-onlyIdempotent

Show a metric's definition, source view, time column, and enforced row policy to inspect governed metrics without writing SQL.

Instructions

Show a metric's definition, source view, time column, and the row policy in force.

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

Input Schema

NameRequiredDescriptionDefault
nameYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

The annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and a closed world, so safety behavior is fully covered. The description adds value by naming the returned facets (definition, source view, time column, row policy), but says nothing about error behavior for an unknown metric. With annotations carrying the safety profile, a 3 is appropriate.

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?

One short sentence that front-loads the action and enumerates the returned information with no filler. Nothing is wasted and nothing essential is omitted.

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?

An output schema exists, so the return shape needn't be spelled out, and the annotations cover the safety profile. For a simple single-parameter read tool the description is essentially complete, with only not-found handling left unstated.

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 0% for the single required 'name' parameter, but the tool is named describe_metric and the description speaks of 'a metric's definition', so the parameter's intent is readily inferable. The description adds no explicit syntax or format detail, but the gap is small for a one-parameter tool.

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 verb 'Show' plus the resource 'a metric's definition, source view, time column, and the row policy' is specific and concrete about what the agent gets back. It does not, however, draw any boundary against close siblings like explain_metric_query or list_metrics, so an agent must infer the distinction.

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

Usage Guidelines2/5

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

There is no when-to-use statement, no prerequisites, and no named alternative. Given the sibling explain_metric_query exists and the two could plausibly overlap, the absence of any routing guidance is a real gap, leaving usage only loosely implied by the name.

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