Skip to main content
Glama
zackscriven

ghl-mcp-server-v2

by zackscriven

ghl_workflow_get_definition

Read-onlyIdempotent

Read a workflow's complete definition for inspection or round-trip updates, preserving its version counter to prevent overwriting concurrent builder edits.

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. Get Workflow Definition 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.

Read a workflow as a complete definition. The definition object is accepted verbatim by Update Workflow Definition, so it round-trips.

The definition's version is the workflow's own counter. Leave it as it comes back: sending it unchanged on update is what stops a concurrent edit in the builder from being silently overwritten. Endpoint: GET /workflows/{workflowId}/definition (Version header: v3; source: v3/workflows-v3.json) OAuth scopes: workflows.readonly

Input Schema

NameRequiredDescriptionDefault
locationIdYesSub-account (location) ID the workflow belongs to
workflowIdYesWorkflow ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds substantial context beyond them: rate-limit behavior including no Retry-After header, separate read/write budgets, log retention windows, and the critical version-counter semantics that prevent silently overwriting a concurrent builder edit. This is exactly the kind of non-obvious behavior structured fields cannot express.

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 availability and ordering, which is the right priority. However, the limited-availability caveat and the 403 code are stated twice (in the header block and again in the prose), creating redundancy that slightly dilutes the otherwise well-organized text.

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 a two-parameter read tool, this covers everything an agent needs: availability gating, call sequencing, round-trip contract with the update tool, concurrency-safe version handling, and rate-limit constraints. No output schema exists, but the round-trip guarantee substitutes for describing the return shape.

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% for both locationId and workflowId, so the schema already carries parameter meaning. The description only reinforces workflowId via the endpoint path and adds no per-parameter format or constraint detail, so baseline 3 is appropriate.

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 — 'Read a workflow as a complete definition' — and explicitly distinguishes it from Update Workflow Definition by noting the definition round-trips. An agent can tell this apart from validate/create/update siblings without opening a schema.

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?

Provides an explicit suggested ordering (get step types -> build -> validate -> create -> publish) and names the sibling tools involved. It also documents the exact failure condition (403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION, explicitly 'not a token or scope problem'), which prevents an agent from misrouting to auth debugging.

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