mcp-server-sigma
This MCP server provides 155+ tools for AI agents to fully manage Sigma Computing resources, including connections, workbooks, data models, reports, members, teams, deployments, templates, multi-tenancy, files, and webhooks. It supports:
Connections: List, get, sync, test, manage grants, list table columns.
Workbooks: CRUD, pages/elements/columns/queries/controls/sources, swap sources, lineage, version history, export (PDF, PNG, CSV, XLSX, JSON), schedules, materializations, bookmarks, tags, embeds, convert to report, grant management.
Data Models: CRUD, JSON spec inspection, elements/columns, swap sources, lineage, version tags.
Reports: CRUD, duplicate, sources/elements/queries/lineage, swap sources, export, schedules.
Members & Teams: List, get, create, update, deactivate members; manage teams and team memberships.
Deployments: Create, archive, manage policies, add documents.
Templates: List, get, instantiate, save from workbook, swap sources, shared templates.
Multi-Tenancy: Tenant create/list/get, API connectors, source swap policies.
Files/Folders: List, filter, delete.
Composite Recipes: High-level workflows like deploy template, materialize and wait, onboard member, bulk assign, copy workbook, promote workbook, reassign ownership, sync all tables.
Formula Assistance:
sigma_formula_pitfallsto validate formula syntax.Documentation: Search docs and get API capabilities.
Safety: Read-only mode (
SIGMA_MCP_READONLY), destructive ops requireconfirm=True, bulk destructive actions disabled by default. All tools annotated with hints (readOnly, destructive, idempotent, openWorld).AI Integration: Works with Claude, Gemini, OpenAI, VS Code, GitHub Copilot, etc. via stdio/streamable-http.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@mcp-server-sigma Deploy the Q3 sales template to the Marketing folder and swap sources to Prod."
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
📊 mcp-server-sigma
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.
⚠️ Disclaimers & Safety Warnings
Community Project Disclaimermcp-server-sigma is 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.
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.
Related MCP server: Atlassian MCP Server
💡 Why This Exists
Sigma Computing has a unique architectural asymmetry that shapes how you automate it:
Data Models are 100% Code-Representable: You can programmatically construct data models, define columns, joins, and SQL logic, update JSON specs, and swap warehouse sources via API.
Workbook Layouts are primarily UI-driven: While Sigma has introduced Beta endpoints for workbook specifications (
/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):
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"]📦 Quickstart & Installation
1. Install via pip or uv
pip install mcp-server-sigma
# or with uv
uv pip install mcp-server-sigmaOr run via Docker
docker run --rm -i --env-file .env \
ghcr.io/christianclaudio/mcp-server-sigma:latestThe 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:
export SIGMA_MCP_AUTH_TOKEN="$(openssl rand -hex 32)" # or read it from your secret store
docker 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.com2. Set Environment Variables
export 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"Use the API base URL assigned to your organization's region.
Region | Base URL |
AWS US East |
|
AWS US West |
|
AWS Canada |
|
AWS EU |
|
AWS UK |
|
AWS Australia |
|
Azure US |
|
Azure EU |
|
Azure Canada |
|
Azure UK |
|
Azure Australia |
|
GCP US |
|
GCP Saudi Arabia |
|
🔌 Integration Guides for AI Assistants & IDEs
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):
{
"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"
}
}
}
}For Claude Code CLI:
claude mcp add sigma -- sigma-mcpAdd to your project's .agents/mcp_config.json (or global ~/.gemini/config/mcp_config.json):
{
"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"
}
}
}
}Run in network transport mode (Streamable HTTP) for local CLI & agent extensions:
# Source environment variables from a protected file or secret manager
source .env
# Launch server on HTTP localhost port 8000 for local clients
sigma-mcp --transport streamable-http --host 127.0.0.1 --port 8000Point 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:
On
127.0.0.1,::1orlocalhost(the--hostdefault is127.0.0.1), HTTP runs with or withoutSIGMA_MCP_AUTH_TOKEN; without it, a warning says requests are not authenticated.On any other host (
0.0.0.0,::, a LAN address), the server refuses to start (exit code 2) unlessSIGMA_MCP_AUTH_TOKENis set, orSIGMA_MCP_ALLOW_UNAUTHENTICATED_BIND=1accepts an unauthenticated bind (logged as a warning), for example behind a gateway that authenticates for you.The token is attached when the server is built, so
fastmcp run src/sigma_mcp/server.py:mcp --transport httpand an ASGI host mountingmcp.http_app()enforce it too. Those entry points do not know the bind host, so they cannot refuse a public bind; usesigma-mcpfor that policy.In the default (stateful) HTTP mode, a session idle for 30 minutes expires: its next request gets HTTP 404 and the client must start a new session. Change this with FastMCP's
session_idle_timeout(onhttp_app()) orFASTMCP_HTTP_SESSION_IDLE_TIMEOUT(seconds, ornoneto 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 / Roo Code Settings (cline_mcp_settings.json):
{
"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"
}
}
}
}Continue.dev Config (~/.continue/config.yaml):
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"Add to ~/.cursor/mcp.json:
{
"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"
}
}
}
}Add .github/mcp.json to your repository:
{
"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"]
}
}
}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:
cortex mcp add sigma-tools -- sigma-mcp🛡️ Safety & Security Controls
Configure behavior using environment variables:
Variable | Default | Description |
| Required | Your Sigma API client ID. |
| Required | Your Sigma API client secret. |
| Required | Region-specific Sigma API host URL. Must be HTTPS and a host in |
| official regional API hosts | Comma-separated hostname allowlist for |
|
| Profile: |
|
| Set |
|
| Set |
|
| Set |
|
| Tool Search backend: |
|
| Set |
| (unset) | On |
|
| Set to |
|
| Comma-separated allowlist of tenant org IDs permitted for RFC 8693 token exchange. |
|
| Set |
|
| Retries on HTTP 429 (0 to 10). |
|
| Base delay in seconds for the exponential backoff used when a 429 has no |
|
| Cap in seconds on that backoff. It does not apply to a |
|
| Longest |
|
| Set |
🧭 Profiles
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.
Profile | Job it serves | Tools | With |
| Complete catalog, nothing omitted. Bulk tools are listed and refused at call time unless | 263 | 120 |
| Auditor / safe exploration: every tool annotated | 120 | 120 |
| Business user finds, reads, exports and schedules workbooks and reports, bookmarks views, and asks workbook agents. | 50 | 33 |
| Workbook author builds, versions and verifies workbooks, reports and templates, and inspects elements while editing. | 55 | 37 |
| Data modeler maintains connections and data models, swaps workbook/report/model sources and materializes elements. | 44 | 30 |
| Embedded-analytics engineer provisions tenants and tenant dashboards: templates, deployments, source swaps, embeds, tenant user attributes and connection syncs. | 76 | 31 |
| Org admin onboards and offboards members, manages teams, grants and user attributes, workspace/workbook/connection access, and org security settings. | 72 | 26 |
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.
Read-only behavior
The MCP
readOnlyHintannotation is the only thing that decides whether a tool is read-only. Every tool declares it explicitly:trueon the 120 reads andfalseon the 143 writes. A tool with no annotation or noreadOnlyHintcounts as a write.--profile readonlyorSIGMA_MCP_READONLY=1(on any profile) lists only the read-only tools, andReadOnlyGateMiddlewarerefuses 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 withisError: true.A name that is not a tool on the server gets FastMCP's normal
Unknown toolerror, directly or throughcall_tool, so a typo is never reported as a blocked tool.With Tool Search on, the gate checks the tool that
call_toolwraps. Reads throughcall_toolwork and writes are refused. Without Tool Search,call_toolis not a tool on the server, so a call to it getsUnknown tool: 'call_tool'.If the gate cannot see the serving server, it refuses the call.
Bulk gate
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.
Tool Search and Code Mode
tools/list is flat by default. Discovery is opt-in and attaches only on full:
--enable-tool-search/SIGMA_MCP_ENABLE_TOOL_SEARCH=1replacestools/listwithsearch_toolsandcall_tool. The backend isregex(default) orbm25(--tool-search-backend/SIGMA_MCP_TOOL_SEARCH_BACKEND).--enable-code-mode/SIGMA_MCP_ENABLE_CODE_MODE=1attaches FastMCP's experimental Code Mode (search,get_schema,execute). Code Mode needs the sandbox from the package'scode-modeextra (fastmcp[code-mode], which shipspydantic-monty):pip install "mcp-server-sigma[code-mode]"oruvx "mcp-server-sigma[code-mode]" --enable-code-mode. Without it, Code Mode is skipped with a warning and the flat catalog is served.Turning on both raises
ValueError. Asking for either on another profile logs a warning and keeps the flat list.search_tools,searchandget_schemaonly read the catalog and are annotatedreadOnlyHint=true. Under read-only, Code Modeexecuteis refused.
📊 Feature & Tool Summary
The full profile lists 263 tools. Every tool name starts with the domain it is mounted under:
Domain | Tools | Covers |
| 78 | Workbooks, reports and templates: contents/spec, pages, versions, bookmarks, schedules, exports and one-off sends, tags, grants, embeds, cross-org sharing, report pages/elements/columns/controls, workbook agents, template deployment |
| 36 | Connections and data models: connection create/delete, connection paths and path grants, connection grants, tests and schema syncs, cross-tenant connection sync, data model specs, columns, lineage, sources, tags, materializations and source swaps |
| 26 | Workbook elements, columns, controls, queries, sources and lineage; materializations; source-swap policies; Sigma docs search and formula reference |
| 24 | Workspaces and their grants, files and folders, member files, recents and favorites, tags |
| 99 | Members, teams, user attributes, tenants, deployments, grants, org settings, AI config, IP allowlists, API connectors and credentials, translations, tenant deployment capabilities, member schedules and OAuth token revocation, recent webhook events |
Total | 263 |
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.
🍳 Composite Workflow Recipes
These high-level tools bundle multi-step API sequences into a single atomic call:
Recipe Tool | What It Does |
| Instantiates a template & swaps warehouse sources in 1 call |
| Triggers a data materialization and polls until complete with timeout |
| Atomically creates a member and assigns them to multiple teams |
| Batch-adds $N$ members to a team in a single request |
| Resolves member emails and batch-removes them from a team |
| Regex-matches members, generates dry-run report, and deactivates |
| Performs RFC 8693 token exchange per tenant to sync all connections |
| Duplicates a workbook directly into a user's home folder |
| Tags a workbook for version promotion (creates tag if missing) |
| Exports workbook/element, handles 204 polling, returns final content |
| Syncs an entire database.schema path across Sigma connections |
| Bulk-transfers workbook ownership from one member email to another |
📐 MCP 2.0 Hints & Safety Annotations
Every tool includes structured MCP hints to assist AI clients with user permission prompts:
Annotation | Count | Meaning |
| 120 | Indicates intended non-mutation; clients may still require explicit user approval |
| 43 | Deletes, deactivates, or revokes; clients should prompt |
| 10 | Safe to retry; same input = same outcome |
| 263 | All tools hit an external API |
🧮 Writing Sigma Formulas
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:
# Model prompt helper
Use tool `elements_formula_pitfalls` to check formula syntax rules.See docs/formulas.md for full syntax details.
👩💻 Local Development & Testing
# Install dev tools
pip install -e ".[dev]"
# Run full test suite with 100% statement line coverage enforcement
pytest --cov=src/sigma_mcp --cov-fail-under=100 --cov-report=term-missing
# Run OpenAPI drift check
python scripts/check_openapi_drift.py
# Run MCP tool contract validation
python scripts/check_tool_contract.py
# Code formatting & type checking
ruff check src/
ruff format --check .
mypy --strict src/Automated Drift Checks: The CI workflow (ci.yml) has a check-drift job, 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.
🤝 Contributing & Community
Contributions are welcome! Please read CONTRIBUTING.md for development rules, SECURITY.md for security reporting, and CODE_OF_CONDUCT.md for community standards.
📜 License
MIT License.
Copyright (c) 2026 Christian Claudio.
Disclaimer: Not affiliated with, sponsored by, or endorsed by Sigma Computing, Inc.
Available Tools
263 toolsadmin_add_allowed_ipsAdmin Add Allowed IpsA
Create/add IP allowlist entries for the organization (v3alpha).
Mutating operation. Requires confirm=True. entries: List of dicts, each with 'ip' (IPv4/IPv6 or CIDR), 'scope' ('public-api', 'ui', or 'both'), and optional 'description'.
Inputs: entries (required), confirm. Returns: result
admin_add_deployment_documentsAdmin Add Deployment DocumentsC
Add workbooks/reports to a deployment policy.
Inputs: inode_ids (required), policy_id (required). Returns: result
admin_add_deployment_tenantAdmin Add Deployment TenantC
Add a tenant to a deployment policy.
body requires tenantOrganizationId.
Inputs: body (required), policy_id (required). Returns: result
admin_api_capabilitiesAdmin Api CapabilitiesARead-only
Describe what the Sigma REST API can and cannot do programmatically.
Inputs: no named parameters. Returns: result
admin_archive_deploymentAdmin Archive DeploymentADestructive
Delete (archive) a deployment policy. Requires confirm=True.
Inputs: policy_id (required), confirm. Returns: result
admin_assign_user_attributes_to_teamAdmin Assign User Attributes To TeamB
Assign user attributes to a team.
OpenAPI: POST /v2/teams/{teamId}/assignedUserAttributes (teams_assignUserAttributesToTeam).
Spec: https://help.sigmacomputing.com/openapi/sigma-rest-api.json
Each assignment requires userAttributeId and value with type and val.
Non-destructive write (ANNOTATION_WRITE_SAFE); excluded from readonly profile via readOnlyHint=false.
Inputs: team_id (required), assignments (required). Returns: result
admin_batch_add_tenant_capabilitiesAdmin Batch Add Tenant CapabilitiesC
Let a tenant deploy to more tenant organizations.
body requires deployToTenantOrganizationIds (list of tenant organization IDs).
Inputs: body (required), tenant_org_id (required). Returns: result
admin_batch_remove_tenant_capabilitiesAdmin Batch Remove Tenant CapabilitiesADestructive
Stop a tenant deploying to some tenant organizations. Requires confirm=True.
body requires deployToTenantOrganizationIds (list of tenant organization IDs).
Inputs: body (required), tenant_org_id (required), confirm. Returns: result
admin_bulk_assign_team_membersAdmin Bulk Assign Team MembersC
Add multiple members to a team in one call.
Inputs: team_id (required), member_ids (required). Returns: result
admin_bulk_deactivate_membersAdmin Bulk Deactivate MembersADestructive
Deactivate members matching a name pattern (regex on firstName+lastName).
DESTRUCTIVE: requires both dry_run=False AND confirm=True to execute. Default behavior (dry_run=True) reports matches without making changes. Uses ?includeInactive=true to avoid re-deactivating already-inactive members.
Safety:
Always listed in the full profile, but refused at call time unless SIGMA_MCP_ALLOW_BULK_DESTRUCTIVE=1.
Catch-all patterns (e.g. '.*', '.+', '.') are rejected.
Hard cap: refuses if pattern matches more than 10 active members.
Inputs: name_pattern (required), confirm, dry_run. Returns: result
admin_bulk_remove_team_membersAdmin Bulk Remove Team MembersADestructive
Remove multiple members from a team by their email addresses.
Resolves emails to member IDs, then sends a single PATCH to remove all. Requires confirm=True.
An email is removed only when exactly one member's email equals it, ignoring case. An email
that matches no member, or more than one, is listed in not_found and no one is removed
for it; the other emails are still removed. If no email resolves, the call fails with
not_found and nothing is sent.
Safety:
Always listed in the full profile, but refused at call time unless SIGMA_MCP_ALLOW_BULK_DESTRUCTIVE=1.
Hard cap: refuses more than 50 member emails per call.
Inputs: team_id (required), member_emails (required), confirm. Returns: result
admin_change_member_emailAdmin Change Member EmailC
Change a member's email address via PATCH /v2/members/{id}.
Inputs: member_id (required), new_email (required). Returns: result
admin_configure_org_aiAdmin Configure Org AiA
Configure the organization AI provider and models.
Mutating operation. Requires confirm=True. provider_config: Provider specification dict (e.g. provider='openAI'/'anthropic'/'gemini'/'snowflake'/'databricks'/'bedrock'/'azureOpenAI').
Inputs: provider_config (required), confirm. Returns: result
admin_create_account_typeAdmin Create Account TypeC
Create an account type.
body requires name, description and permissions.
Inputs: body (required). Returns: result
admin_create_api_connectorAdmin Create Api ConnectorB
Create an API connector.
body requires name and params and may set description, config and authId.
Inputs: body (required). Returns: result
admin_create_api_credentialAdmin Create Api CredentialA
Create an API credential for API connectors.
body requires name, allowlist and credential, and may set description. The credential holds a secret: pass it only from the user's own input.
Inputs: body (required). Returns: result
admin_create_deploymentAdmin Create DeploymentC
Create a deployment policy.
Inputs: body (required), name (required). Returns: result
admin_create_grantAdmin Create GrantBIdempotent
Create or update a grant. Body must include inodeId, granteeId, permission, type.
Inputs: body (required). Returns: result
admin_create_memberAdmin Create MemberC
Create a new member. member_type: 'admin', 'creator', 'viewer'.
Inputs: email (required), last_name (required), first_name (required), member_type. Returns: result
admin_create_teamAdmin Create TeamC
Create a new team.
Inputs: name (required), description. Returns: result
admin_create_tenantAdmin Create TenantC
Create a tenant organization.
Inputs: name (required), body. Returns: result
admin_create_translationAdmin Create TranslationB
Create the organization translation file for a language code.
body may set translations (key to translated string) and lng_variant.
Inputs: lng (required), body (required). Returns: result
admin_create_user_attributeAdmin Create User AttributeA
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.
Inputs: name (required), description, default_value. Returns: result
admin_deactivate_memberAdmin Deactivate MemberBDestructive
Deactivate a member. Requires confirm=True.
Inputs: member_id (required), confirm. Returns: result
admin_delete_account_typeAdmin Delete Account TypeADestructive
Delete an account type. Requires confirm=True.
Inputs: account_type_id (required), confirm. Returns: result
admin_delete_api_connectorAdmin Delete Api ConnectorADestructive
Delete an API connector. Requires confirm=True.
Inputs: connector_id (required), confirm. Returns: result
admin_delete_api_credentialAdmin Delete Api CredentialADestructive
Delete an API credential. Requires confirm=True. API connectors that use it stop authenticating.
Inputs: credential_id (required), confirm. Returns: result
admin_delete_grantAdmin Delete GrantBDestructive
Delete a grant by ID. Requires confirm=True.
Inputs: grant_id (required), confirm. Returns: result
admin_delete_teamAdmin Delete TeamADestructive
Delete a team. Requires confirm=True.
Inputs: team_id (required), confirm. Returns: result
admin_delete_tenantAdmin Delete TenantADestructive
Delete a tenant organization. Requires confirm=True.
Inputs: tenant_id (required), confirm. Returns: result
admin_delete_translationAdmin Delete TranslationADestructive
Delete the organization translation file for a language code. Requires confirm=True.
Inputs: lng (required), confirm. Returns: result
admin_delete_translation_variantAdmin Delete Translation VariantADestructive
Delete the organization translation file for a language code and variant. Requires confirm=True.
Inputs: lng (required), variant (required), confirm. Returns: result
admin_delete_user_attributeAdmin Delete User AttributeADestructive
Delete a user attribute and every assignment of it. Requires confirm=True.
Inputs: attribute_id (required), confirm. Returns: result
admin_delete_user_attribute_for_teamAdmin Delete User Attribute For TeamBDestructive
Delete a user attribute assignment for a specific team. DESTRUCTIVE. Requires confirm=True.
Inputs: team_id (required), attribute_id (required), confirm. Returns: result
admin_delete_user_attribute_for_tenantAdmin Delete User Attribute For TenantADestructive
Delete a user attribute assignment for a specific tenant. DESTRUCTIVE. Requires confirm=True.
Inputs: attribute_id (required), tenant_org_id (required), confirm. Returns: result
admin_delete_user_attribute_for_userAdmin Delete User Attribute For UserADestructive
Delete a user attribute assignment for a specific user. DESTRUCTIVE. Requires confirm=True.
Inputs: user_id (required), attribute_id (required), confirm. Returns: result
admin_get_api_connectorAdmin Get Api ConnectorARead-only
Get details for an API connector.
Inputs: connector_id (required). Returns: result
admin_get_api_credentialAdmin Get Api CredentialBRead-only
Get an API credential's metadata.
Inputs: credential_id (required). Returns: result
admin_get_current_userAdmin Get Current UserARead-only
Get the current authenticated user's details.
Inputs: no named parameters. Returns: result
admin_get_deploymentAdmin Get DeploymentCRead-only
Get a deployment policy.
Inputs: policy_id (required). Returns: result
admin_get_grantAdmin Get GrantCRead-only
Get a grant by ID.
Inputs: grant_id (required). Returns: result
admin_get_memberAdmin Get MemberCRead-only
Get member details including homeFolderId.
Inputs: member_id (required). Returns: result
admin_get_org_settingAdmin Get Org SettingARead-only
Get organization setting value.
setting_name: One of aiChatHistory, auditLogging, bulkCopy, comments, csvUpload, emailBranding, licenseUpgradeRequests, publicEmbeds, sampleConnections, timezone.
Inputs: setting_name (required). Returns: result
admin_get_teamAdmin Get TeamCRead-only
Get team details.
Inputs: team_id (required). Returns: result
admin_get_tenantAdmin Get TenantCRead-only
Get tenant organization details.
Inputs: tenant_id (required). Returns: result
admin_get_tenant_scoped_infoAdmin Get Tenant Scoped InfoBRead-only
Demonstrate tenant token exchange by calling /whoami through a tenant-scoped client.
Uses RFC 8693 token exchange to obtain a tenant-scoped token, then calls the whoami endpoint to verify the scoped identity.
Inputs: tenant_org_id (required). Returns: result
admin_get_translationAdmin Get TranslationBRead-only
Get the organization translation file for a language code (e.g. 'fr').
Inputs: lng (required). Returns: result
admin_get_translation_variantAdmin Get Translation VariantCRead-only
Get the organization translation file for a language code and variant.
Inputs: lng (required), variant (required). Returns: result
admin_get_user_attributeAdmin Get User AttributeCRead-only
Get a user attribute's definition.
Inputs: attribute_id (required). Returns: result
admin_get_user_attribute_teamsAdmin Get User Attribute TeamsARead-only
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.
Inputs: attribute_id (required). Returns: result
admin_get_user_attribute_tenantsAdmin Get User Attribute TenantsARead-only
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.
Inputs: attribute_id (required). Returns: result
admin_get_user_attribute_usersAdmin Get User Attribute UsersARead-only
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.
Inputs: attribute_id (required). Returns: result
admin_list_account_typesAdmin List Account TypesARead-only
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.
Inputs: no named parameters. Returns: result
admin_list_all_membersAdmin List All MembersARead-only
List ALL members in the organization, automatically following pagination.
Inputs: no named parameters. Returns: result
admin_list_allowed_ipsAdmin List Allowed IpsARead-only
List IP allowlist entries configured for the organization (v3alpha).
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_token resumes from a nextPageToken; page_size is the page size.
Inputs: page_size, page_token. Returns: result
admin_list_all_teamsAdmin List All TeamsARead-only
List ALL teams in the organization, automatically following pagination.
Inputs: no named parameters. Returns: result
admin_list_api_connectorsAdmin List Api ConnectorsARead-only
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.
Inputs: no named parameters. Returns: result
admin_list_api_credentialsAdmin List Api CredentialsARead-only
List the API credentials API connectors use (metadata only).
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.
Inputs: no named parameters. Returns: result
admin_list_deployable_tenantsAdmin List Deployable TenantsARead-only
List the tenant organizations deployments can target.
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.
Inputs: no named parameters. Returns: result
admin_list_deployment_documentsAdmin List Deployment DocumentsARead-only
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.
Inputs: policy_id (required). Returns: result
admin_list_deploymentsAdmin List DeploymentsARead-only
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.
Inputs: no named parameters. Returns: result
admin_list_deployment_tenantsAdmin List Deployment TenantsARead-only
List the tenants a deployment policy deploys to.
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.
Inputs: policy_id (required). Returns: result
admin_list_grantsAdmin List GrantsARead-only
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.
Inputs: inode_id (required). Returns: result
admin_list_membersAdmin List MembersARead-only
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.
Inputs: limit, summary_only. Returns: result
admin_list_member_schedulesAdmin List Member SchedulesARead-only
List the scheduled exports a member owns.
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.
Inputs: member_id (required). Returns: result
admin_list_member_teamsAdmin List Member TeamsBRead-only
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.
Inputs: member_id (required). Returns: result
admin_list_org_workbook_agentsAdmin List Org Workbook AgentsARead-only
List all workbook agents across 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.
page_token resumes from a nextPageToken; page_size is the page size (spec
maximum 100, the default).
Inputs: page_size, page_token. Returns: result
admin_list_recent_webhooksAdmin List Recent WebhooksCRead-only
List recently recorded incoming Sigma webhook events.
read_only_hint: True
Inputs: limit, event_type. Returns: result
admin_list_team_membersAdmin List Team MembersBRead-only
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.
Inputs: team_id (required). Returns: result
admin_list_teamsAdmin List TeamsBRead-only
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.
Inputs: limit, summary_only. Returns: result
admin_list_tenant_deployment_capabilitiesAdmin List Tenant Deployment CapabilitiesCRead-only
List which tenant organizations a tenant can deploy to.
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.
Inputs: tenant_org_id (required). Returns: result
admin_list_tenantsAdmin List TenantsARead-only
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.
Inputs: no named parameters. Returns: result
admin_list_tenants_paginatedAdmin List Tenants PaginatedARead-only
List all tenants, following Sigma's cursor pagination to the last page.
GET /v2/tenants pages with pageSize/pageToken and answers nextPageToken
(not limit/page/nextPage). Returns {"total": N, "tenants": [...]} with every
tenant organization.
Inputs: no named parameters. Returns: result
admin_list_translationsAdmin List TranslationsARead-only
List organization translation files.
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.
Inputs: no named parameters. Returns: result
admin_list_user_attributesAdmin List User AttributesARead-only
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.
Inputs: no named parameters. Returns: result
admin_onboard_memberAdmin Onboard MemberC
Onboard a new member: create account then add to teams.
Inputs: email (required), last_name (required), first_name (required), team_ids, +1 more. Returns: result
admin_remove_allowed_ipsAdmin Remove Allowed IpsADestructive
Delete IP allowlist entries by ID from the organization (v3alpha).
Destructive operation. Requires confirm=True. entry_ids: List of IP allowlist entry ID strings to delete.
Inputs: entry_ids (required), confirm. Returns: result
admin_remove_deployment_documentAdmin Remove Deployment DocumentBDestructive
Remove a document from a deployment policy. Requires confirm=True.
Inputs: inode_id (required), policy_id (required), confirm. Returns: result
admin_remove_deployment_tenantAdmin Remove Deployment TenantBDestructive
Remove a tenant from a deployment policy. Requires confirm=True.
Inputs: policy_id (required), tenant_org_id (required), confirm. Returns: result
admin_reset_org_email_brandingAdmin Reset Org Email BrandingADestructive
Reset the organization email branding settings back to defaults.
Destructive operation. Requires confirm=True.
Inputs: confirm. Returns: result
admin_revoke_member_tokensAdmin Revoke Member TokensADestructive
Revoke a member's OAuth refresh tokens (OIDC single sign-on and warehouse connections). Requires confirm=True.
Sigma can no longer issue new access tokens for the member; the current session and already-issued access tokens last until their normal expiry.
Inputs: member_id (required), confirm. Returns: result
admin_set_user_attribute_for_teamsAdmin Set User Attribute For TeamsBIdempotent
Set a user attribute value for specific teams.
assignments: List of objects, each with 'teamId' (str) and 'value' (str). Example: [{"teamId": "abc123", "value": "US"}]
Inputs: assignments (required), attribute_id (required). Returns: result
admin_set_user_attribute_for_tenantsAdmin Set User Attribute For TenantsBIdempotent
Set a user attribute value for specific tenants.
assignments: List of objects, each with 'tenantOrganizationId' (str) and 'value' (str). Example: [{"tenantOrganizationId": "org123", "value": "US"}]
Inputs: assignments (required), attribute_id (required). Returns: result
admin_set_user_attribute_for_usersAdmin Set User Attribute For UsersCIdempotent
Set a user attribute value for specific users.
assignments: List of objects, each with 'userId' (str) and 'value' (str). Example: [{"userId": "abc123", "value": "US"}]
Inputs: assignments (required), attribute_id (required). Returns: result
admin_update_api_connectorAdmin Update Api ConnectorC
Update an API connector.
body may set name, description, params, config and authId.
Inputs: body (required), connector_id (required). Returns: result
admin_update_api_credentialAdmin Update Api CredentialB
Update an API credential.
body may set name, description, allowlist and credential.
Inputs: body (required), credential_id (required). Returns: result
admin_update_deploymentAdmin Update DeploymentB
Update a deployment policy.
body may set name, nameInTenant, sourceSwapPolicies, copyInputTableData and useDependenciesWorkspace.
Inputs: body (required), policy_id (required). Returns: result
admin_update_memberAdmin Update MemberC
Update member properties (firstName, lastName, memberType, isActive, etc.).
Inputs: body (required), member_id (required). Returns: result
admin_update_org_settingAdmin Update Org SettingA
Update organization setting value.
Mutating operation. Requires confirm=True. setting_name: One of aiChatHistory, auditLogging, bulkCopy, comments, csvUpload, emailBranding, licenseUpgradeRequests, publicEmbeds, sampleConnections, timezone. setting_value: Dict containing setting fields to update.
Inputs: setting_name (required), setting_value (required), confirm. Returns: result
admin_update_teamAdmin Update TeamB
Update a team.
body may set name, description and visibility.
Inputs: body (required), team_id (required). Returns: result
admin_update_team_adminsAdmin Update Team AdminsB
Update team admins (grant or revoke team admin status by memberId).
OpenAPI: PATCH /v2/teams/{teamId}/teamAdmins (teams_updateTeamAdmins). Spec: https://help.sigmacomputing.com/openapi/sigma-rest-api.json Non-destructive write (ANNOTATION_WRITE_SAFE); excluded from readonly profile via readOnlyHint=false.
Inputs: team_id (required), add, remove. Returns: result
admin_update_team_membersAdmin Update Team MembersC
Add or remove members from a team. Provide lists of member IDs.
Inputs: team_id (required), add, remove. Returns: result
admin_update_tenantAdmin Update TenantB
Update a tenant organization.
body may set tenantOrganizationName and tenantOrganizationSlug.
Inputs: body (required), tenant_id (required). Returns: result
admin_update_translationAdmin Update TranslationC
Replace the organization translation file for a language code.
body requires translations.
Inputs: lng (required), body (required). Returns: result
admin_update_translation_variantAdmin Update Translation VariantB
Replace the organization translation file for a language code and variant.
body requires translations.
Inputs: lng (required), body (required), variant (required). Returns: result
admin_update_user_attributeAdmin Update User AttributeB
Update a user attribute's definition.
body may set userAttributeName, description and defaultValue.
Inputs: body (required), attribute_id (required). Returns: result
admin_update_user_attribute_for_teamsAdmin Update User Attribute For TeamsADestructive
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"]
Inputs: team_ids (required), attribute_id (required), confirm. Returns: result
admin_update_user_attribute_for_tenantsAdmin Update User Attribute For TenantsBDestructive
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"]
Inputs: attribute_id (required), tenant_org_ids (required), confirm. Returns: result
admin_update_user_attribute_for_usersAdmin Update User Attribute For UsersADestructive
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.
Inputs: user_ids (required), attribute_id (required), confirm. Returns: result
datasets_add_connection_grantDatasets Add Connection GrantCIdempotent
Add a grant to a connection.
grant_type: 'member' or 'team'. permission: 'annotate' (Can Use & Annotate) or 'usage' (Can Use).
Inputs: grant_type (required), grantee_id (required), permission (required), connection_id (required). Returns: result
datasets_add_connection_path_grantDatasets Add Connection Path GrantA
Add grants to a connection path.
body requires grants: a list of {grantee: {memberId} or {teamId}, permission: 'annotate' | 'usage'}.
Inputs: body (required), connection_path_id (required). Returns: result
datasets_bulk_sync_tenant_connectionsDatasets Bulk Sync Tenant ConnectionsA
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.
Inputs: dry_run. Returns: result
datasets_create_connectionDatasets Create ConnectionA
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.
Inputs: body (required). Returns: result
datasets_create_data_modelDatasets Create Data ModelB
Create a data model from a JSON code representation. Must include name, folderId, schemaVersion, and pages with elements.
Inputs: spec (required). Returns: result
datasets_delete_connectionDatasets Delete ConnectionADestructive
Delete a connection. Requires confirm=True. Workbooks and data models built on it lose their source.
Inputs: connection_id (required), confirm. Returns: result
datasets_delete_connection_grantDatasets Delete Connection GrantADestructive
Delete a grant from a connection. Requires confirm=True. Retrieve grant IDs with datasets_list_connection_grants.
Inputs: grant_id (required), connection_id (required), confirm. Returns: result
datasets_delete_connection_path_grantDatasets Delete Connection Path GrantBDestructive
Delete a grant from a connection path. DESTRUCTIVE. Requires confirm=True.
Inputs: grant_id (required), connection_path_id (required), confirm. Returns: result
datasets_get_connectionDatasets Get ConnectionCRead-only
Get details for a specific connection.
Inputs: connection_id (required). Returns: result
datasets_get_data_modelDatasets Get Data ModelCRead-only
Get data model metadata.
Inputs: data_model_id (required). Returns: result
datasets_get_data_model_materializationDatasets Get Data Model MaterializationCRead-only
Get the status of a data model materialization job.
Inputs: data_model_id (required), materialization_id (required). Returns: result
datasets_get_data_model_specDatasets Get Data Model SpecBRead-only
Get the full code representation (JSON spec) of a data model — tables, columns, metrics, relationships.
Inputs: data_model_id (required). Returns: result
datasets_list_all_data_modelsDatasets List All Data ModelsARead-only
List ALL data models in the organization, automatically following pagination.
Inputs: no named parameters. Returns: result
datasets_list_columns_for_tableDatasets List Columns For TableARead-only
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.
Inputs: table_id (required). Returns: result
datasets_list_connection_grantsDatasets List Connection GrantsARead-only
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.
Inputs: connection_id (required). Returns: result
datasets_list_connection_path_grantsDatasets List Connection Path GrantsARead-only
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.
Inputs: connection_path_id (required). Returns: result
datasets_list_connection_pathsDatasets List Connection PathsARead-only
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.
Inputs: no named parameters. Returns: result
datasets_list_connectionsDatasets List ConnectionsARead-only
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.
Inputs: summary_only. Returns: result
datasets_list_data_model_columnsDatasets List Data Model ColumnsBRead-only
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.
Inputs: data_model_id (required). Returns: result
datasets_list_data_model_elementsDatasets List Data Model ElementsBRead-only
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.
Inputs: data_model_id (required). Returns: result
datasets_list_data_model_lineageDatasets List Data Model LineageBRead-only
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.
Inputs: data_model_id (required). Returns: result
datasets_list_data_model_materialization_schedulesDatasets List Data Model Materialization SchedulesARead-only
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.
Inputs: data_model_id (required). Returns: result
datasets_list_data_modelsDatasets List Data ModelsARead-only
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.
Inputs: limit, summary_only. Returns: result
datasets_list_data_model_sourcesDatasets List Data Model SourcesARead-only
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.
Inputs: data_model_id (required). Returns: result
datasets_list_data_model_tagsDatasets List Data Model TagsARead-only
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.
Inputs: data_model_id (required). Returns: result
datasets_lookup_connection_pathDatasets Lookup Connection PathARead-only
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.
Inputs: path (required), connection_id (required). Returns: result
datasets_materialize_data_modelDatasets Materialize Data ModelA
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.
Inputs: sheet_id (required), data_model_id (required). Returns: result
datasets_swap_data_model_connectionsDatasets Swap Data Model ConnectionsC
Swap data model connections (Beta).
OpenAPI: POST /v2/dataModels/{dataModelId}/swapConnections (dataModels_swapDataModelConnections).
Spec: https://help.sigmacomputing.com/openapi/sigma-rest-api.json
connection_mapping items require fromId and toId; optional swapTables and paths.
Inputs: data_model_id (required), connection_mapping (required), copy_input_table_data. Returns: result
datasets_swap_data_model_source_elementsDatasets Swap Data Model Source ElementsB
Swap data model source elements (Beta).
OpenAPI: POST /v2/dataModels/{dataModelId}/swapSourceElements (dataModels_swapDataModelSourceElements).
Spec: https://help.sigmacomputing.com/openapi/sigma-rest-api.json
source_mapping items require from and to; optional metricMapping and columnMapping.
Inputs: data_model_id (required), source_mapping (required). Returns: result
datasets_swap_data_model_sourcesDatasets Swap Data Model SourcesC
Swap data sources for a data model.
Inputs: body (required), data_model_id (required). Returns: result
datasets_swap_report_sourcesDatasets Swap Report SourcesB
Swap data sources on a report. Use connectionMapping for connection-level swaps, sourceMapping for table-level swaps.
Inputs: report_id (required), source_mapping, connection_mapping. Returns: result
datasets_sync_all_tables_in_schemaDatasets Sync All Tables In SchemaB
Sync all tables in a warehouse schema so they become visible in Sigma.
Inputs: schema (required), database (required), connection_id (required). Returns: result
datasets_sync_connectionDatasets Sync ConnectionB
Force Sigma to re-index a warehouse path. Pass empty list for full sync.
Inputs: connection_id (required), path. Returns: result
datasets_tag_data_modelDatasets Tag Data ModelBIdempotent
Apply a version tag to a data model by tag NAME. The Sigma API takes the tag name here, not its ID.
Inputs: tag_name (required), data_model_id (required). Returns: result
datasets_test_connectionDatasets Test ConnectionC
Test connectivity for a connection.
Inputs: connection_id (required). Returns: result
datasets_update_data_modelDatasets Update Data ModelA
Update an existing data model from a JSON code representation (full replacement via PUT).
Inputs: spec (required), data_model_id (required). Returns: result
elements_create_source_swap_policyElements Create Source Swap PolicyC
Create a source swap policy for automated deployments.
Inputs: body (required). Returns: result
elements_delete_source_swap_policyElements Delete Source Swap PolicyADestructive
Delete a source swap policy (Beta). Requires confirm=True.
Inputs: policy_id (required), confirm. Returns: result
elements_formula_pitfallsElements Formula PitfallsARead-only
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.
Inputs: no named parameters. Returns: result
elements_get_doc_pageElements Get Doc PageARead-only
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
Inputs: page_slug (required). Returns: result
elements_get_element_columnsElements Get Element ColumnsBRead-only
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.
Inputs: element_id (required), workbook_id (required). Returns: result
elements_get_element_queryElements Get Element QueryBRead-only
Get the generated SQL query for a specific element in a workbook.
Inputs: element_id (required), workbook_id (required). Returns: result
elements_get_materialization_jobElements Get Materialization JobCRead-only
Check status of a materialization job.
Inputs: job_id (required), workbook_id (required). Returns: result
elements_get_source_swap_policyElements Get Source Swap PolicyCRead-only
Get a source swap policy.
Inputs: policy_id (required). Returns: result
elements_list_all_input_tablesElements List All Input TablesARead-only
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.
Inputs: no named parameters. Returns: result
elements_list_element_lineageElements List Element LineageBRead-only
List the lineage (upstream sources and dependencies) of one workbook element.
Inputs: element_id (required), workbook_id (required). Returns: result
elements_list_materialization_schedulesElements List Materialization SchedulesBRead-only
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.
Inputs: workbook_id (required). Returns: result
elements_list_source_swap_policiesElements List Source Swap PoliciesARead-only
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.
Inputs: no named parameters. Returns: result
elements_list_workbook_columnsElements List Workbook ColumnsARead-only
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.
Inputs: workbook_id (required). Returns: result
elements_list_workbook_controlsElements List Workbook ControlsARead-only
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.
Inputs: workbook_id (required). Returns: result
elements_list_workbook_elementsElements List Workbook ElementsARead-only
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.
Inputs: workbook_id (required). Returns: result
elements_list_workbook_page_elementsElements List Workbook Page ElementsARead-only
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.
Inputs: page_id (required), workbook_id (required). Returns: result
elements_list_workbook_queriesElements List Workbook QueriesARead-only
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.
Inputs: workbook_id (required). Returns: result
elements_list_workbook_sourcesElements List Workbook SourcesCRead-only
List data sources used by a workbook.
Inputs: workbook_id (required). Returns: result
elements_materialize_and_waitElements Materialize And WaitC
Trigger materialization and poll until complete or timeout.
Inputs: element_id (required), workbook_id (required), timeout_seconds. Returns: result
elements_materialize_elementElements Materialize ElementC
Trigger materialization for a workbook. Pass elementId in body if needed.
Inputs: element_id (required), workbook_id (required). Returns: result
elements_search_docsElements Search DocsARead-only
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
Inputs: query (required). Returns: result
elements_swap_template_sourcesElements Swap Template SourcesA
Swap data sources on a template. Use connectionMapping for connection-level swaps, sourceMapping for table-level swaps.
Inputs: template_id (required), source_mapping, connection_mapping. Returns: result
elements_swap_workbook_connectionsElements Swap Workbook ConnectionsB
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.
Inputs: workbook_id (required), connection_mapping (required), copy_input_table_data. Returns: result
elements_swap_workbook_source_elementsElements Swap Workbook Source ElementsA
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.
Inputs: workbook_id (required), source_mapping (required). Returns: result
elements_swap_workbook_sourcesElements Swap Workbook SourcesB
Swap data sources for a workbook. Use connectionMapping for connection-level swaps, sourceMapping for table-level swaps.
Inputs: workbook_id (required), source_mapping, connection_mapping. Returns: result
elements_update_source_swap_policyElements Update Source Swap PolicyC
Update a source swap policy (Beta).
body may set type, name, fromConnectionId and swaps.
Inputs: body (required), policy_id (required). Returns: result
workbooks_add_workbook_bookmarkWorkbooks Add Workbook BookmarkC
Add a bookmark to a workbook.
Inputs: body (required), workbook_id (required). Returns: result
workbooks_add_workbook_scheduleWorkbooks Add Workbook ScheduleC
Create a scheduled export for a workbook. See Sigma docs for schedule body schema.
Inputs: body (required), workbook_id (required). Returns: result
workbooks_convert_workbook_to_reportWorkbooks Convert Workbook To ReportA
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.
Inputs: name (required), workbook_id (required), destination_folder_id. Returns: result
workbooks_copy_workbook_to_memberWorkbooks Copy Workbook To MemberB
Copy a workbook into a member's My Documents folder.
name: Optional name for the copied workbook. Defaults to the original workbook name.
Inputs: member_id (required), workbook_id (required), name. Returns: result
workbooks_create_reportWorkbooks Create ReportD
Create a report.
Inputs: body (required). Returns: result
workbooks_create_report_grantWorkbooks Create Report GrantB
Grant users or teams permission on a report.
body requires grants: a list of {grantee: {memberId} or {teamId}, permission: 'view' | 'edit'}.
Inputs: body (required), report_id (required). Returns: result
workbooks_create_report_scheduleWorkbooks Create Report ScheduleC
Create a scheduled export for a report.
Inputs: body (required), report_id (required). Returns: result
workbooks_create_workbookWorkbooks Create WorkbookC
Create an empty workbook in a folder.
Inputs: name (required), folder_id (required), description. Returns: result
workbooks_create_workbook_embedWorkbooks Create Workbook EmbedA
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'.
Inputs: workbook_id (required), source_id, embed_type, source_type. Returns: result
workbooks_create_workbook_from_templateWorkbooks Create Workbook From TemplateB
Create a workbook from a template. This brings real visuals — the only programmatic way to get charts/tables.
Inputs: folder_id (required), template_id (required), name. Returns: result
workbooks_delete_report_grantWorkbooks Delete Report GrantADestructive
Delete a grant from a report. Requires confirm=True.
Inputs: grant_id (required), report_id (required), confirm. Returns: result
workbooks_delete_report_scheduleWorkbooks Delete Report ScheduleADestructive
Delete a report's scheduled export. Requires confirm=True.
Inputs: report_id (required), schedule_id (required), confirm. Returns: result
workbooks_delete_workbook_bookmarkWorkbooks Delete Workbook BookmarkADestructive
Delete a saved view (bookmark) from a workbook. Requires confirm=True.
Inputs: bookmark_id (required), workbook_id (required), confirm. Returns: result
workbooks_delete_workbook_embedWorkbooks Delete Workbook EmbedADestructive
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.
Inputs: embed_id (required), workbook_id (required), confirm. Returns: result
workbooks_delete_workbook_grantWorkbooks Delete Workbook GrantADestructive
Delete a grant (a user's or team's permission) from a workbook. Requires confirm=True.
Retrieve grant IDs with workbooks_list_workbook_grants.
Inputs: grant_id (required), workbook_id (required), confirm. Returns: result
workbooks_delete_workbook_scheduleWorkbooks Delete Workbook ScheduleADestructive
Delete a scheduled export. Requires confirm=True.
Inputs: schedule_id (required), workbook_id (required), confirm. Returns: result
workbooks_deploy_template_to_folderWorkbooks Deploy Template To FolderC
Full deployment: instantiate a template into a folder, then optionally swap its sources.
Inputs: name (required), folder_id (required), template_id (required), connection_mapping. Returns: result
workbooks_download_query_exportWorkbooks Download Query ExportARead-only
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).
Inputs: query_id (required), max_bytes. Returns: result
workbooks_duplicate_reportWorkbooks Duplicate ReportC
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).
Inputs: name (required), report_id (required), destination_folder_id (required). Returns: result
workbooks_duplicate_tagged_reportWorkbooks Duplicate Tagged ReportB
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.
Inputs: name (required), tag_name (required), report_id (required), destination_folder_id (required), +1 more. Returns: result
workbooks_duplicate_tagged_workbookWorkbooks Duplicate Tagged WorkbookA
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.
Inputs: name (required), tag_name (required), workbook_id (required), destination_folder_id (required), +2 more. Returns: result
workbooks_duplicate_workbookWorkbooks Duplicate WorkbookA
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.
Inputs: name (required), workbook_id (required), destination_folder_id. Returns: result
workbooks_export_and_downloadWorkbooks Export And DownloadA
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.
Inputs: workbook_id (required), format, layout, max_bytes, +3 more. Returns: result
workbooks_export_reportWorkbooks Export ReportC
Export a report. format: 'pdf', 'png', 'csv', 'xlsx'.
Inputs: report_id (required), format. Returns: result
workbooks_export_workbookWorkbooks Export WorkbookA
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.
Inputs: workbook_id (required), format, layout, element_id. Returns: result
workbooks_get_reportWorkbooks Get ReportCRead-only
Get report metadata.
Inputs: report_id (required). Returns: result
workbooks_get_report_element_queryWorkbooks Get Report Element QueryBRead-only
Get the SQL query Sigma generates for a report element.
Inputs: report_id (required), element_id (required). Returns: result
workbooks_get_report_version_historyWorkbooks Get Report Version HistoryARead-only
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.
Inputs: report_id (required). Returns: result
workbooks_get_templateWorkbooks Get TemplateCRead-only
Get template details.
Inputs: template_id (required). Returns: result
workbooks_get_workbookWorkbooks Get WorkbookCRead-only
Get workbook metadata.
Inputs: workbook_id (required). Returns: result
workbooks_get_workbook_tagsWorkbooks Get Workbook TagsBRead-only
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.
Inputs: workbook_id (required). Returns: result
workbooks_get_workbook_version_historyWorkbooks Get Workbook Version HistoryARead-only
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.
Inputs: workbook_id (required). Returns: result
workbooks_grant_workbook_accessWorkbooks Grant Workbook AccessBIdempotent
Grant access to a workbook. grant_type: 'member' or 'team'. permission: 'view', 'explore', 'edit'.
Inputs: grant_type (required), grantee_id (required), permission (required), workbook_id (required). Returns: result
workbooks_list_all_reportsWorkbooks List All ReportsARead-only
List ALL reports in the organization, automatically following pagination.
Inputs: no named parameters. Returns: result
workbooks_list_all_workbooksWorkbooks List All WorkbooksARead-only
List ALL workbooks in the organization, automatically following pagination.
Inputs: no named parameters. Returns: result
workbooks_list_report_columnsWorkbooks List Report ColumnsARead-only
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.
Inputs: report_id (required). Returns: result
workbooks_list_report_controlsWorkbooks List Report ControlsARead-only
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.
Inputs: report_id (required). Returns: result
workbooks_list_report_elementsWorkbooks List Report ElementsBRead-only
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.
Inputs: report_id (required). Returns: result
workbooks_list_report_lineageWorkbooks List Report LineageARead-only
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.
Inputs: report_id (required). Returns: result
workbooks_list_report_page_elementsWorkbooks List Report Page ElementsARead-only
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.
Inputs: page_id (required), report_id (required). Returns: result
workbooks_list_report_pagesWorkbooks List Report PagesARead-only
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.
Inputs: report_id (required). Returns: result
workbooks_list_report_queriesWorkbooks List Report QueriesARead-only
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.
Inputs: report_id (required). Returns: result
workbooks_list_reportsWorkbooks List ReportsBRead-only
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.
Inputs: limit. Returns: result
workbooks_list_report_schedulesWorkbooks List Report SchedulesARead-only
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.
Inputs: report_id (required). Returns: result
workbooks_list_report_sourcesWorkbooks List Report SourcesCRead-only
List data sources used by a report.
Inputs: report_id (required). Returns: result
workbooks_list_report_tagsWorkbooks List Report TagsARead-only
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.
Inputs: report_id (required). Returns: result
workbooks_list_templatesWorkbooks List TemplatesARead-only
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.
Inputs: limit. Returns: result
workbooks_list_workbook_agentsWorkbooks List Workbook AgentsARead-only
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.
Inputs: workbook_id (required), version_tag_name. Returns: result
workbooks_list_workbook_bookmarksWorkbooks List Workbook BookmarksARead-only
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.
Inputs: workbook_id (required). Returns: result
workbooks_list_workbook_embedsWorkbooks List Workbook EmbedsBRead-only
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.
Inputs: workbook_id (required). Returns: result
workbooks_list_workbook_grantsWorkbooks List Workbook GrantsBRead-only
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.
Inputs: workbook_id (required). Returns: result
workbooks_list_workbook_lineageWorkbooks List Workbook LineageARead-only
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.
Inputs: workbook_id (required). Returns: result
workbooks_list_workbook_pagesWorkbooks List Workbook PagesARead-only
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.
Inputs: workbook_id (required). Returns: result
workbooks_list_workbooksWorkbooks List WorkbooksARead-only
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.
Inputs: limit, summary_only. Returns: result
workbooks_list_workbook_schedulesWorkbooks List Workbook SchedulesARead-only
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.
Inputs: workbook_id (required). Returns: result
workbooks_promote_workbookWorkbooks Promote WorkbookA
Promote a workbook by tagging it (e.g., 'Production'). Creates tag if it doesn't exist.
tag_color: Color for newly created tags. One of: cyan, grass, violet, plum, amber, bronze. Ignored if the tag already exists. Defaults to 'cyan'.
Inputs: tag_name (required), workbook_id (required), tag_color. Returns: result
workbooks_reassign_workbook_ownershipWorkbooks Reassign Workbook OwnershipA
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.
Inputs: new_owner_email (required), old_owner_email (required), dry_run. Returns: result
workbooks_remove_report_tagWorkbooks Remove Report TagADestructive
Remove a version tag from a report. Requires confirm=True. Retrieve tag IDs with workbooks_list_report_tags.
Inputs: tag_id (required), report_id (required), confirm. Returns: result
workbooks_remove_workbook_tagWorkbooks Remove Workbook TagADestructive
Remove a tag from a workbook. Requires confirm=True.
Inputs: tag_id (required), workbook_id (required), confirm. Returns: result
workbooks_restore_workbook_versionWorkbooks Restore Workbook VersionC
Restore a workbook to a previous version.
Inputs: version (required), workbook_id (required). Returns: result
workbooks_run_workbook_agentWorkbooks Run Workbook AgentA
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).
Inputs: agent_id (required), messages (required), workbook_id (required), confirm, +5 more. Returns: result
workbooks_save_template_from_workbookWorkbooks Save Template From WorkbookC
Save a workbook as a reusable template.
Inputs: folder_id (required), workbook_id (required), name. Returns: result
workbooks_send_reportWorkbooks Send ReportA
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.
Inputs: body (required), report_id (required). Returns: result
workbooks_send_workbookWorkbooks Send WorkbookA
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.
Inputs: body (required), workbook_id (required). Returns: result
workbooks_tag_reportWorkbooks Tag ReportAIdempotent
Apply a version tag to a report by tag NAME (e.g. 'Production'). The Sigma API takes the tag name here, not its ID.
Inputs: tag_name (required), report_id (required). Returns: result
workbooks_tag_workbookWorkbooks Tag WorkbookAIdempotent
Apply a version tag to a workbook by tag NAME (e.g. 'Production'). The Sigma API takes the tag name here, not its ID.
Inputs: tag_name (required), workbook_id (required). Returns: result
workbooks_update_report_contentsWorkbooks Update Report ContentsA
Update a report from a code representation (JSON document specification).
Mutating operation. Requires confirm=True and document_version integer to guard against concurrent overwrites.
Inputs: contents (required), report_id (required), document_version (required), confirm. Returns: result
workbooks_update_report_scheduleWorkbooks Update Report ScheduleA
Update a report's scheduled export.
body may set target, schedule, configV2, description and suspensionAction. Retrieve schedule IDs with workbooks_list_report_schedules.
Inputs: body (required), report_id (required), schedule_id (required). Returns: result
workbooks_update_workbook_bookmarkWorkbooks Update Workbook BookmarkA
Update a saved view (bookmark) in a workbook.
body may set name, isShared, isDefault and exploreKey. Retrieve bookmark IDs with workbooks_list_workbook_bookmarks.
Inputs: body (required), bookmark_id (required), workbook_id (required). Returns: result
workbooks_update_workbook_contentsWorkbooks Update Workbook ContentsA
Update a workbook from a code representation (JSON document specification).
Mutating operation. Requires confirm=True and document_version integer to guard against concurrent overwrites.
Inputs: contents (required), workbook_id (required), document_version (required), confirm. Returns: result
workbooks_update_workbook_scheduleWorkbooks Update Workbook ScheduleA
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.
Inputs: body (required), schedule_id (required), workbook_id (required). Returns: result
workbooks_verify_report_specWorkbooks Verify Report SpecARead-only
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.
Inputs: name (required), document (required), folder_id (required), description. Returns: result
workbooks_verify_workbook_specWorkbooks Verify Workbook SpecARead-only
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.
Inputs: name (required), document (required), folder_id (required), description. Returns: result
workspace_create_folderWorkspace Create FolderC
Create a folder.
Inputs: name (required), parent_id (required). Returns: result
workspace_create_tagWorkspace Create TagB
Create a new tag (used for version promotion like 'Production', 'Staging').
color: Tag color, required by the Sigma API. One of: cyan, grass, violet, plum, amber, bronze. Defaults to 'cyan'.
Inputs: name (required), color. Returns: result
workspace_create_workspaceWorkspace Create WorkspaceC
Create a new workspace.
Inputs: name (required). Returns: result
workspace_delete_fileWorkspace Delete FileCDestructive
Delete a file/workbook/data model by its inode ID. Requires confirm=True.
Inputs: inode_id (required), confirm. Returns: result
workspace_delete_tagWorkspace Delete TagBDestructive
Delete a tag. Requires confirm=True.
Inputs: tag_id (required), confirm. Returns: result
workspace_delete_workspaceWorkspace Delete WorkspaceADestructive
Delete a workspace. Requires confirm=True.
Inputs: workspace_id (required), confirm. Returns: result
workspace_delete_workspace_grantWorkspace Delete Workspace GrantBDestructive
Delete a permission grant from a workspace. DESTRUCTIVE. Requires confirm=True.
Inputs: grant_id (required), workspace_id (required), confirm. Returns: result
workspace_favorite_fileWorkspace Favorite FileC
Add a document to a member's favorites.
Inputs: inode_id (required), member_id (required). Returns: result
workspace_get_fileWorkspace Get FileBRead-only
Get a file's details (type, name, path, owner) by its inode ID.
Inputs: inode_id (required). Returns: result
workspace_get_workspaceWorkspace Get WorkspaceCRead-only
Get workspace details.
Inputs: workspace_id (required). Returns: result
workspace_grant_workspace_accessWorkspace Grant Workspace AccessCIdempotent
Grant workspace access.
grant_type: 'member' or 'team'. permission: 'view', 'explore', 'organize' (Contribute), or 'edit' (Manage).
Inputs: grant_type (required), grantee_id (required), permission (required), workspace_id (required). Returns: result
workspace_list_all_filesWorkspace List All FilesARead-only
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'.
Inputs: parent_id, type_filter. Returns: result
workspace_list_favorites_for_memberWorkspace List Favorites For MemberBRead-only
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.
Inputs: member_id (required). Returns: result
workspace_list_filesWorkspace List FilesARead-only
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.
Inputs: parent_id, type_filter. Returns: result
workspace_list_member_filesWorkspace List Member FilesARead-only
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.
Inputs: member_id (required), limit. Returns: result
workspace_list_recent_filesWorkspace List Recent FilesBRead-only
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.
Inputs: member_id (required). Returns: result
workspace_list_tagsWorkspace List TagsARead-only
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.
Inputs: page, limit. Returns: result
workspace_list_workbooks_for_tagWorkspace List Workbooks For TagARead-only
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.
Inputs: tag_id (required). Returns: result
workspace_list_workspace_grantsWorkspace List Workspace GrantsARead-only
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.
Inputs: workspace_id (required), page, limit. Returns: result
workspace_list_workspacesWorkspace List WorkspacesARead-only
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.
Inputs: page, limit. Returns: result
workspace_unfavorite_fileWorkspace Unfavorite FileADestructive
Remove a document from a member's favorites. Requires confirm=True.
Inputs: inode_id (required), member_id (required), confirm. Returns: result
workspace_update_fileWorkspace Update FileC
Update file properties (name, parentId for moving).
Inputs: body (required), inode_id (required). Returns: result
workspace_update_tagWorkspace Update TagB
Update a version tag.
body may set name, description and color.
Inputs: body (required), tag_id (required). Returns: result
workspace_update_workspaceWorkspace Update WorkspaceB
Update (rename) a workspace.
body requires name and may set noDuplicates.
Inputs: body (required), workspace_id (required). Returns: result
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 263 tools
Many near-duplicate tools exist: workbooks_list_workbooks vs workbooks_list_all_workbooks, admin_list_tenants vs admin_list_tenants_paginated, admin_list_members vs admin_list_all_members, and multiple overlapping swap tools (datasets_swap_data_model_sources/connections/source_elements, elements_swap_workbook_sources/connections/source_elements). Worse, admin_update_user_attribute_for_users actually revokes assignments while admin_set_user_attribute_for_users assigns, making the names actively misleading. An agent will frequently misselect among these 263 tools.
Most tools follow a prefix_verb_noun pattern (workbooks_, datasets_, admin_, workspace_, elements_), which is readable. However, the list vs list_all distinction is applied inconsistently across domains, and some tools break the pattern entirely (admin_api_capabilities, elements_formula_pitfalls, admin_get_tenant_scoped_info). The update/revoke naming mismatch adds further inconsistency.
263 tools is far beyond a well-scoped set and creates a huge selection surface. Many tools are redundant variants (paginated vs auto-paginated, summary vs full, multiple swap endpoints), indicating the set should have been consolidated.
Coverage of the Sigma BI domain is extensive: CRUD for workbooks, reports, data models, connections, teams, members, tenants, tags, grants, schedules, embeds, bookmarks, user attributes, translations, and deployments. A few lifecycle operations are only reachable indirectly (e.g., workbook deletion via workspace_delete_file), but overall the surface is broad with few dead ends.
Maintenance
Related MCP Connectors
MCP server for your apps' tools and custom tools, plus hosted AI agents and approval-gated workflows
Build and run AI workflows, agents, data tables and 1000+ API integrations from any MCP client.
MCP server that lets AI assistants use all OneSchema features exposed via the public API.
Unified MCP Server is a remote MCP connector for AI agents and vertical AI products that provides access to 22,000+ authorized SaaS tools across 400+ integrations and 24 categories directly inside LLMs (Claude, GPT, Gemini, Cohere). Tools operate only on explicitly authorized customer connections, enabling agents to safely read and write against live third-party systems.
Related MCP Servers
- AlicenseAqualityBmaintenanceFull-featured MCP server for Apache Superset — 135+ tools for dashboards, charts, datasets, SQL Lab, security (users, roles, RLS, groups), audit, and more. Built-in safety validations.10065MIT
- AlicenseNot gradedqualityDmaintenanceEnterprise-grade MCP server providing 102 production-ready tools for Jira, Confluence, and Bitbucket, enabling AI agents to manage issues, pages, repositories, and more via natural language.MIT
- FlicenseNot gradedqualityDmaintenanceA modular MCP server exposing tools for integrating with services like GitHub, Redash, Jenkins, Figma, Jira, Confluence, Teams, Datadog, PagerDuty, Slack, and Presto, enabling users to manage these platforms through natural language via an MCP client.-
- AlicenseNot gradedqualityDmaintenanceComprehensive MCP server providing 89 tools and 13 React UI apps for complete Zendesk Support API integration, enabling ticket, user, organization, and automation management.MIT