Skip to main content
Glama
mcp-server-sigma

mcp-server-sigma

Elements Swap Workbook Source Elements

elements_swap_workbook_source_elements

Swap workbook source elements by mapping each from element to a replacement, with optional metric and column mappings to keep dependent references aligned.

Instructions

Swap workbook source elements (Beta).

OpenAPI: POST /v2/workbooks/{workbookId}/swapSourceElements (workbooks_swapWorkbookSourceElements). Spec: https://help.sigmacomputing.com/openapi/sigma-rest-api.json source_mapping items require from and to; optional metricMapping and columnMapping.

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>",
      "source_mapping": "<source_mapping>"
    },
    "name": "elements_swap_workbook_source_elements"
  }
}

Input Schema

NameRequiredDescriptionDefault
workbook_idYes
source_mappingYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.3.0

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, openWorldHint=true, and destructiveHint=false, so safety is partly covered. The description adds genuinely new information the annotations cannot: beta status, the underlying POST endpoint, and the internal shape of source_mapping entries (required 'from'/'to', optional 'metricMapping'/'columnMapping'). It still does not say what happens to the original elements after the swap or whether the operation is reversible.

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?

Short and front-loaded: purpose first, then endpoint, then the payload detail that actually matters. The OpenAPI operation-id and raw spec URL are somewhat redundant filler, but they occupy one line and do not obscure the important content.

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 no explanation, and the description covers the shape of the nested payload. However, for a non-trivial mutation it says nothing about what a 'swap' semantically does to existing workbook elements, what metricMapping/columnMapping values look like, or any permission requirements beyond openWorldHint.

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

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage and source_mapping typed only as a free-form object array, the schema provides no param meaning at all. The description compensates by naming the required keys ('from', 'to') and the optional keys ('metricMapping', 'columnMapping') inside each mapping item, which is the critical detail for invoking correctly. It leaves workbook_id unexplained, though the endpoint path makes its meaning apparent.

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 ('Swap workbook source elements') plus the exact REST endpoint, so the operation is unambiguous. It does not distinguish itself from close siblings such as elements_swap_workbook_sources, elements_swap_workbook_connections, or elements_swap_template_sources, leaving the agent to guess which swap variant applies.

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 guidance on when this tool should be chosen over the numerous sibling swap tools, and no stated preconditions (e.g. whether a source swap policy must exist first). The '(Beta)' tag is the only contextual hint, and it does not help tool selection.

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