Skip to main content
Glama
mcp-server-sigma

mcp-server-sigma

Workbooks List Workbook Bookmarks

workbooks_list_workbook_bookmarks
Read-only

List bookmarks (saved filter states) in a workbook.

Instructions

List bookmarks (saved filter states) 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

A4.1/5.0
Behavior5/5

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

The annotations already establish this as a non-destructive read-only operation. The description adds meaningful behavioral detail beyond annotations: it follows Sigma pagination to the last page and explains the returned page fields, including that nextPage is null and hasMore is false because all pages are read.

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?

The description is appropriately sized and front-loaded with the primary purpose. The second sentence spends its length on useful pagination and return-shape behavior rather than restating schema or annotations.

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?

For a simple, single-parameter read-only list tool with annotations and an output schema, the description is largely complete, especially around pagination and returned fields. The main gap is that workbook_id is not described, but the tool's overall behavior is otherwise well covered.

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%, so the description must compensate for parameter meaning. It does not explain the required workbook_id beyond implying it identifies a workbook; it gives no format, source, or other guidance for the sole parameter.

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?

The description states a specific verb and resource: 'List bookmarks (saved filter states) in a workbook.' The parenthetical clarifies what bookmarks are, and the resource is distinct from sibling operations such as add, update, and delete bookmark.

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 implied by 'List bookmarks' in the context of bookmark-related siblings, but the description does not explicitly state when to use this tool versus alternatives or when not to use it. It lacks broader context about prerequisites or selection criteria.

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