Skip to main content
Glama
ghl-mcp-server-v2

ghl-mcp-server-v2

by zackscriven

ghl_contact_add_to_workflow

Adds a contact to a specified workflow and optionally sets the workflow event start time, enabling targeted automation from contact records.

Instructions

Add Contact to Workflow Endpoint: POST /contacts/{contactId}/workflow/{workflowId} (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

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": {
      "contactId": "<contactId>",
      "workflowId": "<workflowId>",
      "body": "<body>"
    },
    "name": "ghl_contact_add_to_workflow"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
contactIdYesContact Id
workflowIdYesWorkflow Id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.0
    • addedInput schema / properties / body / title
      Added value: +"CreateWorkflowDto"
  2. First observedv2.0.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false, destructiveHint=false, and openWorldHint=true, so the safety profile is covered. The description adds valuable context beyond that: the required OAuth scope (contacts.write) and the API version header (v3). However, it doesn't disclose side effects such as triggering workflow emails/SMS or what happens if the contact is already enrolled.

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?

Three short lines with the action name front-loaded, followed by endpoint and scope metadata. No wasted prose; the OpenAPI provenance note is a minor but forgivable addition.

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

Completeness3/5

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

For a mutation tool with a nested body and no output schema, the description covers the mechanics (endpoint, scope) but omits outcome information: what enrollment means operationally, whether it is immediate, and any failure conditions. Adequate but not complete for an agent deciding whether to call it.

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 contactId, workflowId, and the nested body.eventStartTime are fully documented in the schema. The description adds nothing about parameter semantics, which is acceptable at full coverage but leaves this at the baseline.

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

Purpose4/5

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

The description names a specific verb+resource ('Add Contact to Workflow') and pins it to an exact endpoint (POST /contacts/{contactId}/workflow/{workflowId}), so the agent knows precisely what mutation occurs. It does not explicitly distinguish itself from the closely related sibling ghl_contact_delete_from_workflow, but the tool name itself carries that contrast.

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

Usage Guidelines3/5

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

Usage is only implied by the name and endpoint — the agent can infer this enrolls a contact in a workflow, and the presence of ghl_contact_delete_from_workflow implies the inverse. No explicit when-to-use, prerequisites (e.g., workflow must be published), or alternative routing is stated.

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