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

ghl-mcp-server-v2

by zackscriven

ghl_voice_ai_patch_agent

Partially update an existing voice AI agent's configuration by sending only changed fields, such as prompt, voice, language, working hours, and call settings.

Instructions

Patch Agent Partially update an existing voice AI agent Endpoint: PATCH /voice-ai/agents/{agentId} (Version header: v3; source: v3/voice-ai-v3.json) OAuth scopes: voice-ai-agents.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>",
      "locationId": "<locationId>",
      "body": "<body>"
    },
    "name": "ghl_voice_ai_patch_agent"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
agentIdYesUnique agent identifier
locationIdYesLocation ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv2.1.0
    • addedInput schema / properties / body / properties / agentWorkingHours / items / properties / intervals / items / title
      Added value: +"IntervalDTO"
    • addedInput schema / properties / body / properties / agentWorkingHours / items / title
      Added value: +"AgentWorkingHoursDTO"
    • addedInput schema / properties / body / properties / language / example
      Added value: +"en-US"
    • addedInput schema / properties / body / properties / language / title
      Added value: +"VoiceAILanguage"
    • addedInput schema / properties / body / properties / patienceLevel / example
      Added value: +"low"
    • addedInput schema / properties / body / properties / patienceLevel / title
      Added value: +"PatienceLevel"
    • changedInput schema / properties / body / properties / sendPostCallNotificationTo / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "admins": {
      -        "description": "Enables post-call notifications to all admin users in the location. Default: true",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "allUsers": {
      -        "description": "Enables post-call notifications to all users in the location. Default: false",
      -        "example": false,
      -        "type": "boolean"
      -      },
      -      "contactAssignedUser": {
      -        "description": "Enables post-call notifications to the user assigned to the contact. Default: false",
      -        "example": false,
      -        "type": "boolean"
      -      },
      -      "customEmails": {
      -        "description": "Array of custom email addresses to receive post-call notifications. Default: []",
      -        "example": [
      -          "manager@company.com"
      -        ],
      -        "items": {
      -          "type": "string"
      -        },
      -        "type": "array"
      -      },
      -      "specificUsers": {
      -        "description": "Array of specific user IDs to receive post-call notifications. Default: []",
      -        "example": [
      -          "user_507f1f77bcf86cd799439011"
      -        ],
      -        "items": {
      -          "type": "string"
      -        },
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "admins",
      -      "allUsers",
      -      "contactAssignedUser",
      -      "specificUsers",
      -      "customEmails"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "admins": {
      +        "description": "Enables post-call notifications to all admin users in the location. Default: true",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "allUsers": {
      +        "description": "Enables post-call notifications to all users in the location. Default: false",
      +        "example": false,
      +        "type": "boolean"
      +      },
      +      "contactAssignedUser": {
      +        "description": "Enables post-call notifications to the user assigned to the contact. Default: false",
      +        "example": false,
      +        "type": "boolean"
      +      },
      +      "customEmails": {
      +        "description": "Array of custom email addresses to receive post-call notifications. Default: []",
      +        "example": [
      +          "manager@company.com"
      +        ],
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "specificUsers": {
      +        "description": "Array of specific user IDs to receive post-call notifications. Default: []",
      +        "example": [
      +          "user_507f1f77bcf86cd799439011"
      +        ],
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "admins",
      +      "allUsers",
      +      "contactAssignedUser",
      +      "specificUsers",
      +      "customEmails"
      +    ],
      +    "title": "SendPostCallNotificationDTO",
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / body / properties / translation / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "enabled": {
      -        "description": "Enables language translation for agent conversations. Default: false",
      -        "example": false,
      -        "type": "boolean"
      -      },
      -      "language": {
      -        "description": "Target language code for translation (e.g., \"es\" for Spanish, \"fr\" for French).",
      -        "example": "es",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "enabled"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "enabled": {
      +        "description": "Enables language translation for agent conversations. Default: false",
      +        "example": false,
      +        "type": "boolean"
      +      },
      +      "language": {
      +        "description": "Target language code for translation (e.g., \"es\" for Spanish, \"fr\" for French).",
      +        "example": "es",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "enabled"
      +    ],
      +    "title": "TranslationDTO",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / title
      Added value: +"PatchAgentDTO"
  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 readOnly=false, destructive=false, idempotent=false, openWorld=true. The description adds real context beyond them: the exact endpoint, the required v3 version header, and the voice-ai-agents.write scope. However, it never says what happens to omitted body fields (merge vs replace), whether changes are reversible, or what a failed patch returns.

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?

Four short lines, front-loaded with the action before the technical metadata. The 'source: v3/voice-ai-v3.json' fragment is minor internal noise but does not obscure the purpose.

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?

Annotations cover the safety profile and the schema fully documents each field, so the basics are present. For a complex nested patch payload with no output schema, the description should still clarify partial-update merge semantics and minimum viable payload, which it omits.

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% and the body has extensive per-field defaults and constraints, so the schema does the heavy lifting. The description only surfaces agentId implicitly through the path and adds no meaning about the 20-plus optional body fields or their merge behavior.

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 and resource ('Partially update an existing voice AI agent') and the word 'partially' plus the PATCH endpoint distinguishes it from a full replacement update. It does not explicitly name a sibling to route against, so it stops short of a 5.

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 statement of when to prefer this over creating a new agent, reading it, or using a full-update sibling, and no preconditions such as 'agent must already exist in this location'. Only the OAuth scope line hints at access requirements.

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