Describe
describeLists 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
| Name | Required | Description | Default |
|---|---|---|---|
| what | No | What to list; 'instances' by default | instances |
| contains | No | fields: only names containing this text | |
| instance | No | Instance from describe, e.g. 'payment/prod'; the default when omitted | |
| include_disabled | No | streams: also list paused streams | |
| include_internal | No | fields: include Graylog's gl2_* fields |