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

ghl-mcp-server-v2

by zackscriven

ghl_conversation_ai_update_followup_settings

Update follow-up settings for specified Conversation AI agent actions, including working hours, timezone, and dynamic channel switching.

Instructions

Update Followup Settings Update the followup settings for an action Endpoint: PATCH /conversation-ai/agents/{agentId}/followup-settings (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.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": {
      "agentId": "<agentId>",
      "body": "<body>"
    },
    "name": "ghl_conversation_ai_update_followup_settings"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
agentIdYesThe unique identifier of the AI agent

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv2.1.0
    • addedInput schema / properties / agentId / description
      Added value: +"The unique identifier of the AI agent"
    • addedInput schema / properties / agentId / example
      Added value: +"ve9EPM428h8vShlRW1KT"
    • addedInput schema / properties / body / properties / actionIds / description
      Added value: +"Array of action IDs to update followup settings for"
    • addedInput schema / properties / body / properties / followupSettings / allOf
      Added value: +[
      +  {
      +    "properties": {
      +      "dynamicChannelSwitching": {
      +        "default": true,
      +        "description": "Whether to dynamically switch channels for followups",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "followUpHours": {
      +        "description": "Whether to respect working hours for followups",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "timezoneToUse": {
      +        "description": "Timezone to use for followups, contact or location",
      +        "enum": [
      +          "contact",
      +          "business"
      +        ],
      +        "example": "contact",
      +        "type": "string"
      +      },
      +      "workingHours": {
      +        "description": "Working hours configuration for followups",
      +        "example": [
      +          {
      +            "dayOfTheWeek": 1,
      +            "intervals": [
      +              {
      +                "endHour": 17,
      +                "endMinute": 0,
      +                "startHour": 9,
      +                "startMinute": 0
      +              }
      +            ]
      +          }
      +        ],
      +        "items": {
      +          "properties": {
      +            "dayOfTheWeek": {
      +              "description": "Day of the week (0=Sunday, 1=Monday, etc.)",
      +              "example": 1,
      +              "type": "number"
      +            },
      +            "intervals": {
      +              "description": "Time intervals for this day",
      +              "example": [
      +                {
      +                  "endHour": 17,
      +                  "endMinute": 0,
      +                  "startHour": 9,
      +                  "startMinute": 0
      +                }
      +              ],
      +              "items": {
      +                "properties": {
      +                  "endHour": {
      +                    "description": "End hour (24-hour format)",
      +                    "example": 17,
      +                    "type": "number"
      +                  },
      +                  "endMinute": {
      +                    "description": "End minute",
      +                    "example": 30,
      +                    "type": "number"
      +                  },
      +                  "startHour": {
      +                    "description": "Start hour (24-hour format)",
      +                    "example": 9,
      +                    "type": "number"
      +                  },
      +                  "startMinute": {
      +                    "description": "Start minute",
      +                    "example": 0,
      +                    "type": "number"
      +                  }
      +                },
      +                "required": [
      +                  "startHour",
      +                  "startMinute",
      +                  "endHour",
      +                  "endMinute"
      +                ],
      +                "title": "Interval",
      +                "type": "object"
      +              },
      +              "type": "array"
      +            }
      +          },
      +          "required": [
      +            "dayOfTheWeek"
      +          ],
      +          "title": "WorkingHours",
      +          "type": "object"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "dynamicChannelSwitching"
      +    ],
      +    "title": "FollowupSettings",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / properties / followupSettings / description
      Added value: +"Followup settings configuration to apply to the specified actions"
    • addedInput schema / properties / body / properties / followupSettings / example
      Added value: +{
      +  "dynamicChannelSwitching": true,
      +  "followUpHours": false,
      +  "timezoneToUse": "contact"
      +}
    • removedInput schema / properties / body / properties / followupSettings / properties
      Removed value: -{
      -  "dynamicChannelSwitching": {
      -    "default": true,
      -    "description": "Whether to dynamically switch channels for followups",
      -    "example": true,
      -    "type": "boolean"
      -  },
      -  "followUpHours": {
      -    "description": "Whether to respect working hours for followups",
      -    "example": true,
      -    "type": "boolean"
      -  },
      -  "timezoneToUse": {
      -    "description": "Timezone to use for followups, contact or location",
      -    "enum": [
      -      "contact",
      -      "business"
      -    ],
      -    "type": "string"
      -  },
      -  "workingHours": {
      -    "description": "Working hours configuration for followups",
      -    "items": {
      -      "properties": {
      -        "dayOfTheWeek": {
      -          "description": "Day of the week (0=Sunday, 1=Monday, etc.)",
      -          "example": 1,
      -          "type": "number"
      -        },
      -        "intervals": {
      -          "description": "Time intervals for this day",
      -          "items": {
      -            "properties": {
      -              "endHour": {
      -                "description": "End hour (24-hour format)",
      -                "example": 17,
      -                "type": "number"
      -              },
      -              "endMinute": {
      -                "description": "End minute",
      -                "example": 30,
      -                "type": "number"
      -              },
      -              "startHour": {
      -                "description": "Start hour (24-hour format)",
      -                "example": 9,
      -                "type": "number"
      -              },
      -              "startMinute": {
      -                "description": "Start minute",
      -                "example": 0,
      -                "type": "number"
      -              }
      -            },
      -            "required": [
      -              "startHour",
      -              "startMinute",
      -              "endHour",
      -              "endMinute"
      -            ],
      -            "type": "object"
      -          },
      -          "type": "array"
      -        }
      -      },
      -      "required": [
      -        "dayOfTheWeek"
      -      ],
      -      "type": "object"
      -    },
      -    "type": "array"
      -  }
      -}
    • removedInput schema / properties / body / properties / followupSettings / required
      Removed value: -[
      -  "dynamicChannelSwitching"
      -]
    • removedInput schema / properties / body / properties / followupSettings / type
      Removed value: -"object"
    • addedInput schema / properties / body / title
      Added value: +"UpdateFollowupSettingsDTO"
  2. First observedv2.0.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare the mutation profile (readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=true); the description usefully adds the required OAuth scope conversation-ai.write and the exact endpoint/version. However, it does not say whether followupSettings replaces or merges existing configuration, nor what happens to actions omitted from actionIds, which is the key behavioral ambiguity for a non-idempotent PATCH.

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?

Short and front-loaded, with the endpoint and scope metadata grouped after the purpose line. Minor redundancy between the first line and 'Update the followup settings for an action', but nothing wasteful enough to hurt.

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?

Adequate for a mutation tool whose annotations carry the safety profile and whose schema is fully documented, and no output schema exists to require return-value explanation. Still, for a PATCH with a deeply nested settings object, the description should clarify the replace-vs-merge semantics and the meaning of actionIds scoping to be truly complete.

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 nested DTO fields (workingHours, followUpHours, timezoneToUse, dynamicChannelSwitching, actionIds) are already documented in the schema. The description adds only the endpoint path parameter mapping and no extra semantic detail, so baseline 3 applies.

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?

States a specific verb (update) and resource (followup settings scoped to an action on an agent), reinforced by the PATCH endpoint path. It is clear what the tool does, but it does not distinguish itself from nearby siblings such as ghl_conversation_ai_update_action or ghl_conversation_ai_update_agent.

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

Usage Guidelines2/5

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

There is no guidance on when to use this versus ghl_conversation_ai_update_action, ghl_conversation_ai_create_action, or the agent working-hours tools, nor any stated preconditions beyond the endpoint. The OAuth scope line is access context, not usage guidance.

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