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

ghl-mcp-server-v2

by zackscriven

ghl_voice_ai_create_action

Creates a new action for a voice AI agent to define call behaviors, including transfers, data extraction, workflow triggers, SMS, appointment booking, custom API calls, and knowledge base queries.

Instructions

Create Agent Action Create a new action for a voice AI agent. Actions define specific behaviors and capabilities for the agent during calls. Endpoint: POST /voice-ai/actions (Version header: v3; source: v3/voice-ai-v3.json) OAuth scopes: voice-ai-agent-goals.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": {
      "body": "<body>"
    },
    "name": "ghl_voice_ai_create_action"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.1.0
    • changedInput schema / properties / body / properties / actionParameters / oneOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "hearWhisperMessage": {
      -        "description": "Whether to play whisper message to the receiving party",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "transferToType": {
      -        "description": "Type of transfer destination (currently only \"number\" is supported)",
      -        "enum": [
      -          "number"
      -        ],
      -        "example": "number",
      -        "type": "string"
      -      },
      -      "transferToValue": {
      -        "description": "Phone number to transfer to. Must start with +, include country code, contain only numbers, and be 11-16 characters long (e.g., +12345678901).",
      -        "example": "+12345678901",
      -        "type": "string"
      -      },
      -      "triggerMessage": {
      -        "description": "Message to tell the caller before transferring",
      -        "example": "Let me transfer you to a manager right away",
      -        "type": "string"
      -      },
      -      "triggerPrompt": {
      -        "description": "When to trigger this action during the call",
      -        "example": "When the caller asks to speak to a manager",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "triggerPrompt",
      -      "transferToType",
      -      "transferToValue",
      -      "triggerMessage"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "contactFieldId": {
      -        "description": "ID of the contact field to be updated with the extracted data",
      -        "example": "507f1f77bcf86cd799439011",
      -        "type": "string"
      -      },
      -      "description": {
      -        "description": "Description of what data to extract",
      -        "example": "Caller's phone number",
      -        "type": "string"
      -      },
      -      "examples": {
      -        "description": "Example values to help Agent understand the expected format. At least one example is required, maximum 5 examples allowed.",
      -        "example": [
      -          "+1234567890",
      -          "+9876543210"
      -        ],
      -        "items": {
      -          "type": "string"
      -        },
      -        "type": "array"
      -      },
      -      "overwriteExistingValue": {
      -        "default": false,
      -        "description": "Whether to overwrite existing field value if already set, default is false",
      -        "example": false,
      -        "type": "boolean"
      -      }
      -    },
      -    "required": [
      -      "contactFieldId",
      -      "description",
      -      "examples"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "contactFieldId": {
      -        "description": "ID of the contact field to be updated with the extracted data",
      -        "example": "507f1f77bcf86cd799439011",
      -        "type": "string"
      -      },
      -      "description": {
      -        "description": "Description of what data to extract",
      -        "example": "Caller's phone number",
      -        "type": "string"
      -      },
      -      "examples": {
      -        "description": "Example values to help Agent understand the expected format. At least one example is required, maximum 5 examples allowed.",
      -        "example": [
      -          "+1234567890",
      -          "+9876543210"
      -        ],
      -        "items": {
      -          "type": "string"
      -        },
      -        "type": "array"
      -      },
      -      "overwriteExistingValue": {
      -        "default": false,
      -        "description": "Whether to overwrite existing field value if already set, default is false",
      -        "example": false,
      -        "type": "boolean"
      -      }
      -    },
      -    "required": [
      -      "contactFieldId",
      -      "description",
      -      "examples"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "triggerMessage": {
      -        "description": "Message to tell the caller",
      -        "example": "Let me start that process for you",
      -        "type": "string"
      -      },
      -      "triggerPrompt": {
      -        "description": "When to trigger this workflow",
      -        "example": "When caller requests a quote",
      -        "type": "string"
      -      },
      -      "workflowId": {
      -        "description": "Workflow ID to trigger",
      -        "example": "507f1f77bcf86cd799439011",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "triggerPrompt",
      -      "triggerMessage",
      -      "workflowId"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "messageBody": {
      -        "description": "SMS message content to send",
      -        "example": "Your appointment is confirmed for tomorrow at 2 PM",
      -        "type": "string"
      -      },
      -      "triggerMessage": {
      -        "description": "Message to tell the caller",
      -        "example": "I'll send you a confirmation text",
      -        "type": "string"
      -      },
      -      "triggerPrompt": {
      -        "description": "When to send the SMS",
      -        "example": "When caller asks for booking confirmation",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "triggerPrompt",
      -      "triggerMessage",
      -      "messageBody"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "calendarId": {
      -        "description": "Calendar ID to book appointments in",
      -        "example": "507f1f77bcf86cd799439011",
      -        "type": "string"
      -      },
      -      "daysOfOfferingDates": {
      -        "description": "Number of days ahead to offer booking dates",
      -        "example": 3,
      -        "type": "number"
      -      },
      -      "hoursBetweenSlots": {
      -        "description": "Hours between available slots",
      -        "example": 1,
      -        "type": "number"
      -      },
      -      "slotsPerDay": {
      -        "description": "Number of available slots per day",
      -        "example": 3,
      -        "type": "number"
      -      }
      -    },
      -    "required": [
      -      "calendarId",
      -      "daysOfOfferingDates",
      -      "slotsPerDay",
      -      "hoursBetweenSlots"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "apiDetails": {
      -        "allOf": [
      -          {
      -            "properties": {
      -              "authenticationRequired": {
      -                "description": "Whether authentication is required",
      -                "example": true,
      -                "type": "boolean"
      -              },
      -              "authenticationValue": {
      -                "description": "Authentication token or API key (required if authenticationRequired is true)",
      -                "example": "token123",
      -                "type": "string"
      -              },
      -              "headers": {
      -                "description": "HTTP headers to include",
      -                "items": {
      -                  "properties": {
      -                    "key": {
      -                      "description": "HTTP header name",
      -                      "example": "id",
      -                      "type": "string"
      -                    },
      -                    "value": {
      -                      "description": "HTTP header value",
      -                      "example": "1234567890",
      -                      "type": "string"
      -                    }
      -                  },
      -                  "required": [
      -                    "key",
      -                    "value"
      -                  ],
      -                  "type": "object"
      -                },
      -                "type": "array"
      -              },
      -              "method": {
      -                "description": "HTTP method",
      -                "enum": [
      -                  "POST",
      -                  "GET"
      -                ],
      -                "example": "GET",
      -                "type": "string"
      -              },
      -              "parameters": {
      -                "description": "API parameters to send",
      -                "items": {
      -                  "properties": {
      -                    "description": {
      -                      "description": "Parameter description",
      -                      "example": "Order ID to look up",
      -                      "type": "string"
      -                    },
      -                    "example": {
      -                      "description": "Example parameter value",
      -                      "example": "ORD-12345",
      -                      "type": "string"
      -                    },
      -                    "name": {
      -                      "description": "Parameter name",
      -                      "example": "orderId",
      -                      "type": "string"
      -                    },
      -                    "type": {
      -                      "description": "Parameter type",
      -                      "example": "string",
      -                      "type": "string"
      -                    }
      -                  },
      -                  "required": [
      -                    "name"
      -                  ],
      -                  "type": "object"
      -                },
      -                "type": "array"
      -              },
      -              "url": {
      -                "description": "API endpoint URL",
      -                "example": "https://api.example.com/orders",
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "url",
      -              "method"
      -            ],
      -            "type": "object"
      -          }
      -        ],
      -        "description": "API endpoint configuration"
      -      },
      -      "selectedPaths": {
      -        "description": "Selected response paths to extract from API response. Required: at least 1 value if the method is GET. Should be empty if the method is POST.",
      -        "example": [
      -          "data.orderId",
      -          "status"
      -        ],
      -        "items": {
      -          "type": "string"
      -        },
      -        "type": "array"
      -      },
      -      "triggerMessage": {
      -        "description": "Message to tell the caller",
      -        "example": "Let me check that order status",
      -        "type": "string"
      -      },
      -      "triggerPrompt": {
      -        "description": "When to call the custom API",
      -        "example": "When caller provides order number",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "triggerPrompt",
      -      "triggerMessage",
      -      "apiDetails"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "knowledgeBaseId": {
      -        "description": "Knowledge base ID to query",
      -        "example": "507f1f77bcf86cd799439011",
      -        "type": "string"
      -      },
      -      "triggerPrompt": {
      -        "description": "When to query the knowledge base",
      -        "example": "When caller asks about pricing",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "triggerPrompt",
      -      "knowledgeBaseId"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "hearWhisperMessage": {
      +        "description": "Whether to play whisper message to the receiving party",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "transferToType": {
      +        "description": "Type of transfer destination (currently only \"number\" is supported)",
      +        "enum": [
      +          "number"
      +        ],
      +        "example": "number",
      +        "type": "string"
      +      },
      +      "transferToValue": {
      +        "description": "Phone number to transfer to. Must start with +, include country code, contain only numbers, and be 11-16 characters long (e.g., +12345678901).",
      +        "example": "+12345678901",
      +        "type": "string"
      +      },
      +      "triggerMessage": {
      +        "description": "Message to tell the caller before transferring",
      +        "example": "Let me transfer you to a manager right away",
      +        "type": "string"
      +      },
      +      "triggerPrompt": {
      +        "description": "When to trigger this action during the call",
      +        "example": "When the caller asks to speak to a manager",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "triggerPrompt",
      +      "transferToType",
      +      "transferToValue",
      +      "triggerMessage"
      +    ],
      +    "title": "CallTransferActionParameters",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "contactFieldId": {
      +        "description": "ID of the contact field to be updated with the extracted data",
      +        "example": "507f1f77bcf86cd799439011",
      +        "type": "string"
      +      },
      +      "description": {
      +        "description": "Description of what data to extract",
      +        "example": "Caller's phone number",
      +        "type": "string"
      +      },
      +      "examples": {
      +        "description": "Example values to help Agent understand the expected format. At least one example is required, maximum 5 examples allowed.",
      +        "example": [
      +          "+1234567890",
      +          "+9876543210"
      +        ],
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "overwriteExistingValue": {
      +        "default": false,
      +        "description": "Whether to overwrite existing field value if already set, default is false",
      +        "example": false,
      +        "type": "boolean"
      +      }
      +    },
      +    "required": [
      +      "contactFieldId",
      +      "description",
      +      "examples"
      +    ],
      +    "title": "DataExtractionActionParameters",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "contactFieldId": {
      +        "description": "ID of the contact field to be updated with the extracted data",
      +        "example": "507f1f77bcf86cd799439011",
      +        "type": "string"
      +      },
      +      "description": {
      +        "description": "Description of what data to extract",
      +        "example": "Caller's phone number",
      +        "type": "string"
      +      },
      +      "examples": {
      +        "description": "Example values to help Agent understand the expected format. At least one example is required, maximum 5 examples allowed.",
      +        "example": [
      +          "+1234567890",
      +          "+9876543210"
      +        ],
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "overwriteExistingValue": {
      +        "default": false,
      +        "description": "Whether to overwrite existing field value if already set, default is false",
      +        "example": false,
      +        "type": "boolean"
      +      }
      +    },
      +    "required": [
      +      "contactFieldId",
      +      "description",
      +      "examples"
      +    ],
      +    "title": "InCallDataExtractionActionParameters",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "triggerMessage": {
      +        "description": "Message to tell the caller",
      +        "example": "Let me start that process for you",
      +        "type": "string"
      +      },
      +      "triggerPrompt": {
      +        "description": "When to trigger this workflow",
      +        "example": "When caller requests a quote",
      +        "type": "string"
      +      },
      +      "workflowId": {
      +        "description": "Workflow ID to trigger",
      +        "example": "507f1f77bcf86cd799439011",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "triggerPrompt",
      +      "triggerMessage",
      +      "workflowId"
      +    ],
      +    "title": "WorkflowTriggerParameters",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "messageBody": {
      +        "description": "SMS message content to send",
      +        "example": "Your appointment is confirmed for tomorrow at 2 PM",
      +        "type": "string"
      +      },
      +      "triggerMessage": {
      +        "description": "Message to tell the caller",
      +        "example": "I'll send you a confirmation text",
      +        "type": "string"
      +      },
      +      "triggerPrompt": {
      +        "description": "When to send the SMS",
      +        "example": "When caller asks for booking confirmation",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "triggerPrompt",
      +      "triggerMessage",
      +      "messageBody"
      +    ],
      +    "title": "SMSParameters",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "calendarId": {
      +        "description": "Calendar ID to book appointments in",
      +        "example": "507f1f77bcf86cd799439011",
      +        "type": "string"
      +      },
      +      "daysOfOfferingDates": {
      +        "description": "Number of days ahead to offer booking dates",
      +        "example": 3,
      +        "type": "number"
      +      },
      +      "hoursBetweenSlots": {
      +        "description": "Hours between available slots",
      +        "example": 1,
      +        "type": "number"
      +      },
      +      "slotsPerDay": {
      +        "description": "Number of available slots per day",
      +        "example": 3,
      +        "type": "number"
      +      }
      +    },
      +    "required": [
      +      "calendarId",
      +      "daysOfOfferingDates",
      +      "slotsPerDay",
      +      "hoursBetweenSlots"
      +    ],
      +    "title": "AppointmentBookingActionParameters",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "apiDetails": {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "authenticationRequired": {
      +                "description": "Whether authentication is required",
      +                "example": true,
      +                "type": "boolean"
      +              },
      +              "authenticationValue": {
      +                "description": "Authentication token or API key (required if authenticationRequired is true)",
      +                "example": "token123",
      +                "type": "string"
      +              },
      +              "headers": {
      +                "description": "HTTP headers to include",
      +                "items": {
      +                  "properties": {
      +                    "key": {
      +                      "description": "HTTP header name",
      +                      "example": "id",
      +                      "type": "string"
      +                    },
      +                    "value": {
      +                      "description": "HTTP header value",
      +                      "example": "1234567890",
      +                      "type": "string"
      +                    }
      +                  },
      +                  "required": [
      +                    "key",
      +                    "value"
      +                  ],
      +                  "title": "CustomActionHeaderDTO",
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "method": {
      +                "description": "HTTP method",
      +                "enum": [
      +                  "POST",
      +                  "GET"
      +                ],
      +                "example": "GET",
      +                "type": "string"
      +              },
      +              "parameters": {
      +                "description": "API parameters to send",
      +                "items": {
      +                  "properties": {
      +                    "description": {
      +                      "description": "Parameter description",
      +                      "example": "Order ID to look up",
      +                      "type": "string"
      +                    },
      +                    "example": {
      +                      "description": "Example parameter value",
      +                      "example": "ORD-12345",
      +                      "type": "string"
      +                    },
      +                    "name": {
      +                      "description": "Parameter name",
      +                      "example": "orderId",
      +                      "type": "string"
      +                    },
      +                    "type": {
      +                      "description": "Parameter type",
      +                      "example": "string",
      +                      "type": "string"
      +                    }
      +                  },
      +                  "required": [
      +                    "name"
      +                  ],
      +                  "title": "CustomActionParameterDTO",
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "url": {
      +                "description": "API endpoint URL",
      +                "example": "https://api.example.com/orders",
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "url",
      +              "method"
      +            ],
      +            "title": "CustomActionApiDetailsDTO",
      +            "type": "object"
      +          }
      +        ],
      +        "description": "API endpoint configuration"
      +      },
      +      "selectedPaths": {
      +        "description": "Selected response paths to extract from API response. Required: at least 1 value if the method is GET. Should be empty if the method is POST.",
      +        "example": [
      +          "data.orderId",
      +          "status"
      +        ],
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "triggerMessage": {
      +        "description": "Message to tell the caller",
      +        "example": "Let me check that order status",
      +        "type": "string"
      +      },
      +      "triggerPrompt": {
      +        "description": "When to call the custom API",
      +        "example": "When caller provides order number",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "triggerPrompt",
      +      "triggerMessage",
      +      "apiDetails"
      +    ],
      +    "title": "CustomActionParameters",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "knowledgeBaseId": {
      +        "description": "Knowledge base ID to query",
      +        "example": "507f1f77bcf86cd799439011",
      +        "type": "string"
      +      },
      +      "triggerPrompt": {
      +        "description": "When to query the knowledge base",
      +        "example": "When caller asks about pricing",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "triggerPrompt",
      +      "knowledgeBaseId"
      +    ],
      +    "title": "KnowledgeBaseParameters",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / title
      Added value: +"CreateSingleActionDTO"
  2. First observedv2.0.0

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already disclose readOnlyHint=false, idempotentHint=false, destructiveHint=false, and openWorldHint=true. The description adds useful operational context beyond those annotations: the POST endpoint, v3 version header, and required OAuth scope voice-ai-agent-goals.write. It does not elaborate on failure modes or response behavior, but the annotations carry the core safety profile.

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?

The description is short and front-loads the core purpose. Endpoint and OAuth scope lines are useful for invocation. The first line duplicates the annotation title, which is minor redundancy.

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?

Given the rich nested input schema, the description supplies enough context to invoke the tool: purpose, endpoint, version, and auth scope. It does not describe the response, but no output schema exists and the schema already explains the actionParameters variants. An agent can call it correctly from this definition.

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 nested body schema thoroughly documents agentId, locationId, actionType, name, and actionParameters variants. The description adds no parameter-level semantics beyond the schema. A baseline 3 is appropriate when the schema does the heavy lifting.

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 states a specific verb and resource: 'Create a new action for a voice AI agent.' It also explains that actions define call-time behaviors. However, it does not explicitly differentiate this from sibling tools such as ghl_voice_ai_update_action or ghl_conversation_ai_create_action.

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?

The description gives no guidance on when to use this tool versus alternatives. It does not mention update, get, delete, or conversation-AI action siblings. The create verb implies usage, but there are no explicit conditions or exclusions.

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