Skip to main content
Glama
mcp-server-sigma

mcp-server-sigma

Workbooks List Workbook Agents

workbooks_list_workbook_agents
Read-only

List AI agents defined in a specific workbook (optionally filtering by version tag).

Instructions

List AI agents defined in a specific workbook (optionally filtering by version tag).

Returns Sigma's single response. The spec documents no page-token request parameter for this endpoint, so a nextPageToken in the response cannot be followed.

Input Schema

NameRequiredDescriptionDefault
workbook_idYes
version_tag_nameNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.0.4

TDQS

A3.7/5.0
Behavior4/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 genuinely non-obvious behavior the schema and annotations cannot express: the endpoint returns a single page and any nextPageToken in the response cannot be followed, which prevents a futile pagination loop.

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?

The purpose is front-loaded in the first sentence and the operational caveat follows. The pagination note is slightly verbose ('The spec documents no page-token request parameter for this endpoint') but every sentence carries information the agent needs.

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?

An output schema exists, so return-value explanation is not required, and the one behavioral gotcha an agent must know (unfollowable nextPageToken) is disclosed. Remaining gap is minor: the workbook_id value format and how the two parameters interact are unstated.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/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 carry parameter meaning. It does explain that version_tag_name is an optional version-tag filter, but leaves workbook_id entirely uninterpreted (format, where to obtain it) and does not specify whether version_tag_name is a name or an ID.

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 and resource ('List AI agents defined in a specific workbook') and scopes it to a single workbook. It implicitly separates itself from the org-wide sibling admin_list_org_workbook_agents by naming the workbook scope, but never names that alternative 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 parenthetical '(optionally filtering by version tag)' implies when the optional parameter applies, but there is no explicit when-to-use guidance. Nothing tells the agent to prefer this over admin_list_org_workbook_agents for org-wide listings, or to pair it with workbooks_run_workbook_agent.

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