Skip to main content
Glama
mcp-server-sigma

mcp-server-sigma

Workbooks List Report Elements

workbooks_list_report_elements
Read-only

List elements in a report.

Instructions

List elements in a report.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

Input Schema

NameRequiredDescriptionDefault
report_idYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.0.4

TDQS

B3.3/5.0
Behavior4/5

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

Annotations already establish read-only, non-destructive, open-world behavior. The description adds meaningful behavioral detail by explaining that it auto-paginates through every page and returns aggregated entries with nextPageToken null.

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?

The description is short and front-loads the core purpose, then explains pagination behavior. The pagination sentence is useful, though slightly verbose and technical with reference to Sigma page keys.

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?

With an output schema present, the description need not document return shape in detail, and annotations cover the safety profile. It is complete enough for a simple one-parameter list call, though it could clarify report_id sourcing and sibling distinction.

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?

The single parameter report_id has 0% schema description coverage, and the description does not explain what the identifier is or where it comes from. The parameter name is self-explanatory, but the description adds no semantic information beyond the schema.

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 description states a specific verb and resource: list elements in a report. It is clear what the tool does, though it does not differentiate itself from nearby siblings such as workbooks_list_report_pages or workbooks_list_report_page_elements.

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 does not explain when to use this tool versus alternatives, nor does it state prerequisites such as needing a report_id from another call. Usage is only implied by the tool name and purpose.

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