Skip to main content
Glama

metrics_metadata

Look up a metric's type, help text, and unit by name to interpret and validate observability data from a specified backend.

Instructions

Look up metric metadata — type, help text, and unit for a metric name.

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

Input Schema

NameRequiredDescriptionDefault
metricYesMetric name (e.g. http_requests_total)
targetNoNamed backend instance to query (configured: default). Defaults to the primary.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.8.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description carries the full burden; 'look up' implies a read-only retrieval and the field list tells the agent what comes back. It does not disclose behavior for an unknown metric name (error vs empty), whether the result is cached, or any auth/backend constraints for the multiple targets.

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 front-loaded sentence with the verb first and the returned fields after an em-dash; every word carries information and there is no filler or restatement of the title.

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 simple two-parameter read-only lookup with no output schema, the description covers the essential contract (what is returned for a given metric name). Only edge-case behavior for missing metrics is absent, which is a minor gap at this complexity.

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 100%, including the metric name example and the target parameter's default behavior, so the baseline is 3. The description's phrase 'for a metric name' adds nothing beyond the schema and it never mentions the target/backend selection parameter.

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 ('look up') and resource ('metric metadata') and even enumerates the returned fields (type, help text, unit), which clearly separates it from sibling tools like metrics_query that return sample values. It does not name a sibling explicitly, so it falls just short of 5.

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

Usage Guidelines3/5

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

The lookup framing implies the natural use case (discovering a metric's type/unit before querying it), but there is no explicit when-to-use/when-not language and no mention of alternatives such as metrics_query or metrics_label_values. Guidance is inferred rather than stated.

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