Skip to main content
Glama
christianclaudio

mcp-server-sigma

Elements List Workbook Elements

elements_list_workbook_elements
Read-only

List all tables, charts, controls, and other elements in a Sigma workbook by providing its workbook ID.

Instructions

List all elements (tables, charts, controls, etc.) in a workbook.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workbook_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.0.4

TDQS

B3.1/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. Beyond that the description adds essentially nothing behavioral: no pagination/result-size notes, no auth or permission requirements. The only added value is the parenthetical list of element kinds, which is minimal.

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?

A single front-loaded sentence with no filler or redundancy. Every word contributes to defining the operation and its scope.

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

Completeness3/5

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

The tool is simple and an output schema exists, so return-value detail is rightly absent. However, for a tool with many near-duplicate siblings, the description omits how results are scoped/paginated and offers no parameter guidance, leaving the agent with a merely adequate picture.

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% for the single workbook_id parameter, so the description must compensate and does not. It never clarifies whether the value is an ID vs name, its format, or where to obtain it; only the phrase 'in a workbook' loosely implies what the parameter identifies.

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?

States a clear verb and resource ('List all elements ... in a workbook') and enumerates example element types, so the agent understands the scope is the full element inventory rather than one category. It does not, however, name or contrast with the many sibling list tools (e.g., elements_list_workbook_controls, elements_list_workbook_page_elements), leaving differentiation to be inferred from 'all'.

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?

Usage is only implied: the word 'all' hints this is the broad inventory call versus the type-scoped siblings (controls, queries, columns) or the page-scoped variant. There is no explicit when-to-use statement, no prerequisites, and no named alternative for narrower listings.

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