io.github.christianclaudioPublished by GitHub account christianclaudiov2.2.0Updated Oct 30, 2026
MCP server for Sigma Computing. Provision dashboards, build models, and automate cloud analytics.
Local MCP server for Sigma Computing that lets an assistant read and change workbooks, data models, workspaces and org admin settings through the Sigma API.
Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.
Follow the launch instructions in the repository.
[CI] [PyPI] [Python] [License: Apache-2.0] [Coverage] [CodeRabbit Reviews]
Supercharge your AI Agents with native Sigma Computing superpowers! ⚡
An enterprise-grade Model Context Protocol (MCP) server with 263 tools covering connections, workbooks, data models, members, teams, deployments, webhooks, multi-tenant operations, and composite workflow recipes straight to your favorite AI assistant.
[!IMPORTANT] Community Project Disclaimer
mcp-server-sigmais an independent open-source community project. It is not affiliated with, sponsored by, endorsed by, or supported by Sigma Computing, Inc. "Sigma Computing" is a trademark of Sigma Computing, Inc.
[!WARNING] Credentials & Safety Notice
This server uses API credentials scoped to your Sigma organization. Tools can mutate workbooks, users, teams, and data models.
- Read-Only Mode: To run safely without mutation risk, set
SIGMA_MCP_READONLY=1or--profile readonly(lists the 120 tools annotatedreadOnlyHint=trueand refuses every other call).- Destructive Safety Gates: All single-delete tools require explicit
confirm=True; without it they change nothing and return a normal result (isError: false) asking the caller to re-call withconfirm=true. Missing or invalid arguments return a tool error (isError: true) the model can correct, and so do other failed calls such as a member not found, an export that times out, or a rejected bulk-deactivate pattern (see docs/errors.md). A batch tool whose every item failed returnsisError: truewith"type": "batch_failed"; a partial success stays a normal result with"status": "partial_success", a<verb>_count,failed_count,resultsanderrors, where each entry hasid,statusandresultorerror, alongside the field names each tool returned before; failed items that earlier releases listed inresultsare still there too (see docs/errors.md). Bulk destructive operations (admin_bulk_deactivate_members,admin_bulk_remove_team_members) are listed infullbut refused at call time unlessSIGMA_MCP_ALLOW_BULK_DESTRUCTIVE=1.- Read SECURITY.md before deploying to production.
Sigma Computing has a unique architectural asymmetry that shapes how you automate it:
/v2/workbooks/spec), programmatically constructing layout elements from scratch remains highly complex.The canonical path to automated BI dashboards is:
Build the layout once in the Sigma UI, save it as a template, then instantiate and source-swap it programmatically forever after! 🎨 ➡️ 🤖
Our composite recipe tools (like workbooks_deploy_template_to_folder and elements_swap_workbook_sources) automate this exact pattern in a single MCP tool call (returning structured step progress or partial failure details if an intermediate step fails):
pip or uvThe image's default command is stdio. To serve Streamable HTTP from the container, bind 0.0.0.0 inside it and pass a token. Keep the token off the command line (it shows up in shell history and ps): put SIGMA_MCP_AUTH_TOKEN in .env, or export it and pass the name alone with -e:
[!TIP] Use the API base URL assigned to your organization's region.
mcp-server-sigma works seamlessly with all major AI assistants, IDEs, and CLI tools via standard stdio or streamable-http.
Add to ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):
For Claude Code CLI:
Add to your project's .agents/mcp_config.json (or global ~/.gemini/config/mcp_config.json):
Run in network transport mode (Streamable HTTP) for local CLI & agent extensions:
Point your local Codex / Streamable HTTP client to http://127.0.0.1:8000/mcp. When SIGMA_MCP_AUTH_TOKEN is set, the client must send Authorization: Bearer <token>; requests without it, or with a different token, get HTTP 401.
HTTP transports follow the MCP guidance that a local server binds to localhost, and require a bearer token whenever the server is reachable beyond it:
127.0.0.1, ::1 or localhost (the --host default is 127.0.0.1), HTTP runs with or without SIGMA_MCP_AUTH_TOKEN; without it, a warning says requests are not authenticated.0.0.0.0, ::, a LAN address), the server refuses to start (exit code 2) unless SIGMA_MCP_AUTH_TOKEN is set, or SIGMA_MCP_ALLOW_UNAUTHENTICATED_BIND=1 accepts an unauthenticated bind (logged as a warning), for example behind a gateway that authenticates for you.fastmcp run src/sigma_mcp/server.py:mcp --transport http and an ASGI host mounting mcp.http_app() enforce it too. Those entry points do not know the bind host, so they cannot refuse a public bind; use sigma-mcp for that policy.session_idle_timeout (on http_app()) or FASTMCP_HTTP_SESSION_IDLE_TIMEOUT (seconds, or none to never expire); see the FastMCP 4.1.0 release and #5229.Note for hosted ChatGPT Actions or Custom GPTs: Hosted cloud services cannot reach localhost. Place an authenticating HTTPS proxy (e.g., ngrok, Cloudflare Tunnel, or Caddy with TLS and Auth) in front of the server before connecting cloud services.
cline_mcp_settings.json):~/.continue/config.yaml):Add to ~/.cursor/mcp.json:
Add .github/mcp.json to your repository:
Note for Copilot Cloud Agents: Cloud code-review integrations must be configured through Repository Settings > Copilot > MCP servers instead.
Add directly via the Cortex CLI:
Configure behavior using environment variables:
Pick a profile with --profile or SIGMA_MCP_PROFILE (default full). Every profile mounts all five domains (workbooks, datasets, elements, workspace, admin). Job profiles then expose only an explicit list of tool names for one job; prompts and resources stay available on every profile. Each listed name is checked against the full catalog when the server builds, so an unknown profile or a typo in a list fails at startup with ValueError.
Twenty-two tools are in no job profile and are reachable only in full: workspace_delete_file, workspace_update_file, workspace_create_tag, workspace_delete_tag, admin_list_translations, admin_bulk_deactivate_members, admin_bulk_remove_team_members, admin_api_capabilities, admin_list_recent_webhooks, workspace_update_tag, admin_list_api_credentials, admin_get_api_credential, admin_create_api_credential, admin_update_api_credential, admin_delete_api_credential, admin_get_translation, admin_get_translation_variant, admin_create_translation, admin_update_translation, admin_update_translation_variant, admin_delete_translation, and admin_delete_translation_variant.
readOnlyHint annotation is the only thing that decides whether a tool is read-only. Every tool declares it explicitly: true on the 120 reads and false on the 143 writes. A tool with no annotation or no readOnlyHint counts as a write.--profile readonly or SIGMA_MCP_READONLY=1 (on any profile) lists only the read-only tools, and ReadOnlyGateMiddleware refuses any call to a real tool that is not read-only, including a write the filter hid. A refusal comes back as a tool result with isError: true.Unknown tool error, directly or through call_tool, so a typo is never reported as a blocked tool.call_tool wraps. Reads through call_tool work and writes are refused. Without Tool Search, call_tool is not a tool on the server, so a call to it gets Unknown tool: 'call_tool'.admin_bulk_deactivate_members and admin_bulk_remove_team_members are listed in full. The admin domain guard refuses them at call time (isError: true) unless SIGMA_MCP_ALLOW_BULK_DESTRUCTIVE=1, and the handlers keep their own confirm / dry_run safeguards. Read-only mode hides and refuses them.
tools/list is flat by default. Discovery is opt-in and attaches only on full:
--enable-tool-search / SIGMA_MCP_ENABLE_TOOL_SEARCH=1 replaces tools/list with search_tools and call_tool. The backend is regex (default) or bm25 (--tool-search-backend / SIGMA_MCP_TOOL_SEARCH_BACKEND).--enable-code-mode / SIGMA_MCP_ENABLE_CODE_MODE=1 attaches FastMCP's experimental Code Mode (search, get_schema, execute). Code Mode needs the sandbox from the package's code-mode extra (fastmcp[code-mode], which ships pydantic-monty): pip install "mcp-server-sigma[code-mode]" or uvx "mcp-server-sigma[code-mode]" --enable-code-mode. Without it, Code Mode is skipped with a warning and the flat catalog is served.ValueError. Asking for either on another profile logs a warning and keeps the flat list.search_tools, search and get_schema only read the catalog and are annotated readOnlyHint=true. Under read-only, Code Mode execute is refused.The full profile lists 263 tools. Every tool name starts with the domain it is mounted under:
scripts/check_tool_contract.py fails CI if these counts drift from the live registry. The 2 bulk-destructive tools (admin_bulk_deactivate_members, admin_bulk_remove_team_members) are in the admin count and are refused at call time unless SIGMA_MCP_ALLOW_BULK_DESTRUCTIVE=1.
These high-level tools bundle multi-step API sequences into a single atomic call:
Every tool includes structured MCP hints to assist AI clients with user permission prompts:
AI models frequently hallucinate SQL or Excel functions when writing Sigma formulas (e.g. using ArrayAgg() instead of List()).
Before writing any Sigma formula, call the built-in reference tool:
See docs/formulas.md for full syntax details.
[!NOTE] Automated Drift Checks: The CI workflow (
ci.yml) has acheck-driftjob, run weekly on Sunday afternoon Eastern time and on manual dispatch, that compares client methods against the live Sigma OpenAPI specification. If the drift scan runs on main and finds drift or exits with an error, the job automatically opens an issue in the repository. A failure in an earlier setup step fails the run without opening an issue.
Contributions are welcome! Please read CONTRIBUTING.md for development rules, SECURITY.md for security reporting, and CODE_OF_CONDUCT.md for community standards.
MIT License.
Copyright (c) 2026 Christian Claudio.
Disclaimer: Not affiliated with, sponsored by, or endorsed by Sigma Computing, Inc.
Source: README.md at commit 9745f9c
Workbooks List Workbooks
List all workbooks in the organization. Pass summary_only=True for concise token-efficient response. 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. ``limit`` is the page size.
limitsummary_onlyWorkbooks Get Workbook
Get workbook metadata.
workbook_idrequiredWorkbooks Create Workbook
Create an empty workbook in a folder.
namerequiredfolder_idrequireddescriptionWorkbooks Duplicate Workbook
Duplicate an existing workbook. workbook_id: ID of the workbook to clone. name: Name for the new cloned workbook (required by the API). destination_folder_id: ID of the destination folder. If omitted, clones into the same folder as the original.
namerequiredworkbook_idrequireddestination_folder_idWorkbooks List Workbook Pages
List pages in 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.
workbook_idrequiredWorkbooks List Workbook Lineage
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.
workbook_idrequiredWorkbooks Get Workbook Version History
Get version history 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.
workbook_idrequiredWorkbooks Restore Workbook Version
Restore a workbook to a previous version.
versionrequiredworkbook_idrequiredWorkbooks Convert Workbook To Report
Convert a workbook to a report (one-way, creates a new report). workbook_id: ID of the workbook to convert. name: Name for the new report (required by the API). destination_folder_id: Optional folder ID for the report; defaults to My Documents.
namerequiredworkbook_idrequireddestination_folder_idWorkbooks List Workbook Grants
List permission grants on 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.
workbook_idrequiredWorkbooks Grant Workbook Access
Grant access to a workbook. grant_type: 'member' or 'team'. permission: 'view', 'explore', 'edit'.
grant_typerequiredgrantee_idrequiredpermissionrequiredworkbook_idrequiredWorkbooks List Workbook Embeds
List embed configurations 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.
workbook_idrequiredWorkbooks Create Workbook Embed
Create an embed for a workbook. embed_type: Visibility of the embed. Only 'public' is currently supported. source_type: Scope of the embed — 'workbook' (entire workbook), 'page', or 'element'. source_id: Required when source_type is 'page' or 'element'.
source_idembed_typesource_typeworkbook_idrequiredWorkbooks Export Workbook
Export a workbook element. If element_id is empty, exports the first page. format: 'pdf', 'png', 'csv', 'xlsx', 'json', 'jsonl'. layout: 'portrait' or 'landscape' (only for pdf/png). element_id: The specific element to export. If omitted, uses the first page element.
formatlayoutelement_idworkbook_idrequiredWorkbooks List Workbook Schedules
List every scheduled export 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.
workbook_idrequiredWorkbooks Add Workbook Schedule
Create a scheduled export for a workbook. See Sigma docs for schedule body schema.
bodyrequiredworkbook_idrequiredWorkbooks Delete Workbook Schedule
Delete a scheduled export. Requires confirm=True.
confirmschedule_idrequiredworkbook_idrequiredWorkbooks List Workbook Bookmarks
List bookmarks (saved filter states) in 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.
workbook_idrequiredWorkbooks Add Workbook Bookmark
Add a bookmark to a workbook.
bodyrequiredworkbook_idrequiredWorkbooks Get Workbook Tags
List tags on 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.
workbook_idrequiredWorkbooks Tag Workbook
Apply a version tag to a workbook by tag NAME (e.g. 'Production'). The Sigma API takes the tag name here, not its ID.
tag_namerequiredworkbook_idrequiredWorkbooks Remove Workbook Tag
Remove a tag from a workbook. Requires confirm=True.
tag_idrequiredconfirmworkbook_idrequiredWorkbooks List Templates
List all templates in the organization. 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. ``limit`` is the page size.
limitWorkbooks Get Template
Get template details.
template_idrequiredWorkbooks Create Workbook From Template
Create a workbook from a template. This brings real visuals — the only programmatic way to get charts/tables.
namefolder_idrequiredtemplate_idrequiredWorkbooks Save Template From Workbook
Save a workbook as a reusable template.
namefolder_idrequiredworkbook_idrequiredWorkbooks List Reports
List all reports in the organization. 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. ``limit`` is the page size.
limitWorkbooks Get Report
Get report metadata.
report_idrequiredWorkbooks Create Report
Create a report.
bodyrequiredWorkbooks Duplicate Report
Duplicate a report. report_id: ID of the report to clone. name: Name for the new cloned report (required by the API). destination_folder_id: ID of the destination folder to clone into (required by the API).
namerequiredreport_idrequireddestination_folder_idrequiredWorkbooks List Report Sources
List data sources used by a report.
report_idrequiredWorkbooks List Report Elements
List elements in a report. Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
report_idrequiredWorkbooks List Report Queries
List SQL queries in a report. Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
report_idrequiredWorkbooks List Report Lineage
List lineage for a report. Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
report_idrequiredWorkbooks Export Report
Export a report. format: 'pdf', 'png', 'csv', 'xlsx'.
formatreport_idrequiredWorkbooks List Report Schedules
List scheduled exports for a report. 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.
report_idrequiredWorkbooks Create Report Schedule
Create a scheduled export for a report.
bodyrequiredreport_idrequiredWorkbooks List Shared Templates
List templates shared with your organization from other orgs. 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.
Takes no parameters.
Workbooks Accept Shared Template
Accept a pending template share from another organization.
share_idrequiredWorkbooks Copy Workbook To Member
Copy a workbook into a member's My Documents folder. name: Optional name for the copied workbook. Defaults to the original workbook name.
namemember_idrequiredworkbook_idrequiredWorkbooks Deploy Template To Folder
Full deployment: instantiate a template into a folder, then optionally swap its sources.
namerequiredfolder_idrequiredtemplate_idrequiredconnection_mappingWorkbooks Promote Workbook
Promote a workbook by tagging it (e.g., 'Production'). Creates tag if it doesn't exist.
tag_namerequiredtag_colorworkbook_idrequiredWorkbooks Export And Download
Export a workbook/element and download the result. Polls until ready. format: 'csv', 'pdf', 'xlsx', 'png'. layout: 'portrait' or 'landscape' (pdf only). parameters: Sigma control overrides e.g. {'DateRange': 'min:2024-01-01,max:2024-01-31'}. max_bytes: maximum allowed response size (default 10 MB). Returns size info without content if exceeded. Returns base64-encoded file content on success.
formatlayoutmax_byteselement_idparametersworkbook_idrequiredtimeout_secondsWorkbooks Reassign Workbook Ownership
Transfer all workbooks from one member to another. Resolves members by email, finds all workbooks owned by old owner, then PATCHes /v2/files/{id} to reassign. dry_run=True (default) reports what would change without making changes. Both arguments must be email addresses (Sigma looks members up by email only), and each must match exactly one member's email, ignoring case; otherwise the call fails before any change.
dry_runnew_owner_emailrequiredold_owner_emailrequiredWorkbooks List Workbooks Shared With Member
List all workbooks accessible to a member with full workbook metadata. Cross-references member's file list against the full workbook catalog.
member_idrequiredWorkbooks List All Workbooks
List ALL workbooks in the organization, automatically following pagination.
Takes no parameters.
Workbooks List All Reports
List ALL reports in the organization, automatically following pagination.
Takes no parameters.
Workbooks Update Workbook Contents
Update a workbook from a code representation (JSON document specification). Mutating operation. Requires confirm=True and document_version integer to guard against concurrent overwrites.
confirmcontentsrequiredworkbook_idrequireddocument_versionrequiredWorkbooks Verify Workbook Spec
Verify a workbook code representation specification without saving. Validates schema structure, syntax, and element layout through a dry run of workbook creation (``dryRun: true``). Returns ``{valid, errors, warnings}``. A success that does not echo ``dryRun: true`` fails the call (``dry_run_not_honored``) and names any ID that came back, since Sigma may then have created a real workbook.
namerequireddocumentrequiredfolder_idrequireddescriptionWorkbooks Update Report Contents
Update a report from a code representation (JSON document specification). Mutating operation. Requires confirm=True and document_version integer to guard against concurrent overwrites.
confirmcontentsrequiredreport_idrequireddocument_versionrequiredWorkbooks Verify Report Spec
Verify a report code representation specification without saving. Runs report creation as a dry run (``dryRun: true``). Returns ``{valid, errors, warnings}``. A success that does not echo ``dryRun: true`` fails the call (``dry_run_not_honored``) and names any ID that came back, since Sigma may then have created a real report.
namerequireddocumentrequiredfolder_idrequireddescriptionWorkbooks Download Query Export
Download an exported query result file by queryId. Returns the file content (JSON or text/CSV) or base64 binary (PDF, XLSX, PNG), or reports 'processing' if the query has not finished executing. max_bytes: Maximum allowed payload size in bytes (default 10 MB).
query_idrequiredmax_bytesWorkbooks List Workbook Agents
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.
workbook_idrequiredversion_tag_nameWorkbooks Run Workbook Agent
Run an in-workbook AI agent with conversation messages. Mutating / execution operation. Consumes LLM tokens. Requires confirm=True. messages: List of conversation turns (role: 'user', 'assistant', 'system', 'tool' with content). version_tag_name: Target published version tag (defaults to latest published version).
confirmagent_idrequiredmessagesrequiredmetadatamax_turnsworkbook_idrequiredresponse_formatversion_tag_namemax_output_tokensWorkbooks Delete Workbook Grant
Delete a grant (a user's or team's permission) from a workbook. Requires confirm=True. Retrieve grant IDs with workbooks_list_workbook_grants.
confirmgrant_idrequiredworkbook_idrequiredWorkbooks Delete Workbook Embed
Delete an embed from a workbook. Requires confirm=True. Retrieve embed IDs with workbooks_list_workbook_embeds. Embeds that use the embed URL stop working.
confirmembed_idrequiredworkbook_idrequiredWorkbooks Send Workbook
Export (send) a workbook once to one or more targets: email, Slack, Google Sheets/Drive, or a webhook. body follows Sigma's POST /v2/workbooks/{workbookId}/send: target (list of targets), configV2 (format and element or page to export), plus optional parameters, conditions, timeout and sendAsUser.
bodyrequiredworkbook_idrequiredWorkbooks Update Workbook Schedule
Update a workbook's scheduled export. body may set target, schedule (cronSpec, timezone), configV2, description and suspensionAction. Retrieve schedule IDs with workbooks_list_workbook_schedules.
bodyrequiredschedule_idrequiredworkbook_idrequiredWorkbooks Update Workbook Bookmark
Update a saved view (bookmark) in a workbook. body may set name, isShared, isDefault and exploreKey. Retrieve bookmark IDs with workbooks_list_workbook_bookmarks.
bodyrequiredbookmark_idrequiredworkbook_idrequiredWorkbooks Delete Workbook Bookmark
Delete a saved view (bookmark) from a workbook. Requires confirm=True.
confirmbookmark_idrequiredworkbook_idrequiredWorkbooks Duplicate Tagged Workbook
Duplicate the version of a workbook carrying a version tag into a folder as a new workbook. tag_name is the version tag NAME (e.g. 'Production'). copy_bookmarks is "all" (every saved view; admins only) or "accessible" (personal saved views and those shared with the caller); leave it unset to copy none. Returns the new workbook.
namerequiredtag_namerequireddescriptionworkbook_idrequiredcopy_bookmarksdestination_folder_idrequiredWorkbooks Share Workbook Cross Org
Share a workbook with other Sigma organizations. body requires orgSlugs (list of organization slugs) and may set shareDatasets, copyInputTableData, sendEmail and emailMessage.
bodyrequiredworkbook_idrequiredWorkbooks Duplicate Tagged Report
Duplicate the version of a report carrying a version tag into a folder as a new report. tag_name is the version tag NAME. Returns the new report.
namerequiredtag_namerequiredreport_idrequireddescriptiondestination_folder_idrequiredWorkbooks List Report Pages
List the pages of a report. Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
report_idrequiredWorkbooks List Report Page Elements
List the elements on one page of a report. Retrieve page IDs with workbooks_list_report_pages. Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
page_idrequiredreport_idrequiredWorkbooks List Report Columns
List the columns of every element in a report. Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
report_idrequiredWorkbooks Get Report Element Query
Get the SQL query Sigma generates for a report element.
report_idrequiredelement_idrequiredWorkbooks List Report Controls
List the controls (filters and parameters) in a report. Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
report_idrequiredWorkbooks Get Report Version History
Get the version history of a report (published versions, who and when). Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
report_idrequiredWorkbooks Send Report
Export (send) a report once to one or more targets. body requires targets, config and attachments, and may set parameters and timeout, per Sigma's POST /v2/reports/{reportId}/send.
bodyrequiredreport_idrequiredWorkbooks Update Report Schedule
Update a report's scheduled export. body may set target, schedule, configV2, description and suspensionAction. Retrieve schedule IDs with workbooks_list_report_schedules.
bodyrequiredreport_idrequiredschedule_idrequiredWorkbooks Delete Report Schedule
Delete a report's scheduled export. Requires confirm=True.
confirmreport_idrequiredschedule_idrequiredWorkbooks Create Report Grant
Grant users or teams permission on a report. body requires grants: a list of {grantee: {memberId} or {teamId}, permission: 'view' | 'edit'}.
bodyrequiredreport_idrequiredWorkbooks Delete Report Grant
Delete a grant from a report. Requires confirm=True.
confirmgrant_idrequiredreport_idrequiredWorkbooks List Report Tags
List the version tags on a report. Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
report_idrequiredWorkbooks Tag Report
Apply a version tag to a report by tag NAME (e.g. 'Production'). The Sigma API takes the tag name here, not its ID.
tag_namerequiredreport_idrequiredWorkbooks Remove Report Tag
Remove a version tag from a report. Requires confirm=True. Retrieve tag IDs with workbooks_list_report_tags.
tag_idrequiredconfirmreport_idrequiredWorkbooks Delete Shared Template
Delete a template share. Requires confirm=True. Retrieve share IDs with workbooks_list_shared_templates.
confirmshare_idrequiredDatasets List Connections
List all connections in the Sigma organization. Pass summary_only=True for concise token-efficient response. 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.
summary_onlyDatasets Get Connection
Get details for a specific connection.
connection_idrequiredDatasets Sync Connection
Force Sigma to re-index a warehouse path. Pass empty list for full sync.
pathconnection_idrequiredDatasets Test Connection
Test connectivity for a connection.
connection_idrequiredDatasets List Columns For Table
List columns for a warehouse table by its tableId. Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
table_idrequiredDatasets List Connection Grants
List permission grants on a connection. 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.
connection_idrequiredDatasets Add Connection Grant
Add a grant to a connection. grant_type: 'member' or 'team'. permission: 'annotate' (Can Use & Annotate) or 'usage' (Can Use).
grant_typerequiredgrantee_idrequiredpermissionrequiredconnection_idrequiredDatasets Delete Connection Path Grant
Delete a grant from a connection path. DESTRUCTIVE. Requires confirm=True.
confirmgrant_idrequiredconnection_path_idrequiredDatasets List Data Models
List all data models in the organization. Pass summary_only=True for concise token-efficient response. 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. ``limit`` is the page size.
limitsummary_onlyDatasets Get Data Model
Get data model metadata.
data_model_idrequiredDatasets Get Data Model Spec
Get the full code representation (JSON spec) of a data model — tables, columns, metrics, relationships.
data_model_idrequiredDatasets Create Data Model
Create a data model from a JSON code representation. Must include name, folderId, schemaVersion, and pages with elements.
specrequiredDatasets Update Data Model
Update an existing data model from a JSON code representation (full replacement via PUT).
specrequireddata_model_idrequiredDatasets List Data Model Elements
List elements in a data model. 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.
data_model_idrequiredDatasets List Data Model Columns
List all columns across all elements in a data model. 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.
data_model_idrequiredDatasets Swap Data Model Sources
Swap data sources for a data model.
bodyrequireddata_model_idrequiredDatasets List Data Model Lineage
List lineage for a data model. 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.
data_model_idrequiredDatasets Tag Data Model
Apply a version tag to a data model by tag NAME. The Sigma API takes the tag name here, not its ID.
tag_namerequireddata_model_idrequiredDatasets Swap Report Sources
Swap data sources on a report. Use connectionMapping for connection-level swaps, sourceMapping for table-level swaps.
report_idrequiredsource_mappingconnection_mappingDatasets Sync All Tables In Schema
Sync all tables in a warehouse schema so they become visible in Sigma.
schemarequireddatabaserequiredconnection_idrequiredDatasets Bulk Sync Tenant Connections
Sync connections across all tenant organizations. Lists all tenants, then for each tenant: obtains a tenant-scoped token, lists their connections, and syncs each one. Requires multi-tenant auth (for_tenant method). Uses bounded concurrency. NOTE: Requires PyJWT and the for_tenant() method (Phase C). Returns an error if token exchange is not available.
dry_runDatasets List All Data Models
List ALL data models in the organization, automatically following pagination.
Takes no parameters.
Datasets Create Connection
Create a data warehouse connection. body requires name and details (the warehouse type and its settings) and may set description, poolSizes, timeoutSecs and useFriendlyNames. The details may hold write-only secrets (password, privateKey, privateKeyPassphrase, clientSecret, token, pythonSecrets): pass them only from the user's own input. They are masked wherever Sigma's result or error echoes them.
bodyrequiredDatasets Delete Connection
Delete a connection. Requires confirm=True. Workbooks and data models built on it lose their source.
confirmconnection_idrequiredDatasets List Connection Paths
List connection paths (databases, schemas and tables) across all connections. 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.
Takes no parameters.
Datasets Lookup Connection Path
Look up the object at a fully qualified path in a connection, e.g. ["DATABASE", "SCHEMA", "TABLE"] for Snowflake. Read-only: the POST only resolves the path.
pathrequiredconnection_idrequiredDatasets Delete Connection Grant
Delete a grant from a connection. Requires confirm=True. Retrieve grant IDs with datasets_list_connection_grants.
confirmgrant_idrequiredconnection_idrequiredDatasets List Connection Path Grants
List grants on a connection path (database, schema or table). 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.
connection_path_idrequiredDatasets Add Connection Path Grant
Add grants to a connection path. body requires grants: a list of {grantee: {memberId} or {teamId}, permission: 'annotate' | 'usage'}.
bodyrequiredconnection_path_idrequiredDatasets List Data Model Sources
List the sources (tables, datasets, other data models) a data model reads from. Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
data_model_idrequiredDatasets Materialize Data Model
Run the scheduled materialization for one data model element now. sheet_id is the element's ID. Returns the materialization job; poll it with datasets_get_data_model_materialization.
sheet_idrequireddata_model_idrequiredDatasets Get Data Model Materialization
Get the status of a data model materialization job.
data_model_idrequiredmaterialization_idrequiredDatasets List Data Model Materialization Schedules
List the materialization schedules of a data model. Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
data_model_idrequiredDatasets List Data Model Tags
List the version tags on a data model. 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.
data_model_idrequiredElements List Workbook Page Elements
List elements on a specific page of 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.
page_idrequiredworkbook_idrequiredElements List Workbook Elements
List all elements (tables, charts, controls, etc.) in 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.
workbook_idrequiredElements List Workbook Columns
List all columns across all elements in a workbook, including formulas and types. 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.
workbook_idrequiredElements List Workbook Queries
List generated SQL queries for all elements in 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.
workbook_idrequiredElements List Workbook Controls
List control elements (filters, parameters) in 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.
workbook_idrequiredElements List Workbook Sources
List data sources used by a workbook.
workbook_idrequiredElements Swap Workbook Sources
Swap data sources for a workbook. Use connectionMapping for connection-level swaps, sourceMapping for table-level swaps.
workbook_idrequiredsource_mappingconnection_mappingElements Get Element Query
Get the generated SQL query for a specific element in a workbook.
element_idrequiredworkbook_idrequiredElements Get Element Columns
List columns for a specific element in 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.
element_idrequiredworkbook_idrequiredElements Materialize Element
Trigger materialization for a workbook. Pass elementId in body if needed.
element_idrequiredworkbook_idrequiredElements Get Materialization Job
Check status of a materialization job.
job_idrequiredworkbook_idrequiredElements List Materialization Schedules
List every materialization schedule 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.
workbook_idrequiredElements Swap Template Sources
Swap data sources on a template. Use connectionMapping for connection-level swaps, sourceMapping for table-level swaps.
template_idrequiredsource_mappingconnection_mappingElements List Source Swap Policies
List all source swap policies (rules for automatic source swapping on deployment). 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.
Takes no parameters.
Elements Get Source Swap Policy
Get a source swap policy.
policy_idrequiredElements Create Source Swap Policy
Create a source swap policy for automated deployments.
bodyrequiredElements Materialize And Wait
Trigger materialization and poll until complete or timeout.
element_idrequiredworkbook_idrequiredtimeout_secondsElements List All Input Tables
Scan all workbooks to find input-table elements. Returns a list of input tables with their workbook, page, and element context. Errors on individual workbooks/pages are collected rather than silently swallowed.
Takes no parameters.
Elements Formula Pitfalls
Return a curated reference of common Sigma formula pitfalls — column reference syntax, type requirements, NULL handling, aggregate vs row-level context, date function argument order, and metrics vs calculated columns. Use this before writing any Sigma formula expression.
Takes no parameters.
Elements Search Docs
Search Sigma Computing documentation using AI-powered semantic search. Returns relevant doc passages with source URLs. Use this to answer questions about Sigma features, configuration, formulas, administration, embedding, and best practices. read_only_hint: True
queryrequiredElements Get Doc Page
Fetch a specific Sigma documentation page as clean Markdown. Pass the page slug (e.g. 'create-a-workbook') or a section path (e.g. 'docs/create-a-workbook'). Returns the full page content. read_only_hint: True
page_slugrequiredElements List Element Lineage
List the lineage (upstream sources and dependencies) of one workbook element.
element_idrequiredworkbook_idrequiredElements Update Source Swap Policy
Update a source swap policy (Beta). body may set type, name, fromConnectionId and swaps.
bodyrequiredpolicy_idrequiredElements Delete Source Swap Policy
Delete a source swap policy (Beta). Requires confirm=True.
confirmpolicy_idrequiredWorkspace Delete File
Delete a file/workbook/data model by its inode ID. Requires confirm=True.
confirminode_idrequiredWorkspace List Files
List files/folders. Optionally filter by parentId or type ('workbook', 'folder', 'data-model', 'template'). 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.
parent_idtype_filterWorkspace Create Folder
Create a folder.
namerequiredparent_idrequiredWorkspace Update File
Update file properties (name, parentId for moving).
bodyrequiredinode_idrequiredWorkspace List Tags
List all tags in the organization. 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. ``page`` resumes from a ``nextPage`` cursor; ``limit`` is the page size.
pagelimitWorkspace Create Tag
Create a new tag (used for version promotion like 'Production', 'Staging').
namerequiredcolorWorkspace Delete Tag
Delete a tag. Requires confirm=True.
tag_idrequiredconfirmWorkspace List Workspaces
List all workspaces. 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. ``page`` resumes from a ``nextPage`` cursor; ``limit`` is the page size.
pagelimitWorkspace Get Workspace
Get workspace details.
workspace_idrequiredWorkspace Create Workspace
Create a new workspace.
namerequiredWorkspace Delete Workspace
Delete a workspace. Requires confirm=True.
confirmworkspace_idrequiredWorkspace List Workspace Grants
List permission grants on a workspace. 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. ``page`` resumes from a ``nextPage`` cursor; ``limit`` is the page size.
pagelimitworkspace_idrequiredWorkspace Grant Workspace Access
Grant workspace access. grant_type: 'member' or 'team'. permission: 'view', 'explore', 'organize' (Contribute), or 'edit' (Manage).
grant_typerequiredgrantee_idrequiredpermissionrequiredworkspace_idrequiredWorkspace Delete Workspace Grant
Delete a permission grant from a workspace. DESTRUCTIVE. Requires confirm=True.
confirmgrant_idrequiredworkspace_idrequiredWorkspace List All Files
List files/folders in the organization, automatically following pagination. parent_id: Optional parent folder ID to list files within. type_filter: Optional file type filter ('workbook', 'folder', 'data-model', 'template', 'symlink'). Note: Shortcuts/symlinks are excluded by default unless type_filter='symlink'.
parent_idtype_filterWorkspace List Member Files
List the files (workbooks, data models, folders) a member can access. 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. ``limit`` is the page size.
limitmember_idrequiredWorkspace List Recent Files
List the files a member opened recently. 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.
member_idrequiredWorkspace Get File
Get a file's details (type, name, path, owner) by its inode ID.
inode_idrequiredWorkspace Update Tag
Update a version tag. body may set name, description and color.
bodyrequiredtag_idrequiredWorkspace List Workbooks For Tag
List the workbooks carrying a version tag. 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.
tag_idrequiredWorkspace Update Workspace
Update (rename) a workspace. body requires name and may set noDuplicates.
bodyrequiredworkspace_idrequiredWorkspace Favorite File
Add a document to a member's favorites.
inode_idrequiredmember_idrequiredWorkspace Unfavorite File
Remove a document from a member's favorites. Requires confirm=True.
confirminode_idrequiredmember_idrequiredWorkspace List Favorites For Member
List a member's favorite documents. 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.
member_idrequiredAdmin List Deployments
List all deployment policies. Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
Takes no parameters.
Admin Get Deployment
Get a deployment policy.
policy_idrequiredAdmin Create Deployment
Create a deployment policy.
bodyrequirednamerequiredAdmin Archive Deployment
Delete (archive) a deployment policy. Requires confirm=True.
confirmpolicy_idrequiredAdmin Deactivate Member
Deactivate a member. Requires confirm=True.
confirmmember_idrequiredAdmin List Deployment Documents
List documents in a deployment policy. Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
policy_idrequiredAdmin Add Deployment Documents
Add workbooks/reports to a deployment policy.
inode_idsrequiredpolicy_idrequiredAdmin List Tenants
List all tenant organizations (for multi-tenant deployments). Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
Takes no parameters.
Admin Get Tenant
Get tenant organization details.
tenant_idrequiredAdmin Create Tenant
Create a tenant organization.
bodynamerequiredAdmin List Api Connectors
List all API connectors (custom data integrations). Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
Takes no parameters.
Admin Get Api Connector
Get details for an API connector.
connector_idrequiredAdmin List Members
List all members in the organization. Pass summary_only=True for concise token-efficient response. 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. ``limit`` is the page size.
limitsummary_onlyAdmin Get Member
Get member details including homeFolderId.
member_idrequiredAdmin Create Member
Create a new member. member_type: 'admin', 'creator', 'viewer'.
emailrequiredlast_namerequiredfirst_namerequiredmember_typeAdmin Update Member
Update member properties (firstName, lastName, memberType, isActive, etc.).
bodyrequiredmember_idrequiredAdmin Get Current User
Get the current authenticated user's details.
Takes no parameters.
Admin List Member Teams
List teams a member belongs to. 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.
member_idrequiredAdmin List Teams
List all teams. Pass summary_only=True for concise token-efficient response. 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. ``limit`` is the page size.
limitsummary_onlyAdmin Get Team
Get team details.
team_idrequiredAdmin Create Team
Create a new team.
namerequireddescriptionAdmin Delete Team
Delete a team. Requires confirm=True.
confirmteam_idrequiredAdmin List Team Members
List members of a team. 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.
team_idrequiredAdmin Update Team Members
Add or remove members from a team. Provide lists of member IDs.
addremoveteam_idrequiredAdmin List User Attributes
List all user attributes (used for row-level security and dynamic parameters). 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.
Takes no parameters.
Admin Create User Attribute
Create a user attribute for RLS or dynamic parameters. name: Attribute name (e.g. 'Region', 'CustomerID'). default_value: Default string value assigned when no override exists. description: Optional description of the attribute.
namerequireddescriptiondefault_valueAdmin Set User Attribute For Teams
Set a user attribute value for specific teams. assignments: List of objects, each with 'teamId' (str) and 'value' (str). Example: [{"teamId": "abc123", "value": "US"}]
assignmentsrequiredattribute_idrequiredAdmin Set User Attribute For Tenants
Set a user attribute value for specific tenants. assignments: List of objects, each with 'tenantOrganizationId' (str) and 'value' (str). Example: [{"tenantOrganizationId": "org123", "value": "US"}]
assignmentsrequiredattribute_idrequiredAdmin Get User Attribute Users
Get all user assignments for a user attribute. 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.
attribute_idrequiredAdmin Get User Attribute Teams
Get all team assignments for a user attribute. 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.
attribute_idrequiredAdmin Get User Attribute Tenants
Get all tenant assignments for a user attribute. 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.
attribute_idrequiredAdmin Update User Attribute For Users
Revoke a user attribute assignment for specific users. Requires confirm=True. user_ids: List of user IDs whose attribute assignments should be removed. Example: ["user-uuid-1", "user-uuid-2"] To assign (not revoke), use admin_set_user_attribute_for_users instead.
confirmuser_idsrequiredattribute_idrequiredAdmin Update User Attribute For Teams
Revoke a user attribute assignment for specific teams. Requires confirm=True. team_ids: List of team IDs whose attribute assignments should be removed. Example: ["team-uuid-1", "team-uuid-2"]
confirmteam_idsrequiredattribute_idrequiredAdmin Update User Attribute For Tenants
Revoke a user attribute assignment for specific tenants. Requires confirm=True. tenant_org_ids: List of tenant organization IDs whose attribute assignments should be removed. Example: ["org-uuid-1", "org-uuid-2"]
confirmattribute_idrequiredtenant_org_idsrequiredAdmin Delete User Attribute For User
Delete a user attribute assignment for a specific user. DESTRUCTIVE. Requires confirm=True.
confirmuser_idrequiredattribute_idrequiredAdmin Delete User Attribute For Team
Delete a user attribute assignment for a specific team. DESTRUCTIVE. Requires confirm=True.
confirmteam_idrequiredattribute_idrequiredAdmin Delete User Attribute For Tenant
Delete a user attribute assignment for a specific tenant. DESTRUCTIVE. Requires confirm=True.
confirmattribute_idrequiredtenant_org_idrequiredAdmin List Account Types
List all account types (license types) in the organization. Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries`` from every page and ``nextPageToken`` null, since every page is read.
Takes no parameters.
Admin List Grants
List grants for a specific file/workbook/data model by inodeId. Required: inodeId. 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.
inode_idrequiredAdmin Create Grant
Create or update a grant. Body must include inodeId, granteeId, permission, type.
bodyrequired90% of the applicable checks met
How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.
Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.
graph TD UI["Sigma UI"] -->|"1. Build Layout Once & Save"| TPL["Sigma Template"] Agent["AI Agent / LLM"] -->|"2. Call workbooks_deploy_template_to_folder"| MCP["mcp-server-sigma"] MCP -->|"POST /v2/templates/{id}/instantiate"| API1["Instantiate Workbook"] MCP -->|"POST /v2/workbooks/{id}/swap_sources"| API2["Swap Warehouse Sources"] API2 -->|"Delivered"| Dest["Target Customer Folder"]pip install mcp-server-sigma# or with uvuv pip install mcp-server-sigmadocker run --rm -i --env-file .env \ ghcr.io/christianclaudio/mcp-server-sigma:latestexport SIGMA_MCP_AUTH_TOKEN="$(openssl rand -hex 32)" # or read it from your secret storedocker run --rm -p 8000:8000 --env-file .env \ -e SIGMA_MCP_AUTH_TOKEN \ ghcr.io/christianclaudio/mcp-server-sigma:latest \ --transport streamable-http --host 0.0.0.0 --port 8000 --allowed-host mcp.example.comexport SIGMA_CLIENT_ID="your-client-id"export SIGMA_CLIENT_SECRET="your-client-secret"export SIGMA_API_BASE_URL="https://api.us-a.aws.sigmacomputing.com"{ "mcpServers": { "sigma": { "command": "sigma-mcp", "env": { "SIGMA_CLIENT_ID": "your-client-id", "SIGMA_CLIENT_SECRET": "your-client-secret", "SIGMA_API_BASE_URL": "https://api.us-a.aws.sigmacomputing.com" } } }}claude mcp add sigma -- sigma-mcp{ "mcpServers": { "sigma": { "command": "sigma-mcp", "args": [], "env": { "SIGMA_CLIENT_ID": "your-client-id", "SIGMA_CLIENT_SECRET": "your-client-secret", "SIGMA_API_BASE_URL": "https://api.us-a.aws.sigmacomputing.com" } } }}# Source environment variables from a protected file or secret managersource .env
# Launch server on HTTP localhost port 8000 for local clientssigma-mcp --transport streamable-http --host 127.0.0.1 --port 8000{ "mcpServers": { "sigma": { "command": "sigma-mcp", "env": { "SIGMA_CLIENT_ID": "your-client-id", "SIGMA_CLIENT_SECRET": "your-client-secret", "SIGMA_API_BASE_URL": "https://api.us-a.aws.sigmacomputing.com" } } }}mcpServers: - name: sigma command: sigma-mcp env: SIGMA_CLIENT_ID: "your-client-id" SIGMA_CLIENT_SECRET: "your-client-secret" SIGMA_API_BASE_URL: "https://api.us-a.aws.sigmacomputing.com"{ "mcpServers": { "sigma": { "command": "sigma-mcp", "env": { "SIGMA_CLIENT_ID": "your-client-id", "SIGMA_CLIENT_SECRET": "your-client-secret", "SIGMA_API_BASE_URL": "https://api.us-a.aws.sigmacomputing.com" } } }}{ "mcpServers": { "sigma": { "type": "local", "command": "sigma-mcp", "env": { "SIGMA_CLIENT_ID": "${COPILOT_MCP_SIGMA_CLIENT_ID}", "SIGMA_CLIENT_SECRET": "${COPILOT_MCP_SIGMA_CLIENT_SECRET}", "SIGMA_API_BASE_URL": "https://api.us-a.aws.sigmacomputing.com", "SIGMA_MCP_READONLY": "1" }, "tools": ["workbooks_get_workbook", "workbooks_list_workbooks", "datasets_get_data_model"] } }}cortex mcp add sigma-tools -- sigma-mcp# Model prompt helperUse tool `elements_formula_pitfalls` to check formula syntax rules.# Install dev toolspip install -e ".[dev]"
# Run full test suite with 100% statement line coverage enforcementpytest --cov=src/sigma_mcp --cov-fail-under=100 --cov-report=term-missing
# Run OpenAPI drift checkpython scripts/check_openapi_drift.py
# Run MCP tool contract validationpython scripts/check_tool_contract.py
# Code formatting & type checkingruff check src/ruff format --check .mypy --strict src/