Skip to main content
Glama
christianclaudio

mcp-server-sigma

Workbooks Verify Workbook Spec

workbooks_verify_workbook_spec
Read-only

Validate a workbook code specification without saving it. Checks schema structure, syntax, and element layout to catch errors before deployment.

Instructions

Verify a workbook code representation specification without saving.

Validates schema structure, syntax, and element layout.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
documentYes
folder_idYes
descriptionNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.0.4

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the non-mutating profile is covered. The description reinforces this with "without saving" and adds the concrete validation targets (schema, syntax, element layout), but says nothing about failure behavior or what a failed spec looks like.

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 tight sentences with the dry-run qualifier and validation scope front-loaded; no filler. Brevity is a virtue here, though the second sentence is doing all the substantive work while the parameter gaps remain.

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?

An output schema exists, so return values need not be explained, and annotations cover the safety profile. However, with 0% parameter coverage and a nested document object, an agent still lacks what each input should contain, which is the main incompleteness.

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% across four parameters, including a nested 'document' object, yet the description gives no parameter-level meaning. The phrase "code representation specification" loosely hints that 'document' carries the spec, but name, folder_id, and description are entirely unexplained and the description does not compensate for the coverage gap.

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?

Specific verb (verify) plus resource (workbook code representation specification) with an explicit dry-run qualifier ("without saving") and the validation scope (schema structure, syntax, element layout). It is distinguishable from the parallel workbooks_verify_report_spec, but it never names or contrasts that sibling explicitly.

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?

The phrase "without saving" implies a dry-run preflight before create/update, which is useful implicit guidance, but there is no explicit when-to-use statement, no prerequisites, and no mention of the sibling workbooks_verify_report_spec or when to prefer it over workbooks_create_workbook.

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