Skip to main content
Glama

Describe

describe
Read-onlyIdempotent

Lists Graylog instances, streams, fields, presets, and scan rules so you can inspect available data and pick field names before writing queries on unfamiliar logs.

Instructions

What is there to query. 'instances': configured Graylog instances with detected version, the API in use and active redaction rules. 'streams': streams (id, title, description) the token can read. 'fields': field names (and types where available), plus the configured trace fields and error query; use before writing queries on unfamiliar logs. 'presets': named queries from the configuration. 'scan_rules': scan rules with their query, condition, severity and tags.

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": "describe"
  }
}

Input Schema

NameRequiredDescriptionDefault
whatNoWhat to list; 'instances' by defaultinstances
containsNofields: only names containing this text
instanceNoInstance from describe, e.g. 'payment/prod'; the default when omitted
include_disabledNostreams: also list paused streams
include_internalNofields: include Graylog's gl2_* fields

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.3.1

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, non-destructive, so the bar is lower, and the description still adds value: streams are scoped to what 'the token can read' (an auth/visibility constraint) and instances carry detected version, API in use, and active redaction rules. It stops short of stating pagination, caching, or failure behavior.

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?

Front-loaded with the core question, then a compact per-value inventory with no filler sentences. The semicolon-chained list is dense but scannable; nothing is redundant with the schema beyond the enum labels themselves.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description carries the return-shape burden and discharges it by listing the fields each resource kind yields, which is exactly what an agent needs to decide whether to call it before constructing a query. Nothing material is missing for a five-optional-parameter discovery tool.

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 coverage is 100%, so the baseline is 3, but the description goes beyond the terse enum descriptions by spelling out the payload of each value, e.g. scan_rules returns 'query, condition, severity and tags' and fields include types plus trace fields and the error query. It does not, however, tie the contains/include_disabled/include_internal parameters to their respective 'what' values as explicitly as the schema does.

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 opening 'What is there to query' frames this as a discovery tool, and the five enumerated resource kinds (instances, streams, fields, presets, scan_rules) make its scope concrete. The verb is implicit rather than a clean verb+resource pair, and it never names a sibling, so an agent must infer that this is the metadata companion to search_logs/aggregate.

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?

Only one value gets real when-to-use guidance: 'fields' says to use it 'before writing queries on unfamiliar logs.' The other four values describe contents but not when to prefer this tool over search_logs or run_preset, and there are no exclusions or prerequisites stated.

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