Skip to main content
Glama
christianclaudio

mcp-server-sigma

Workbooks Get Workbook

workbooks_get_workbook
Read-only

Fetch metadata for a Sigma workbook using its workbook ID to inspect properties, settings, and ownership details.

Instructions

Get workbook metadata.

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

C2.4/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds no behavioral context beyond that — no note on permissions, scoping, or what "metadata" excludes (contents, pages, tags).

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?

A single grammatical sentence with no wasted words, front-loaded with the verb and resource. It is efficient, though its brevity shades into under-specification rather than true conciseness.

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. But for a tool with an undocumented parameter and no usage or scoping guidance, the description is too thin to let an agent call it confidently against 40+ workbooks siblings.

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 required parameter workbook_id is undocumented in both the schema and the description. The parameter name is largely self-explanatory, but the description does nothing 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?

The description states a specific verb ("Get") and resource ("workbook metadata"), so the basic purpose is clear. However, "metadata" is left undefined, and with siblings like workbooks_get_workbook_version_history, workbooks_get_workbook_tags, and workbooks_list_workbooks, the description does nothing to distinguish what this call returns versus those.

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?

There is no when-to-use guidance, no statement of prerequisites, and no mention of any alternative tool. An agent must infer from the name alone whether this or workbooks_list_workbooks is the right call.

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