actions operations
MCP tools and operation permissions for actions.
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.
action_destinations
List saved notification channel names and readiness for workflow notification steps. Does not reveal credentials or send anything.
- HTTP:
GET /api/actions/destinations - SDK:
client.actions.destinations(input) - Access: workspace; action / read
- Effect annotation: Read-only
See the JSON schema for this input contract.
action_store_http_credential
Encrypt HTTP authentication headers for one saved action and one exact URL origin. Returns a credentialId for the HTTP step; never returns the saved secret or calls the endpoint.
- HTTP:
POST /api/actions/:id/http-credentials - SDK:
client.actions.storeHttpCredential(input) - Access: workspace; action / write
- Effect annotation: May change state or run effects
| Input | Requirement | Description |
|---|---|---|
origin | Required | string |
headers | Required | object |
id | Required | string |
action_catalog
Read composable workflow nodes, ports and effects: saved queries, parameterized SQL/native queries, HTTP requests, record filtering, rules, mapping, notifications and native insert/update operations. No effects run while editing.
- HTTP:
GET /api/actions/catalog - SDK:
client.actions.catalog(input) - Access: workspace; action / read
- Effect annotation: Read-only
See the JSON schema for this input contract.
action_list
List authorized action definitions and their published revisions.
- HTTP:
GET /api/actions - SDK:
client.actions.list(input) - Access: workspace; action / read
- Effect annotation: Read-only
| Input | Requirement | Description |
|---|---|---|
projectId | Optional | string |
action_get
Read an action draft and validation issues. Draft editing never executes data operations.
- HTTP:
GET /api/actions/:id - SDK:
client.actions.get(input) - Access: workspace; action / read
- Effect annotation: Read-only
| Input | Requirement | Description |
|---|---|---|
id | Required | string |
action_inputs
Read the input contract and current revision of a published action. No execution.
- HTTP:
GET /api/actions/:id/inputs - SDK:
client.actions.describe(input) - Access: workspace; action / run
- Effect annotation: Read-only
| Input | Requirement | Description |
|---|---|---|
revision | Optional | integer |
id | Required | string |
action_create
Save an action draft using the action catalog and explicit field bindings. Does not publish or execute it.
- HTTP:
POST /api/actions - SDK:
client.actions.create(input) - Access: workspace; action / write
- Effect annotation: May change state or run effects
| Input | Requirement | Description |
|---|---|---|
definition | Required | See schema |
projectId | Optional | See schema |
action_update
Save a draft at its current version. Published behavior stays unchanged until published again.
- HTTP:
PATCH /api/actions/:id - SDK:
client.actions.update(input) - Access: workspace; action / write
- Effect annotation: May change state or run effects
| Input | Requirement | Description |
|---|---|---|
definition | Required | See schema |
version | Required | integer |
id | Required | string |
action_publish
Validate and publish a reviewed action revision, snapshotting its referenced queries. Checks source and record-write permissions and table metadata; does not execute the action.
- HTTP:
POST /api/actions/:id/publish - SDK:
client.actions.publish(input) - Access: workspace; action / admin
- Effect annotation: May change state or run effects; destructive operation
| Input | Requirement | Description |
|---|---|---|
version | Required | integer |
id | Required | string |
action_remove
Remove an action definition. Its audit run records are retained.
- HTTP:
DELETE /api/actions/:id - SDK:
client.actions.remove(input) - Access: workspace; action / admin
- Effect annotation: May change state or run effects; destructive operation
| Input | Requirement | Description |
|---|---|---|
id | Required | string |
action_target
Inspect writable columns, defaults, generated fields and primary key of an actual database table. This reads metadata only; PostgreSQL currently supports transactional actions.
- HTTP:
POST /api/actions/target - SDK:
client.actions.target(input) - Access: workspace; source / read
- Effect annotation: Read-only
| Input | Requirement | Description |
|---|---|---|
sourceId | Required | string |
schema | Required | string |
table | Required | string |
action_run
Explicitly execute a published workflow. Database-only flows use one transaction; flows with HTTP or notification steps commit each database step separately. Supply its revision and a unique requestKey; reuse that key after a transport interruption without repeating effects. Requires action Run and access to every referenced source/query; writes require data Write. Automatic execution belongs to an explicitly enabled schedule, never mount, reconnect or refresh.
- HTTP:
POST /api/actions/:id/run - SDK:
client.actions.run(input) - Access: workspace; action / run
- Effect annotation: May change state or run effects
| Input | Requirement | Description |
|---|---|---|
revision | Required | integer |
requestKey | Required | string |
inputs | Required | object |
id | Required | string |
action_runs
Read recent action outcomes and step timings. Includes no input values or returned database records.
- HTTP:
GET /api/actions/:id/runs - SDK:
client.actions.runs(input) - Access: workspace; action / read
- Effect annotation: Read-only
| Input | Requirement | Description |
|---|---|---|
id | Required | string |