workspaces operations
MCP tools and operation permissions for workspaces.
Generated from the shared operation catalog. Use the JSON catalog for complete input schemas. Required dependency checks can be stricter than the resource permission listed below.
dashboard_promotion_review
Review copying a dashboard and all captured dependencies into an existing writable local project in the same organization. Explicitly map every source, event dataset and notification channel. Reads saved metadata and previously captured schema evidence only; never queries data, publishes, copies credentials or activates schedules. Returns blockers and a fingerprint for a subsequent explicit draft copy. Native SQL, HTTP effects and unresolved parameter pickers currently block copying.
- HTTP:
POST /api/workspaces/:id/promotion/review - SDK:
client.workspaces.promotionReview(input) - Access: workspace; workspace / admin
- Effect annotation: Read-only
| Input | Requirement | Description |
|---|---|---|
version | Required | integer |
destinationProjectId | Required | string |
mappings | Required | object |
expectedFingerprint | Optional | string |
id | Required | string |
dashboard_promotion_apply
Explicitly copy a reviewed dashboard dependency graph into new unpublished drafts. Requires the exact review fingerprint, explicit mappings and a unique requestKey for this intent; reuse it after an uncertain transport retry. Atomically rechecks current authority, revisions, target connections and schema evidence. Never copies credentials, mutates source databases, runs workflows, publishes or starts schedules. Returns new draft IDs; copied workflows require separate review and publication.
- HTTP:
POST /api/workspaces/:id/promotion/apply - SDK:
client.workspaces.promotionApply(input) - Access: workspace; workspace / admin
- Effect annotation: May change state or run effects
| Input | Requirement | Description |
|---|---|---|
version | Required | integer |
destinationProjectId | Required | string |
mappings | Required | object |
expectedFingerprint | Required | string |
requestKey | Required | string |
id | Required | string |
app_workspace_list
List dynamic dashboard containers (compatibility workspace namespace), filtered by member and token access. The product library is dashboard_list.
- HTTP:
GET /api/workspaces - SDK:
client.workspaces.list(input) - Access: workspace; workspace / list
- Effect annotation: Read-only
| Input | Requirement | Description |
|---|---|---|
projectId | Optional | string |
app_workspace_get
Read the workspace home, accessible component destinations, tags, collection and publication status. Views are opened by components, not automatic navigation tabs. Does not run queries or actions.
- HTTP:
GET /api/workspaces/:id - SDK:
client.workspaces.get(input) - Access: workspace; workspace / list
- Effect annotation: Read-only
| Input | Requirement | Description |
|---|---|---|
id | Required | string |
app_workspace_create
Create an operational workspace inside the current organization. Optionally name a firstPage to create its empty dashboard in the same transaction. Existing dashboards are attached explicitly. Does not create a new team.
- HTTP:
POST /api/workspaces - SDK:
client.workspaces.create(input) - Access: workspace; workspace / write
- Effect annotation: May change state or run effects
| Input | Requirement | Description |
|---|---|---|
definition | Required | See schema |
projectId | Optional | See schema |
firstPage | Optional | string |
app_workspace_update
Save workspace navigation, tags, collection and page interaction bindings with optimistic version checks. Live operators keep using the published version until Publish.
- HTTP:
PATCH /api/workspaces/:id - SDK:
client.workspaces.update(input) - Access: workspace; workspace / write
- Effect annotation: May change state or run effects
| Input | Requirement | Description |
|---|---|---|
definition | Required | See schema |
version | Required | integer |
id | Required | string |
app_workspace_remove
Remove a workspace and stop its published runtime. Its dashboards remain in the dashboard library.
- HTTP:
DELETE /api/workspaces/:id - SDK:
client.workspaces.remove(input) - Access: workspace; workspace / admin
- Effect annotation: May change state or run effects; destructive operation
| Input | Requirement | Description |
|---|---|---|
id | Required | string |
app_workspace_publish
Validate and publish the workspace pages with immutable query, chart, panel and action bindings. Requires authority over every approved dependency. Publication itself never runs a database query or action.
- HTTP:
POST /api/workspaces/:id/publish - SDK:
client.workspaces.publish(input) - Access: workspace; workspace / admin
- Effect annotation: May change state or run effects; destructive operation
| Input | Requirement | Description |
|---|---|---|
version | Required | integer |
id | Required | string |
app_workspace_unpublish
Stop the published workspace runtime while preserving its draft and dashboard pages.
- HTTP:
POST /api/workspaces/:id/unpublish - SDK:
client.workspaces.unpublish(input) - Access: workspace; workspace / admin
- Effect annotation: May change state or run effects; destructive operation
| Input | Requirement | Description |
|---|---|---|
id | Required | string |
app_workspace_page_create
Create an empty dashboard-backed view in a workspace. Bind its pageId to a button, record selection or chart interaction. The first view becomes home. Supply a stable requestKey for retry safety: the same actor, workspace and title recover the original destination even with an older version; a different title conflicts. A removed destination is never recreated by replay. Version still guards a first creation.
- HTTP:
POST /api/workspaces/:id/pages - SDK:
client.workspaces.createPage(input) - Access: workspace; workspace / write
- Effect annotation: May change state or run effects
| Input | Requirement | Description |
|---|---|---|
title | Required | string |
version | Required | integer |
requestKey | Optional | string |
id | Required | string |
app_workspace_page_creation_get
Check this actor’s page-creation request without creating a destination. Returns the current workspace and the original pageId, or null if no creation committed. Requires current workspace Write access; moved or removed results conflict. Use this to reconcile a lost creation response before saving newer parent edits.
- HTTP:
GET /api/workspaces/:id/page-creations/:requestKey - SDK:
client.workspaces.pageCreation(input) - Access: workspace; workspace / write
- Effect annotation: Read-only
| Input | Requirement | Description |
|---|---|---|
id | Required | string |
requestKey | Required | string |
app_workspace_page_attach
Place an existing dashboard under this workspace. Requires dashboard Admin. A dashboard has one workspace parent; its page permissions inherit from that parent.
- HTTP:
POST /api/workspaces/:id/attach-page - SDK:
client.workspaces.attachPage(input) - Access: workspace; workspace / admin
- Effect annotation: May change state or run effects; destructive operation
| Input | Requirement | Description |
|---|---|---|
dashboardId | Required | string |
version | Required | integer |
id | Required | string |
app_workspace_page_get
Open component configuration without executing data. Draft mode requires page Write. Preview mode returns previewVersion and uses the caller’s own dependency permissions for execution. Published mode returns publicationId and the approved bindings.
- HTTP:
GET /api/workspaces/:id/pages/:pageId - SDK:
client.workspaces.page(input) - Access: workspace; dashboard / read
- Effect annotation: Read-only
| Input | Requirement | Description |
|---|---|---|
mode | Optional | See schema |
id | Required | string |
pageId | Required | string |
app_workspace_page_update
Edit a workspace page with the normal dashboard layout, descriptions and parameters. Changes remain draft until the workspace is published.
- HTTP:
PATCH /api/workspaces/:id/pages/:pageId - SDK:
client.workspaces.updatePage(input) - Access: workspace; dashboard / write
- Effect annotation: May change state or run effects
| Input | Requirement | Description |
|---|---|---|
title | Optional | string |
folderId | Optional | See schema |
description | Optional | string |
layout | Optional | array |
params | Optional | object |
id | Required | string |
pageId | Required | string |
app_workspace_page_arrange
Move, resize, rename or remove existing cards while viewing a dashboard. Send the last acknowledged visible layout as base and its publicationId or previewVersion. Saves presentation immediately without publishing draft queries, forms or actions. Adding or rebinding components uses the draft editor. Never executes data.
- HTTP:
PATCH /api/workspaces/:id/pages/:pageId/layout - SDK:
client.workspaces.arrangePage(input) - Access: workspace; dashboard / write
- Effect annotation: May change state or run effects
See the JSON schema for this input contract.
app_workspace_page_data
Read a chart query or panel dataset using declared page parameters. Pass publicationId for approved published data, or previewVersion for an unpublished preview under your own query/source permissions. No SQL text is accepted.
- HTTP:
POST /api/workspaces/:id/pages/:pageId/data - SDK:
client.workspaces.data(input) - Access: workspace; dashboard / read
- Effect annotation: Read-only
See the JSON schema for this input contract.
app_workspace_page_submit
Explicitly submit a component workflow from a page form, button or table/list/chart selection. Supply actionId only for a named selection menu action. Pass publicationId for approved bindings, or previewVersion for your own current workflow/source/data permissions. Requires page Run; the server resolves saved bindings, verified actor and the reviewed workflow revision. Reuse requestKey only for the same intent. Never submit on load or refresh.
- HTTP:
POST /api/workspaces/:id/pages/:pageId/submit - SDK:
client.workspaces.submit(input) - Access: workspace; dashboard / run
- Effect annotation: May change state or run effects
See the JSON schema for this input contract.
app_workspace_page_interact
Explicitly run a chart or table selection workflow saved on a dashboard visual. Supply visualId, selected scalar values, requestKey, and publicationId or previewVersion; omit actionId for its primary action or choose a declared menu ID. The server resolves saved bindings, verified actor and the reviewed workflow revision. Browser input cannot select a different workflow or supply action configuration. Reusing requestKey after a transport interruption avoids duplicate effects. Never run on render, hover or refresh.
- HTTP:
POST /api/workspaces/:id/pages/:pageId/interact - SDK:
client.workspaces.interact(input) - Access: workspace; dashboard / run
- Effect annotation: May change state or run effects
See the JSON schema for this input contract.
app_workspace_members_list
Read members and page access for an authorized dynamic dashboard workspace. Requires workspace Admin; does not change roles or grants.
- HTTP:
GET /api/workspaces/:id/members - SDK:
client.workspaces.members(input) - Access: workspace; workspace / admin
- Effect annotation: Read-only; destructive operation
| Input | Requirement | Description |
|---|---|---|
id | Required | string |