Skip to main content
Glama

Describe Data View

describe_data_view
Read-only

Retrieve a Kibana data view's field names and types before creating visualizations, ensuring you reference real fields. Optionally target a specific space by id.

Instructions

Get a data view's fields and types. Call this before creating a visualization so you use real field names.

space targets a Kibana space by id (default: the default space).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
spaceNo
data_viewYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds workflow context (a read-only pre-flight check before visualization creation), but says nothing about auth requirements, failure behavior for unknown data views, or result size.

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?

Two sentences, zero waste, with the core purpose front-loaded and the workflow hint and parameter note following economically.

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 return values needn't be described, and annotations cover the read-only nature. The remaining gap is the undocumented `data_view` parameter; otherwise adequate for a simple two-param read tool.

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%, so the description must carry parameter meaning. It explains `space` well (Kibana space by id, default space), but never explains `data_view` beyond the tool's overall purpose, leaving one of two parameters implicit.

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?

Specific verb+resource: 'Get a data view's fields and types.' An agent can immediately tell this apart from list_data_views and create_data_view without opening any 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?

Explicitly states when to call it: 'Call this before creating a visualization so you use real field names.' This ties it to the create_visualization sibling workflow. No exclusions or alternative-name routing (e.g., vs list_data_views), so it stops short of a 5.

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