Skip to main content
Glama
mcp-server-sigma

mcp-server-sigma

Elements Swap Workbook Connections

elements_swap_workbook_connections

Swap a workbook's data connections by mapping existing connection IDs to replacements, with optional table/path swaps and input table data copying.

Instructions

Swap workbook connections (Beta).

OpenAPI: POST /v2/workbooks/{workbookId}/swapConnections (workbooks_swapWorkbookConnections). Spec: https://help.sigmacomputing.com/openapi/sigma-rest-api.json connection_mapping items require fromId and toId; optional swapTables and paths.

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>",
      "connection_mapping": "<connection_mapping>"
    },
    "name": "elements_swap_workbook_connections"
  }
}

Input Schema

NameRequiredDescriptionDefault
workbook_idYes
connection_mappingYes
copy_input_table_dataNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.3.0

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false and openWorldHint=true, so the safety profile is covered externally. The description adds that the operation is beta and shows the connection_mapping item shape, but says nothing about what happens to existing worksheet/table references, whether the swap is reversible, or what permissions are needed.

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

Conciseness3/5

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

Purpose is front-loaded in the first four words, which is good, but the OpenAPI endpoint line, the duplicate operation name in parentheses, and the spec URL consume space with little decision value for an agent. The final sentence carries the real content and is appropriately terse.

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 described, and the critical nested mapping fields are documented. Still, for a mutating tool with zero schema description coverage, the missing explanation of copy_input_table_data and of the effect on existing workbook content leaves a real gap.

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% and connection_mapping is schema'd only as an array of free-form objects, so the description's note that items require fromId and toId with optional swapTables and paths is genuinely load-bearing. However, copy_input_table_data (the only optional top-level parameter) is never explained, and workbook_id's expected identifier form (id vs URL slug) is not clarified.

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?

The description gives a specific verb and resource (swap workbook connections) plus the exact REST endpoint it wraps, so the operation is unambiguous. It does not distinguish itself from close siblings such as elements_swap_workbook_sources or elements_swap_workbook_source_elements, which is the only thing keeping it from a 5.

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?

There is no when-to-use or when-not-to-use guidance and no named alternative among the several swap siblings. The only contextual cue is the '(Beta)' tag and the endpoint path, leaving the agent to infer that this swaps connection references in a workbook rather than sources or elements.

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