Skip to main content
Glama
mcp-server-sigma

mcp-server-sigma

Elements List Workbook Elements

elements_list_workbook_elements
Read-only

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

Instructions

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

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Input Schema

NameRequiredDescriptionDefault
workbook_idYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.0.4

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare read-only/non-destructive, so that safety profile is covered. The description adds genuine behavioral context beyond annotations: it auto-follows Sigma's pagination to the last page, aggregates entries across all pages, and always returns nextPage null / hasMore false. This is real disclosure an agent needs to reason about result completeness.

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?

Two sentences, purpose front-loaded, followed by pagination detail. The second sentence is dense and partly restates return keys that an output schema already carries, but the pagination-following behavior justifies most of it.

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, return-value explanation is somewhat redundant, but the description still covers purpose and the key behavioral fact (auto-pagination to the last page). The main gap is not situating it against the workbook-page and columns/controls siblings.

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?

There is one required parameter with 0% schema description coverage, so the burden falls on the description. The single parameter workbook_id is self-evident and the scope sentence implies it, but no explicit statement of what to pass or format is given. Adequate given only one obvious parameter.

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 specific verb and resource ("List all elements... in a workbook") and enumerates element types (tables, charts, controls, etc.), making the operation unambiguous. It does not explicitly differentiate from the close sibling elements_list_workbook_page_elements, but the workbook-wide scope is clear from 'in a workbook'.

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?

No explicit when-to-use or when-not guidance, and the page-level and column/control siblings are not named as alternatives. The word 'all' and the workbook-level scope imply this is the broad listing rather than a page-scoped one, but the agent must infer the choice.

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