Skip to main content
Glama
christianclaudio

mcp-server-sigma

Workbooks List Workbook Embeds

workbooks_list_workbook_embeds
Read-only

Retrieve embed configurations for a specific workbook to audit or manage its embedded analytics content.

Instructions

List embed configurations for 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

C2.8/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, openWorldHint=true and destructiveHint=false, so the safety profile is covered structurally. The description adds no behavioral context of its own — no note on pagination, whether embedding must be enabled, or any authorization requirement for reading embed configs.

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 front-loaded sentence with no filler; the verb and resource land immediately. Its brevity is efficient, though it edges toward under-specification rather than genuine conciseness.

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?

For a simple read tool with an output schema and annotations covering safety, the description is minimally viable. It omits any routing guidance relative to workbooks_create_workbook_embed, which is the main completeness gap given the large sibling set.

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 schema supplies no semantics. The description does not compensate by stating the expected identifier format (ID vs. name/path) or whether embeds are scoped to a workbook or an individual page.

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 (list) and resource (embed configurations) scoped to a workbook, which distinguishes it from the write-side sibling workbooks_create_workbook_embed. It does not, however, explicitly contrast itself with any sibling or note that it is scoped per workbook.

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?

No when-to-use guidance, no prerequisites, and no mention of alternatives such as workbooks_create_workbook_embed for creating embeds or workbooks_get_workbook for workbook-level metadata. The agent must infer the usage context entirely from the name.

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