Skip to main content
Glama
christianclaudio

mcp-server-sigma

Workbooks Get Report

workbooks_get_report
Read-only

Retrieve metadata from a Sigma report using its report ID to view key details, properties, and schema information.

Instructions

Get report metadata.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
report_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.0.4

TDQS

C2.4/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered externally. The description adds no behavioral context of its own – nothing about what "metadata" includes, authorization needs, or limits – so it contributes essentially nothing beyond the structured fields.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The single sentence is front-loaded and free of waste, but its brevity reflects under-specification rather than efficient communication. It is terse without being informative.

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

Completeness2/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 need not be described. Still, for a tool sitting amid dozens of report/workbook siblings, the definition leaves the agent without enough context on scope, ID expectations, or relationship to workbooks_list_reports to invoke it confidently.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% and the single parameter report_id is undocumented in both the schema and the description. The description does not state the expected ID format or where to obtain a valid report_id, so it fails to compensate for the coverage gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Get report metadata" gives a verb (get) and resource (report metadata), so the basic action is clear. However, "metadata" is vague and the description does nothing to distinguish this tool from siblings such as workbooks_list_reports, workbooks_list_report_elements, or workbooks_get_workbook, which an agent must choose between.

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?

The description offers no when-to-use guidance, no prerequisites, and no mention of alternatives among the many report-related siblings. The agent must infer that this is the single-report counterpart to workbooks_list_reports entirely on its own.

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

Deploy Server

Other Tools