Skip to main content
Glama
zackscriven

ghl-mcp-server-v2

by zackscriven

ghl_workflow_update_status

Idempotent

Publishes a workflow or returns it to draft, validating the full definition and activating triggers when publishing; invalid definitions are rejected and remain unchanged.

Instructions

WORKFLOW API — limited availability: enabled for selected sub-accounts only; others get 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION (not a token or scope problem). Suggested order: get step types -> build the definition -> validate (validate_workflow_definition, read-only) -> create (always lands in draft) -> publish via update status. Rate limits: integration daily quota + 10s burst (X-RateLimit-* headers) AND a per-sub-account budget per 10s window with reads and writes counted separately; no Retry-After is sent. Logs: default and max range 30 days; retained 60 days. Update Workflow Status Limited availability. The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION.

Publish a workflow or send it back to draft. Publishing validates the definition in full and activates the triggers; a definition that fails validation is rejected with 422 and the workflow stays as it was. Locked and scheduled-paused workflows cannot change status and return 409. Endpoint: PUT /workflows/{workflowId}/status (Version header: v3; source: v3/workflows-v3.json) OAuth scopes: workflows.publish

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
locationIdYesSub-account (location) ID the workflow belongs to
workflowIdYesWorkflow ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.1.0

TDQS

A4.4/5.0
Behavior5/5

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

Adds substantial context beyond annotations: publishing fully validates the definition and activates triggers, invalid definitions get 422 and the workflow stays as-is, 409 for locked/scheduled-paused. It also documents rate-limit behavior (daily quota, 10s burst, per-sub-account budget, no Retry-After) and log retention, which the annotations do not cover.

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

Conciseness3/5

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

Useful content is front-loaded, but 'limited availability' and the 403/validation details appear twice, and the generic rate-limit/log boilerplate is largely irrelevant to a single status-change call. It could be tightened without losing meaning.

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

Completeness4/5

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

There is no output schema, and the description covers error paths (403/409/422), the read-only validate prerequisite, and mutation semantics, so an agent has what it needs to call correctly. What a successful response returns is unaddressed but minor.

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

Parameters3/5

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

Schema description coverage is 100%, so the baseline is 3. The description restates the status enum semantics (published/draft) that the schema already documents, adding essentially no syntax or format detail beyond it.

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?

The description states a specific verb and resource: publish a workflow or send it back to draft, and clarifies the create-vs-publish distinction ('create always lands in draft -> publish via update status'). An agent can differentiate this from ghl_workflow_create without opening schemas.

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

Usage Guidelines5/5

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

It gives an explicit suggested order (get step types -> build definition -> validate -> create -> publish via update status) and names the read-only validate alternative. It also states preconditions: only selected sub-accounts, 403 otherwise, and locked/scheduled-paused workflows return 409.

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

Deploy Server

Other Tools