Skip to main content

Dataset resource tools

The MCP tools that create, update, and delete dataset resources: tables, views, unions, and connectors.

Each of the four kinds carries a create, update, and delete tool named for the kind, and every one takes a required spaceId. list-connector-names is the only list tool here. The names of tables, views, unions, and lookups come from list-dataset-names under Query and schema tools, which return every dataset in the catalog without saying which kind each name belongs to.

Tool names and schemas can change at any time

An agent sees each change the next time it reads tools/list, while a script that hard-codes a tool name or schema breaks when that tool changes.

Each section below is one tool as MCP access registers it: its title, its description, the annotations it sets, and the input and output schemas from tools/list. Field paths use parent.child for a nested object, parent[].child for the items of an array, and parent[Value].child for one variant of a field that takes several shapes.

create-table​

Create a table.

Creates a new table, staging the change in a draft changeset.

Creates the resource in the active chat's space.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
querystringRequiredAt most 1000000 characters.
sourceFormatenumOptionalOne of parsed_lines, csv.
deploybooleanRequired
namestringRequired
retentionDaysintegerOptionalMay be null. Greater than 0.
partitioningColumnstringOptionalMay be null. Must not be empty.
sortedByColumnstringOptionalMay be null. Must not be empty.
keyColumnsarray of stringOptional
startsAtstringOptionalJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
maxLatencyenumOptionalOne of MAX_1H, MAX_1D. May be null.
archivedbooleanOptional
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
spaceIdstringRequiredThe ID of the space to target for this operation. Pattern: ^SPC_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
idstringThe ID of the created table.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

update-table​

Update a table.

Updates an existing table, staging the change in a draft changeset.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
querystringOptionalAt most 1000000 characters.
sourceFormatenumOptionalOne of parsed_lines, csv.
deploybooleanOptional
namestringOptional
retentionDaysintegerOptionalMay be null. Greater than 0.
partitioningColumnstringOptionalMay be null. Must not be empty.
sortedByColumnstringOptionalMay be null. Must not be empty.
keyColumnsarray of stringOptional
startsAtstringOptionalJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
maxLatencyenumOptionalOne of MAX_1H, MAX_1D. May be null.
archivedbooleanOptional
baseVersionintegerOptional
spaceIdstringRequiredThe ID of the space to target for this operation. Pattern: ^SPC_[A-Z0-9]{1,7}$.
tableIdstringRequiredThe ID of the table to update. Pattern: ^TBL_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
tableobject
table.idstringPattern: ^TBL_[A-Z0-9]{1,7}$.
table.createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
table.createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
table.updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
table.updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
table.organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
table.spaceIdstringPattern: ^SPC_[A-Z0-9]{1,7}$.
table.deploymentStatusenumOne of UNDEPLOYED, DEPLOYED, FAILED, DEGRADED, DEPLOY_PENDING, DEPLOY_IN_PROGRESS, UPDATE_PENDING, UPDATE_IN_PROGRESS, REFRESH_IN_PROGRESS, ARCHIVED, CLEANUP_PENDING, CLEANUP_IN_PROGRESS.
table.changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
table.querystringAt most 1000000 characters.
table.sourceFormatenumOne of parsed_lines, csv.
table.statusDetailsobject
table.deployboolean
table.tableTypeenumOne of ingest, continuous, static.
table.connectorIdsarray of string
table.connectorIdstringPattern: ^CON_[A-Z0-9]{1,7}$.
table.namestringThe name of the table in schema.name format.
table.archivedbooleanDefaults to false.
table.retentionDaysintegerMay be null. Greater than 0.
table.partitioningColumnstringMay be null. Must not be empty.
table.sortedByColumnstringMay be null. Must not be empty.
table.keyColumnsarray of stringDefaults to [].
table.sortedByColumnsarray of stringDefaults to [].
table.readOnlyboolean
table.isSystemCreatedboolean
table.parserIdstringPattern: ^PRS_[A-Z0-9]{1,7}$.
table.parserNamestring
table.integrationIdstringPattern: ^INT_[A-Z0-9]{1,7}$.
table.detectionIdstringPattern: ^DET_[A-Z0-9]{1,7}$.
table.lookupIdstringPattern: ^LKP_[A-Z0-9]{1,7}$.
table.lookupNamestring
table.createCasebooleanDefaults to false.
table.signalSnapshotNotificationsboolean
table.startsAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
table.maxLatencyenumOne of MAX_1H, MAX_1D, MAX_15M. May be null.
table.lastMaterializedAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
table.schemaIdstringMay be null. Pattern: ^SCH_[A-Z0-9]{1,7}$.
table.fromDatasetsarray of object
table.fromDatasets[].namestring
table.fromDatasets[].resourceNamestring
table.fromDatasets[].resourceIdstring
table.fromDatasets[].spaceIdstringSpace containing the dependency dataset. Pattern: ^SPC_[A-Z0-9]{1,7}$.
table.versionintegerMay be null. Greater than 0.
table.deletedbooleanDefaults to false.
table.changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
table.originKeystringMay be null.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

delete-table​

Delete a table.

Deletes a table, staging the change in a draft changeset.

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
tableIdstringRequiredThe ID of the table to delete. Pattern: ^TBL_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
baseVersionintegerOptional
spaceIdstringRequiredThe ID of the space to target for this operation. Pattern: ^SPC_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

create-view​

Create a view.

Creates a new view, staging the change in a draft changeset.

Creates the resource in the active chat's space.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringRequiredThe name of the view in schema.name format.
querystringRequiredAt most 1000000 characters.
materializedbooleanRequired
maxLatencyenumRequiredOne of MAX_1H, MAX_1D.
deploybooleanRequired
retentionDaysintegerOptionalMay be null. Greater than 0.
sortedByColumnsarray of stringOptional
archivedbooleanOptional
startsAtstringOptionalJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
spaceIdstringRequiredThe ID of the space to target for this operation. Pattern: ^SPC_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
idstringThe ID of the created view.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

update-view​

Update a view.

Updates an existing view, staging the change in a draft changeset.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringOptionalThe name of the view in schema.name format.
querystringOptionalAt most 1000000 characters.
materializedbooleanOptional
maxLatencyenumOptionalOne of MAX_1H, MAX_1D.
deploybooleanOptional
retentionDaysintegerOptionalMay be null. Greater than 0.
sortedByColumnsarray of stringOptional
archivedbooleanOptional
startsAtstringOptionalJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
baseVersionintegerOptional
spaceIdstringRequiredThe ID of the space to target for this operation. Pattern: ^SPC_[A-Z0-9]{1,7}$.
viewIdstringRequiredThe ID of the view to update. Pattern: ^VIE_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
viewobject
view.namestringThe name of the view in schema.name format.
view.createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
view.updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
view.materializedboolean
view.maxLatencyenumOne of MAX_1H, MAX_1D.
view.startsAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
view.deployboolean
view.archivedbooleanDefaults to false.
view.retentionDaysintegerMay be null. Greater than 0.
view.idstringPattern: ^VIE_[A-Z0-9]{1,7}$.
view.organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
view.createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
view.updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
view.querystringAt most 1000000 characters.
view.sortedByColumnsarray of stringDefaults to [].
view.endsAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
view.deploymentStatusenumOne of UNDEPLOYED, DEPLOYED, FAILED, DEGRADED, DEPLOY_PENDING, DEPLOY_IN_PROGRESS, UPDATE_PENDING, UPDATE_IN_PROGRESS, REFRESH_IN_PROGRESS, ARCHIVED, CLEANUP_PENDING, CLEANUP_IN_PROGRESS.
view.changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
view.lastMaterializedAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
view.isSystemCreatedboolean
view.schemaIdstringMay be null. Pattern: ^SCH_[A-Z0-9]{1,7}$.
view.spaceIdstringPattern: ^SPC_[A-Z0-9]{1,7}$.
view.fromDatasetsarray of object
view.fromDatasets[].namestring
view.fromDatasets[].resourceNamestring
view.fromDatasets[].resourceIdstring
view.fromDatasets[].spaceIdstringSpace containing the dependency dataset. Pattern: ^SPC_[A-Z0-9]{1,7}$.
view.detectionstringPattern: ^DET_[A-Z0-9]{1,7}$.
view.integrationstringPattern: ^INT_[A-Z0-9]{1,7}$.
view.lookupstringPattern: ^LKP_[A-Z0-9]{1,7}$.
view.readOnlyboolean
view.versionintegerMay be null. Greater than 0.
view.deletedbooleanDefaults to false.
view.changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
view.originKeystringMay be null.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

delete-view​

Delete a view.

Deletes a view, staging the change in a draft changeset.

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
viewIdstringRequiredThe ID of the view to delete. Pattern: ^VIE_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
baseVersionintegerOptional
spaceIdstringRequiredThe ID of the space to target for this operation. Pattern: ^SPC_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

create-union​

Create a union.

Creates a new union, staging the change in a draft changeset.

Creates the resource in the active chat's space.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringRequired
deploybooleanRequired
fromDatasetsarray of objectRequired
fromDatasets[].resourceNamestringRequiredConstrained by a pattern; see the schema in tools/list.
fromDatasets[].spaceIdstringRequiredSpace containing the dependency dataset. Pattern: ^SPC_[A-Z0-9]{1,7}$.
maxLatencyenumOptionalOne of MAX_1H, MAX_1D.
retentionDaysintegerOptionalMay be null. Greater than 0.
archivedbooleanOptional
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
spaceIdstringRequiredThe ID of the space to target for this operation. Pattern: ^SPC_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
idstringThe ID of the created union.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

update-union​

Update a union.

Updates an existing union, staging the change in a draft changeset.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringOptional
deploybooleanOptional
fromDatasetsarray of objectOptional
fromDatasets[].resourceNamestringRequiredConstrained by a pattern; see the schema in tools/list.
fromDatasets[].spaceIdstringRequiredSpace containing the dependency dataset. Pattern: ^SPC_[A-Z0-9]{1,7}$.
maxLatencyenumOptionalOne of MAX_1H, MAX_1D.
retentionDaysintegerOptionalMay be null. Greater than 0.
archivedbooleanOptional
baseVersionintegerOptional
spaceIdstringRequiredThe ID of the space to target for this operation. Pattern: ^SPC_[A-Z0-9]{1,7}$.
unionIdstringRequiredThe ID of the union to update. Pattern: ^ION_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
unionobject
union.idstringPattern: ^ION_[A-Z0-9]{1,7}$.
union.organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
union.spaceIdstringPattern: ^SPC_[A-Z0-9]{1,7}$.
union.namestringThe name of the union in schema.name format.
union.startsAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
union.endsAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
union.createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
union.createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
union.updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
union.updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
union.materializedboolean
union.maxLatencyenumOne of MAX_1H, MAX_1D.
union.deployboolean
union.deploymentStatusenumOne of UNDEPLOYED, DEPLOYED, FAILED, DEGRADED, DEPLOY_PENDING, DEPLOY_IN_PROGRESS, UPDATE_PENDING, UPDATE_IN_PROGRESS, REFRESH_IN_PROGRESS, ARCHIVED, CLEANUP_PENDING, CLEANUP_IN_PROGRESS.
union.changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
union.lastMaterializedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
union.archivedbooleanDefaults to false.
union.retentionDaysintegerMay be null. Greater than 0.
union.isSystemCreatedboolean
union.readOnlyboolean
union.fromDatasetsarray of object
union.fromDatasets[].namestring
union.fromDatasets[].resourceNamestring
union.fromDatasets[].resourceIdstring
union.fromDatasets[].spaceIdstringSpace containing the dependency dataset. Pattern: ^SPC_[A-Z0-9]{1,7}$.
union.detectionsarray of string
union.versionintegerMay be null. Greater than 0.
union.deletedbooleanDefaults to false.
union.changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
union.originKeystringMay be null.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

delete-union​

Delete a union.

Deletes a union, staging the change in a draft changeset.

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
unionIdstringRequiredThe ID of the union to delete. Pattern: ^ION_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
baseVersionintegerOptional
spaceIdstringRequiredThe ID of the space to target for this operation. Pattern: ^SPC_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

create-connector​

Create a connector.

Creates a new connector, staging the change in a draft changeset.

Creates the resource in the active chat's space.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringRequired
deploybooleanRequired
typeenumRequiredOne of ObjectStorageConnector, ApiPollingConnector, StreamingConnector, HttpSourceConnector.
configobject (four variants)Required
config[ObjectStorageConnector].typestringRequiredAlways ObjectStorageConnector.
config[ObjectStorageConnector].initialLookbackDaysintegerOptionalGreater than 0. Defaults to 14.
config[ObjectStorageConnector].scanIntervalMinutesintegerOptionalMinimum 5.
config[ObjectStorageConnector].bucketstringRequiredConstrained by a pattern; see the schema in tools/list. At most 63 characters.
config[ObjectStorageConnector].prefixstringRequired
config[ObjectStorageConnector].regionstringOptionalDefaults to not-used.
config[ObjectStorageConnector].manageBucketNotificationsbooleanOptional
config[ObjectStorageConnector].objectStoreobjectRequired
config[ObjectStorageConnector].objectStore.authobjectRequiredNested fields omitted; see the schema in tools/list.
config[ApiPollingConnector].typestringRequiredAlways ApiPollingConnector.
config[ApiPollingConnector].connectorKindstringRequiredCatalog connector kind (e.g. "google-workspace", "gcp-pubsub") or "custom" for a customer ECR image. Must not be empty.
config[ApiPollingConnector].credentialIdsmap of stringOptional
config[ApiPollingConnector].intervalMinutesintegerRequiredMinimum 1.
config[ApiPollingConnector].initialLookbackDaysintegerOptionalGreater than 0.
config[ApiPollingConnector].settingsobjectRequired
config[ApiPollingConnector].ecrImageUrlstringOptionalECR image URL for a custom connector Lambda container. Must not be empty.
config[StreamingConnector].typestringRequiredAlways StreamingConnector.
config[StreamingConnector].connectorKindstringRequiredCatalog connector kind (e.g. "google-workspace", "gcp-pubsub") or "custom" for a customer ECR image. Must not be empty.
config[StreamingConnector].credentialIdsmap of stringOptional
config[StreamingConnector].settingsobjectRequired
config[StreamingConnector].ecrImageUrlstringOptionalECR image URL for a custom connector Lambda container. Must not be empty.
config[HttpSourceConnector].typestringRequiredAlways HttpSourceConnector.
config[HttpSourceConnector].authModeenumRequiredOne of bearer, presigned, hmac.
config[HttpSourceConnector].credentialIdstringOptionalPattern: ^CRD_[A-Z0-9]{1,7}$.
datasetKindenumOptionalOne of event, state.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
spaceIdstringRequiredThe ID of the space to target for this operation. Pattern: ^SPC_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
idstringThe ID of the created connector.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

update-connector​

Update a connector.

Updates an existing connector, staging the change in a draft changeset.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringOptional
deploybooleanOptional
typeenumOptionalOne of ObjectStorageConnector, ApiPollingConnector, StreamingConnector, HttpSourceConnector.
configobject (four variants)Optional
config[ObjectStorageConnector].typestringRequiredAlways ObjectStorageConnector.
config[ObjectStorageConnector].initialLookbackDaysintegerOptionalGreater than 0. Defaults to 14.
config[ObjectStorageConnector].scanIntervalMinutesintegerOptionalMinimum 5.
config[ObjectStorageConnector].bucketstringRequiredConstrained by a pattern; see the schema in tools/list. At most 63 characters.
config[ObjectStorageConnector].prefixstringRequired
config[ObjectStorageConnector].regionstringOptionalDefaults to not-used.
config[ObjectStorageConnector].manageBucketNotificationsbooleanOptional
config[ObjectStorageConnector].objectStoreobjectRequired
config[ObjectStorageConnector].objectStore.authobjectRequiredNested fields omitted; see the schema in tools/list.
config[ApiPollingConnector].typestringRequiredAlways ApiPollingConnector.
config[ApiPollingConnector].connectorKindstringRequiredCatalog connector kind (e.g. "google-workspace", "gcp-pubsub") or "custom" for a customer ECR image. Must not be empty.
config[ApiPollingConnector].credentialIdsmap of stringOptional
config[ApiPollingConnector].intervalMinutesintegerRequiredMinimum 1.
config[ApiPollingConnector].initialLookbackDaysintegerOptionalGreater than 0.
config[ApiPollingConnector].settingsobjectRequired
config[ApiPollingConnector].ecrImageUrlstringOptionalECR image URL for a custom connector Lambda container. Must not be empty.
config[StreamingConnector].typestringRequiredAlways StreamingConnector.
config[StreamingConnector].connectorKindstringRequiredCatalog connector kind (e.g. "google-workspace", "gcp-pubsub") or "custom" for a customer ECR image. Must not be empty.
config[StreamingConnector].credentialIdsmap of stringOptional
config[StreamingConnector].settingsobjectRequired
config[StreamingConnector].ecrImageUrlstringOptionalECR image URL for a custom connector Lambda container. Must not be empty.
config[HttpSourceConnector].typestringRequiredAlways HttpSourceConnector.
config[HttpSourceConnector].authModeenumRequiredOne of bearer, presigned, hmac.
config[HttpSourceConnector].credentialIdstringOptionalPattern: ^CRD_[A-Z0-9]{1,7}$.
datasetKindenumOptionalOne of event, state.
baseVersionintegerOptional
spaceIdstringRequiredThe ID of the space to target for this operation. Pattern: ^SPC_[A-Z0-9]{1,7}$.
connectorIdstringRequiredThe ID of the connector to update. Pattern: ^CON_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
connectorobject
connector.namestringThe name of the connector in schema.name format.
connector.typeenumOne of ObjectStorageConnector, ApiPollingConnector, StreamingConnector, HttpSourceConnector.
connector.datasetKindenumOne of event, state.
connector.deploymentStatusenumOne of UNDEPLOYED, DEPLOYED, FAILED, DEGRADED, DEPLOY_PENDING, DEPLOY_IN_PROGRESS, UPDATE_PENDING, UPDATE_IN_PROGRESS, REFRESH_IN_PROGRESS, ARCHIVED, CLEANUP_PENDING, CLEANUP_IN_PROGRESS.
connector.idstringPattern: ^CON_[A-Z0-9]{1,7}$.
connector.createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
connector.createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
connector.updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
connector.updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
connector.deployboolean
connector.organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
connector.spaceIdstringPattern: ^SPC_[A-Z0-9]{1,7}$.
connector.configobject (four variants)
connector.config[ObjectStorageConnector].typestringAlways ObjectStorageConnector.
connector.config[ObjectStorageConnector].initialLookbackDaysintegerGreater than 0. Defaults to 14.
connector.config[ObjectStorageConnector].scanIntervalMinutesintegerMinimum 5.
connector.config[ObjectStorageConnector].bucketstringConstrained by a pattern; see the schema in tools/list. At most 63 characters.
connector.config[ObjectStorageConnector].prefixstring
connector.config[ObjectStorageConnector].regionstringDefaults to not-used.
connector.config[ObjectStorageConnector].manageBucketNotificationsboolean
connector.config[ObjectStorageConnector].objectStoreobjectNested fields omitted; see the schema in tools/list.
connector.config[ApiPollingConnector].typestringAlways ApiPollingConnector.
connector.config[ApiPollingConnector].connectorKindstringCatalog connector kind (e.g. "google-workspace", "gcp-pubsub") or "custom" for a customer ECR image. Must not be empty.
connector.config[ApiPollingConnector].credentialIdsmap of string
connector.config[ApiPollingConnector].intervalMinutesintegerMinimum 1.
connector.config[ApiPollingConnector].initialLookbackDaysintegerGreater than 0.
connector.config[ApiPollingConnector].settingsobject
connector.config[ApiPollingConnector].ecrImageUrlstringECR image URL for a custom connector Lambda container. Must not be empty.
connector.config[StreamingConnector].typestringAlways StreamingConnector.
connector.config[StreamingConnector].connectorKindstringCatalog connector kind (e.g. "google-workspace", "gcp-pubsub") or "custom" for a customer ECR image. Must not be empty.
connector.config[StreamingConnector].credentialIdsmap of string
connector.config[StreamingConnector].settingsobject
connector.config[StreamingConnector].ecrImageUrlstringECR image URL for a custom connector Lambda container. Must not be empty.
connector.config[HttpSourceConnector].typestringAlways HttpSourceConnector.
connector.config[HttpSourceConnector].authModeenumOne of bearer, presigned, hmac.
connector.config[HttpSourceConnector].credentialIdstringPattern: ^CRD_[A-Z0-9]{1,7}$.
connector.readOnlyboolean
connector.isSystemCreatedboolean
connector.runStatusobject (two variants)
connector.runStatus[variant 1].lastRunobjectMay be null. Nested fields omitted; see the schema in tools/list.
connector.runStatus[variant 1].activeRunobjectMay be null. Nested fields omitted; see the schema in tools/list.
connector.runStatus[variant 1].currentLagnumberMay be null.
connector.runStatus[variant 1].lagUnitenumOne of milliseconds, messages. May be null.
connector.runStatus[variant 2].lastRunobjectMay be null. Nested fields omitted; see the schema in tools/list.
connector.runStatus[variant 2].activeRunobjectMay be null. Nested fields omitted; see the schema in tools/list.
connector.manifestCoverageobject
connector.manifestCoverage.fromstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
connector.manifestCoverage.tostringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
connector.manifestCoverage.completeboolean
connector.versionintegerMay be null. Greater than 0.
connector.deletedbooleanDefaults to false.
connector.changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
connector.changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
connector.originKeystringMay be null.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

delete-connector​

Delete a connector.

Deletes a connector, staging the change in a draft changeset.

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
connectorIdstringRequiredThe ID of the connector to delete. Pattern: ^CON_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
baseVersionintegerOptional
spaceIdstringRequiredThe ID of the space to target for this operation. Pattern: ^SPC_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

list-connector-names​

List connector names.

Lists the names of all connectors in the catalog.

Annotations: readOnlyHint true, idempotentHint true.

Inputs​

This tool takes no arguments.

Outputs​

FieldTypeDescription
connectorNamesarray of string
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.