Skip to main content
Glama
christianclaudio

mcp-server-sigma

Workbooks List Workbook Schedules

workbooks_list_workbook_schedules
Read-only

List all scheduled exports for a given workbook using its ID to monitor and manage automated report delivery schedules.

Instructions

List scheduled exports 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

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description adds only the clarification that 'schedules' means 'scheduled exports', with no pagination, ordering, or permission context beyond that.

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 zero filler; the resource and scope come first. It is efficient, though arguably too terse for the information an agent needs.

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 needn't be explained, and annotations cover the read-only safety profile. What remains missing is how to supply workbook_id and how this differs from workbooks_list_report_schedules, leaving the definition only minimally adequate.

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 parameter workbook_id is undocumented in the schema. The description only implies workbook scoping ('for a workbook') and gives no hint on ID format or where to obtain it, so it fails to 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?

Clear specific verb+resource: 'List scheduled exports for a workbook.' An agent can identify the operation, and the sibling names (add/delete_workbook_schedule) make the read variant distinct. It stops short of explicitly contrasting itself with workbooks_list_report_schedules or the sibling schedule mutators.

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 named alternatives. The agent must infer that this is the read counterpart to add_workbook_schedule/delete_workbook_schedule and that report-level schedules are covered by a different tool.

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