Skip to main content
Glama
RawTree MCP Server

RawTree MCP Server

Official
by rawtreedb

Update Workflow

update-workflow
Destructive

Modify only the supplied fields of an existing workflow; omitted fields stay unchanged. Pause or resume schedules, change cron cadence, or replace delivery sinks as needed.

Instructions

Update only supplied fields of an existing workflow; at least one changed field is required. Omitted fields remain unchanged. Set schedule.enabled=false to pause or schedule.enabled=true to resume; set schedule.cron to change the cadence. Supplying sinks replaces the whole list and may remove delivery targets. Read get-workflow before editing sinks so you can preserve their IDs. Already buffered deliveries can continue after pausing. Returns the workflow object: id, name, description, query, schedule, revision, created_at, updated_at, and sinks. The query object contains database and sql. schedule is null for manual-only workflows; otherwise it contains cron, enabled, and next_run_at (null while paused). Each sink has id, type, and settings. HTTP settings contain url (null when unreadable), url_configured, and header_names; header values are never returned. Table settings contain database and table. Slack settings contain integration_id, channel_id, and channel_name, resolved from Slack when the sink was saved. Requires an admin API key bound to the selected organization and cluster, or OAuth. Organization members may read; organization admins may create, update, or delete. Workflows execute with organization credentials and continue after the creating key is revoked or expires.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "organization": "<organization>",
      "cluster": "<cluster>",
      "id": "<id>"
    },
    "name": "update-workflow"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesWorkflow ID returned by list-workflows, get-workflow, or create-workflow.
nameNo
queryNoOmit to preserve the query. Omitted database or sql fields retain their saved values.
sinksNoReplaces the entire list. Omit to preserve it; [] removes all. Preserve IDs when editing. Existing HTTP sinks may omit settings, settings.url, or settings.headers to retain them; table and Slack sinks always require settings. To keep an existing Slack sink unchanged without a Slack lookup, send back its saved integration_id and channel_id, not channel_name. Within a supplied settings.headers map, null preserves a stored value; omitted header names are removed.
clusterYesRawTree cluster to use for this operation.
scheduleNoOmit to preserve the schedule; null makes the workflow manual-only. Omitted cron or enabled keep their saved values. cron is required when scheduling a manual-only workflow.
descriptionNoOmit to preserve the description; null or blank clears it.
organizationYesRawTree organization containing the target cluster.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.4.3
    • changedInput schema / properties / sinks / description
      Previous value: -"Replaces the entire list. Omit to preserve it; [] removes all. Preserve IDs when editing. Existing HTTP sinks may omit settings, settings.url, or settings.headers to retain them. Within a supplied settings.headers map, null preserves a stored value; omitted header names are removed."New value: +"Replaces the entire list. Omit to preserve it; [] removes all. Preserve IDs when editing. Existing HTTP sinks may omit settings, settings.url, or settings.headers to retain them; table and Slack sinks always require settings. To keep an existing Slack sink unchanged without a Slack lookup, send back its saved integration_id and channel_id, not channel_name. Within a supplied settings.headers map, null preserves a stored value; omitted header names are removed."
    • changedInput schema / properties / sinks / items / anyOf
      Previous value: -[
      -  {
      -    "oneOf": [
      -      {
      -        "additionalProperties": false,
      -        "properties": {
      -          "settings": {
      -            "additionalProperties": false,
      -            "properties": {
      -              "headers": {
      -                "additionalProperties": {
      -                  "type": "string"
      -                },
      -                "propertyNames": {
      -                  "type": "string"
      -                },
      -                "type": "object"
      -              },
      -              "url": {
      -                "description": "Write-only sink URL. The API validates allowed origins.",
      -                "format": "uri",
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "url"
      -            ],
      -            "type": "object"
      -          },
      -          "type": {
      -            "const": "http",
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "type",
      -          "settings"
      -        ],
      -        "type": "object"
      -      },
      -      {
      -        "additionalProperties": false,
      -        "properties": {
      -          "settings": {
      -            "additionalProperties": false,
      -            "properties": {
      -              "database": {
      -                "pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$",
      -                "type": "string"
      -              },
      -              "table": {
      -                "pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$",
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "database",
      -              "table"
      -            ],
      -            "type": "object"
      -          },
      -          "type": {
      -            "const": "table",
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "type",
      -          "settings"
      -        ],
      -        "type": "object"
      -      }
      -    ]
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "id": {
      -        "format": "uuid",
      -        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      -        "type": "string"
      -      },
      -      "settings": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "headers": {
      -            "additionalProperties": {
      -              "anyOf": [
      -                {
      -                  "type": "string"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ]
      -            },
      -            "propertyNames": {
      -              "type": "string"
      -            },
      -            "type": "object"
      -          },
      -          "url": {
      -            "description": "Write-only sink URL. The API validates allowed origins.",
      -            "format": "uri",
      -            "type": "string"
      -          }
      -        },
      -        "type": "object"
      -      },
      -      "type": {
      -        "const": "http",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "id"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "id": {
      -        "format": "uuid",
      -        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      -        "type": "string"
      -      },
      -      "settings": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "database": {
      -            "pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$",
      -            "type": "string"
      -          },
      -          "table": {
      -            "pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$",
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "database",
      -          "table"
      -        ],
      -        "type": "object"
      -      },
      -      "type": {
      -        "const": "table",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "settings",
      -      "id"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "oneOf": [
      +      {
      +        "additionalProperties": false,
      +        "properties": {
      +          "settings": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "headers": {
      +                "additionalProperties": {
      +                  "type": "string"
      +                },
      +                "propertyNames": {
      +                  "type": "string"
      +                },
      +                "type": "object"
      +              },
      +              "url": {
      +                "description": "Write-only sink URL. The API validates allowed origins.",
      +                "format": "uri",
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "url"
      +            ],
      +            "type": "object"
      +          },
      +          "type": {
      +            "const": "http",
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "type",
      +          "settings"
      +        ],
      +        "type": "object"
      +      },
      +      {
      +        "additionalProperties": false,
      +        "properties": {
      +          "settings": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "database": {
      +                "pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$",
      +                "type": "string"
      +              },
      +              "table": {
      +                "pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$",
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "database",
      +              "table"
      +            ],
      +            "type": "object"
      +          },
      +          "type": {
      +            "const": "table",
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "type",
      +          "settings"
      +        ],
      +        "type": "object"
      +      },
      +      {
      +        "additionalProperties": false,
      +        "properties": {
      +          "settings": {
      +            "anyOf": [
      +              {
      +                "additionalProperties": false,
      +                "properties": {
      +                  "channel_name": {
      +                    "description": "Slack channel name, such as #alerts. Resolved to its channel ID on every save.",
      +                    "type": "string"
      +                  },
      +                  "integration_id": {
      +                    "description": "Slack integration connected to the organization, from list-integrations. list-integrations needs a user credential such as OAuth; with an API key, reuse the integration_id of an existing Slack sink or ask the user for it.",
      +                    "format": "uuid",
      +                    "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +                    "type": "string"
      +                  }
      +                },
      +                "required": [
      +                  "integration_id",
      +                  "channel_name"
      +                ],
      +                "type": "object"
      +              },
      +              {
      +                "additionalProperties": false,
      +                "properties": {
      +                  "channel_id": {
      +                    "description": "Slack channel ID, such as C0123456789. Send back the saved channel_id to keep an existing sink without a Slack lookup.",
      +                    "pattern": "^[A-Z0-9]{2,64}$",
      +                    "type": "string"
      +                  },
      +                  "integration_id": {
      +                    "description": "Slack integration connected to the organization, from list-integrations. list-integrations needs a user credential such as OAuth; with an API key, reuse the integration_id of an existing Slack sink or ask the user for it.",
      +                    "format": "uuid",
      +                    "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +                    "type": "string"
      +                  }
      +                },
      +                "required": [
      +                  "integration_id",
      +                  "channel_id"
      +                ],
      +                "type": "object"
      +              }
      +            ],
      +            "description": "integration_id and exactly one of channel_name or channel_id. The RawTree app must be a member of private channels."
      +          },
      +          "type": {
      +            "const": "slack",
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "type",
      +          "settings"
      +        ],
      +        "type": "object"
      +      }
      +    ]
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "id": {
      +        "format": "uuid",
      +        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +        "type": "string"
      +      },
      +      "settings": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "headers": {
      +            "additionalProperties": {
      +              "anyOf": [
      +                {
      +                  "type": "string"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ]
      +            },
      +            "propertyNames": {
      +              "type": "string"
      +            },
      +            "type": "object"
      +          },
      +          "url": {
      +            "description": "Write-only sink URL. The API validates allowed origins.",
      +            "format": "uri",
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": {
      +        "const": "http",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "id"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "id": {
      +        "format": "uuid",
      +        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +        "type": "string"
      +      },
      +      "settings": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "database": {
      +            "pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$",
      +            "type": "string"
      +          },
      +          "table": {
      +            "pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$",
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "database",
      +          "table"
      +        ],
      +        "type": "object"
      +      },
      +      "type": {
      +        "const": "table",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "settings",
      +      "id"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "id": {
      +        "format": "uuid",
      +        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +        "type": "string"
      +      },
      +      "settings": {
      +        "anyOf": [
      +          {
      +            "additionalProperties": false,
      +            "properties": {
      +              "channel_name": {
      +                "description": "Slack channel name, such as #alerts. Resolved to its channel ID on every save.",
      +                "type": "string"
      +              },
      +              "integration_id": {
      +                "description": "Slack integration connected to the organization, from list-integrations. list-integrations needs a user credential such as OAuth; with an API key, reuse the integration_id of an existing Slack sink or ask the user for it.",
      +                "format": "uuid",
      +                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "integration_id",
      +              "channel_name"
      +            ],
      +            "type": "object"
      +          },
      +          {
      +            "additionalProperties": false,
      +            "properties": {
      +              "channel_id": {
      +                "description": "Slack channel ID, such as C0123456789. Send back the saved channel_id to keep an existing sink without a Slack lookup.",
      +                "pattern": "^[A-Z0-9]{2,64}$",
      +                "type": "string"
      +              },
      +              "integration_id": {
      +                "description": "Slack integration connected to the organization, from list-integrations. list-integrations needs a user credential such as OAuth; with an API key, reuse the integration_id of an existing Slack sink or ask the user for it.",
      +                "format": "uuid",
      +                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "integration_id",
      +              "channel_id"
      +            ],
      +            "type": "object"
      +          }
      +        ],
      +        "description": "integration_id and exactly one of channel_name or channel_id. The RawTree app must be a member of private channels."
      +      },
      +      "type": {
      +        "const": "slack",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "settings",
      +      "id"
      +    ],
      +    "type": "object"
      +  }
      +]
  2. Addedv0.4.2

TDQS

A4.6/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Adds substantial behavior beyond the annotations: supplying sinks replaces the whole list and may remove delivery targets, buffered deliveries continue after pausing, header values are never returned, url is null when unreadable, and workflows keep executing with org credentials after the creating key is revoked. This is exactly the kind of destructive side effect (reinforcing destructiveHint=true) an agent needs before calling.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the omit/preserve rule, then pause/resume, then sink hazards, then return shape and auth. The return-value block is long, though with no output schema it earns its place; a few sink-type restatements could be trimmed without loss.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an 8-parameter tool with deeply nested sinks, destructive semantics, and no output schema, the description covers mutation scope, nested-object hazards, the return shape (including nested query/schedule/sink fields), and credential requirements. Nothing an agent needs to invoke it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is already 88%, but the description contributes cross-parameter rules the schema cannot express: at-least-one-changed-field requirement, omit-to-preserve / null-to-clear semantics for schedule and description, sinks list replacement, and reading get-workflow first to preserve sink IDs. The per-field return-side details duplicate some schema info but the interaction rules add real value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Update only supplied fields of an existing workflow') plus the key constraint that at least one changed field is required. Combined with 'Omitted fields remain unchanged', an agent can distinguish this from create-workflow, get-workflow, and delete-workflow without touching the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives concrete conditional guidance: use schedule.enabled=false/true to pause/resume, schedule.cron to change cadence, and 'Read get-workflow before editing sinks so you can preserve their IDs.' It also spells out the permission model (members read, admins create/update/delete). It does not explicitly exclude cases where delete-workflow or create-workflow would be the better call, so it falls short of the full when/when-not/alternatives bar.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.