Skip to main content
Glama
mcp-server-sigma

mcp-server-sigma

Workbooks List Workbook Lineage

workbooks_list_workbook_lineage
Read-only

List data lineage for a workbook.

Instructions

List data lineage for a workbook.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workbook_id": "<workbook_id>"
    },
    "name": "workbooks_list_workbook_lineage"
  }
}

Input Schema

NameRequiredDescriptionDefault
workbook_idYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.0.4

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, openWorldHint, and destructiveHint, so the safety profile is covered. The description adds meaningful behavior beyond that: it auto-paginates to the last page, aggregates entries from every page, returns total when Sigma sends it, and reports nextPage as null / hasMore false after reading all pages.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core purpose and then spends its remaining space on the non-obvious pagination behavior. It is appropriately sized and contains no filler.

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?

The tool is simple, annotations cover the safety profile, and an output schema exists, so return values need not be fully explained. However, the description still leaves the workbook_id semantics and the choice between lineage siblings unaddressed, making it adequate but not complete.

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 required workbook_id parameter. The description says 'for a workbook' but does not explain the parameter's format, source, or whether it is a workbook UUID; it does not compensate for the missing schema documentation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first sentence states a specific verb and resource: 'List data lineage for a workbook.' It also distinguishes this tool from sibling lineage tools such as workbooks_list_report_lineage and datasets_list_data_model_lineage by explicitly scoping the resource to a 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?

The description gives no when-to-use guidance, no exclusions, and no alternatives. With many lineage-related siblings listed, the agent is left to infer that this is the workbook-specific lineage tool rather than being routed to it explicitly.

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