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

ghl-mcp-server-v2

by zackscriven

ghl_chat_widget_patch

Applies a partial update to an existing chat widget by location and widget ID, modifying only specified settings or fields.

Instructions

Patch Chat Widget Applies a partial update to an existing chat widget Endpoint: PATCH /chat-widget/data/{locationId}/{id} (Version header: v3; source: v3/chat-widget-v3.json) Requires a Sub-Account (location) token. OAuth scopes: chat-widget.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": {
      "id": "<id>",
      "locationId": "<locationId>",
      "body": "<body>"
    },
    "name": "ghl_chat_widget_patch"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe chat widget ID
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
locationIdYesThe location ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv2.1.0
    • changedInput schema / properties / body / properties / chatType / description
      Previous value: -"Chat type"New value: +"Chat Type. The public API supports only liveChat and emailChat; any other value is rejected with a 422."
    • changedInput schema / properties / body / properties / settings / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "acknowledgementDetails": {
      -        "allOf": [
      -          {
      -            "properties": {
      -              "icon": {
      -                "description": "Icon",
      -                "example": "check",
      -                "type": "string"
      -              },
      -              "liveChatIcon": {
      -                "description": "Icon for live chat",
      -                "example": "check",
      -                "type": "string"
      -              },
      -              "liveChatPlaceholderColor": {
      -                "description": "Placeholder color for live chat",
      -                "example": "#000",
      -                "type": "string"
      -              },
      -              "placeholderColor": {
      -                "description": "Placeholder color",
      -                "example": "#000",
      -                "type": "string"
      -              }
      -            },
      -            "type": "object"
      -          }
      -        ],
      -        "description": "Acknowledgement Details",
      -        "example": {
      -          "icon": "check",
      -          "placeholderColor": "#000"
      -        }
      -      },
      -      "advanceSettings": {
      -        "allOf": [
      -          {
      -            "properties": {
      -              "aTwoPCompliance": {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "a2pOptInForm1": {
      -                        "description": "A2P Opt In Form 1",
      -                        "example": "I agree to receive marketing communications from [business name]",
      -                        "type": "string"
      -                      },
      -                      "a2pOptInForm1PreChecked": {
      -                        "description": "Pre-checked state for A2P Opt In Form 1 checkbox",
      -                        "example": false,
      -                        "type": "boolean"
      -                      },
      -                      "a2pOptInForm1ShowCheckbox": {
      -                        "description": "Show checkbox for A2P Opt In Form 1",
      -                        "example": true,
      -                        "type": "boolean"
      -                      },
      -                      "a2pOptInForm2": {
      -                        "description": "A2P Opt In Form 2",
      -                        "example": "I agree to receive marketing communications from [business name]",
      -                        "type": "string"
      -                      },
      -                      "a2pOptInForm2PreChecked": {
      -                        "description": "Pre-checked state for A2P Opt In Form 2 checkbox",
      -                        "example": false,
      -                        "type": "boolean"
      -                      },
      -                      "a2pOptInForm2ShowCheckbox": {
      -                        "description": "Show checkbox for A2P Opt In Form 2",
      -                        "example": true,
      -                        "type": "boolean"
      -                      },
      -                      "enableA2PCompliance": {
      -                        "description": "Enable A2P Compliance",
      -                        "example": true,
      -                        "type": "boolean"
      -                      },
      -                      "isA2POptInForm1": {
      -                        "description": "Is A2P Opt In Form 1 enabled",
      -                        "example": true,
      -                        "type": "boolean"
      -                      },
      -                      "isA2POptInForm2": {
      -                        "description": "Is A2P Opt In Form 2",
      -                        "example": true,
      -                        "type": "boolean"
      -                      },
      -                      "messageType": {
      -                        "description": "Message Type",
      -                        "example": "A2P",
      -                        "type": "string"
      -                      },
      -                      "privacyPolicyLink": {
      -                        "description": "Privacy Policy Link",
      -                        "example": "https://example.com/privacy-policy",
      -                        "type": "string"
      -                      },
      -                      "termsOfServiceLink": {
      -                        "description": "Terms of Service",
      -                        "example": "https://example.com/terms-of-service",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "description": "A2P Compliance",
      -                "example": {
      -                  "a2pComplianceMessage": "This is a A2P compliance message",
      -                  "enableA2PCompliance": true,
      -                  "isA2POptInForm2": true,
      -                  "marketingComplianceMessage": "This is a marketing compliance message",
      -                  "privacyPolicyLink": "https://example.com/privacy-policy",
      -                  "termsOfServiceLink": "https://example.com/terms-of-service"
      -                }
      -              },
      -              "allInOneChatTypes": {
      -                "description": "Chat types included in the all-in-one widget",
      -                "example": [
      -                  "liveChat",
      -                  "waChat"
      -                ],
      -                "items": {
      -                  "enum": [
      -                    "liveChat",
      -                    "waChat",
      -                    "emailChat",
      -                    "allInOneChat",
      -                    "voiceAiChat",
      -                    "facebookChat",
      -                    "instagramChat",
      -                    "webChat"
      -                  ],
      -                  "type": "string"
      -                },
      -                "type": "array"
      -              },
      -              "allInOneInitialMsg": {
      -                "description": "All In One Initial Msg",
      -                "example": "Choose a chat option to get started.",
      -                "type": "string"
      -              },
      -              "brandingTitle": {
      -                "description": "Branding Title",
      -                "example": "Agency",
      -                "type": "string"
      -              },
      -              "businessOfficeHours": {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "enableBusinessHours": {
      -                        "description": "Enable Business Hours",
      -                        "example": false,
      -                        "type": "boolean"
      -                      },
      -                      "openHours": {
      -                        "description": "Open hours schedule",
      -                        "example": [
      -                          {
      -                            "closeHour": "17:00",
      -                            "day": "monday",
      -                            "openHour": "09:00"
      -                          }
      -                        ],
      -                        "items": {
      -                          "type": "string"
      -                        },
      -                        "type": "array"
      -                      },
      -                      "outsideOfficeHoursWelcomeMsg": {
      -                        "description": "Time Zone",
      -                        "example": "Asia/Calcutta",
      -                        "type": "string"
      -                      },
      -                      "timezone": {
      -                        "description": "Time Zone",
      -                        "example": "UTC",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "description": "Business Office Hours",
      -                "example": {
      -                  "enableBusinessHours": false,
      -                  "timezone": "UTC"
      -                }
      -              },
      -              "contactFormIntroMessage": {
      -                "description": "Contact Form Intro Message",
      -                "example": "Please share contact details",
      -                "type": "string"
      -              },
      -              "contactFormOptions": {
      -                "description": "Contact form field configuration",
      -                "example": [
      -                  {
      -                    "dataType": "STANDARD_FIELD",
      -                    "label": "Email",
      -                    "required": true,
      -                    "value": "email"
      -                  }
      -                ],
      -                "items": {
      -                  "type": "string"
      -                },
      -                "type": "array"
      -              },
      -              "contactFormSystemMessage": {
      -                "description": "Contact Form System Message",
      -                "example": "Please share contact details",
      -                "type": "string"
      -              },
      -              "defaultConsentCheck": {
      -                "description": "By default consent check for contact form",
      -                "example": true,
      -                "type": "boolean"
      -              },
      -              "enableContactForm": {
      -                "description": "Boolean for showing contact form at start",
      -                "example": true,
      -                "type": "boolean"
      -              },
      -              "fbPage": {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "facebookPageId": {
      -                        "description": "Facebook Page ID",
      -                        "example": "1234567890",
      -                        "type": "string"
      -                      },
      -                      "facebookPageName": {
      -                        "description": "Facebook Page Name",
      -                        "example": "Facebook Page Name",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "description": "Facebook Page",
      -                "example": {
      -                  "facebookPageId": "1234567890",
      -                  "facebookPageName": "My Page"
      -                }
      -              },
      -              "instagramPage": {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "facebookPageId": {
      -                        "description": "Facebook Page ID",
      -                        "example": "1234567890",
      -                        "type": "string"
      -                      },
      -                      "facebookPageName": {
      -                        "description": "Facebook Page Name",
      -                        "example": "Facebook Page Name",
      -                        "type": "string"
      -                      },
      -                      "instagramPageId": {
      -                        "description": "Instagram Page ID",
      -                        "example": "1234567890",
      -                        "type": "string"
      -                      },
      -                      "instagramUsername": {
      -                        "description": "Instagram UserName",
      -                        "example": "Instagram UserName",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "description": "Instagram Page",
      -                "example": {
      -                  "instagramPageId": "1234567890",
      -                  "instagramUsername": "mypage"
      -                }
      -              },
      -              "playNotificationSound": {
      -                "description": "Play Notification Sound",
      -                "example": false,
      -                "type": "boolean"
      -              },
      -              "prefilledMessageText": {
      -                "description": "Prefilled Message Text",
      -                "example": "I want to know more",
      -                "type": "string"
      -              },
      -              "redirect": {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "redirectAction": {
      -                        "description": "Redirect Action",
      -                        "example": false,
      -                        "type": "boolean"
      -                      },
      -                      "redirectText": {
      -                        "description": "Redirect Text",
      -                        "example": "Click here",
      -                        "type": "string"
      -                      },
      -                      "redirectWebsite": {
      -                        "description": "Redirect Website",
      -                        "example": "www.gohighlevel.com",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "description": "Redirect Object",
      -                "example": {
      -                  "redirectAction": false,
      -                  "redirectWebsite": "https://example.com"
      -                }
      -              },
      -              "voiceAiAgent": {
      -                "description": "Voice AI Agent",
      -                "example": {},
      -                "type": "object"
      -              },
      -              "voiceAiSendActionText": {
      -                "description": "Voice Ai Send Action Text",
      -                "example": "Call Now",
      -                "type": "string"
      -              }
      -            },
      -            "type": "object"
      -          }
      -        ],
      -        "description": "Advance Settings",
      -        "example": {
      -          "enableContactForm": true
      -        }
      -      },
      -      "agencyName": {
      -        "description": "Name of the agency",
      -        "example": "Example Agency",
      -        "type": "string"
      -      },
      -      "agencyWebsite": {
      -        "description": "Website URL of the agency",
      -        "example": "https://example.com",
      -        "type": "string"
      -      },
      -      "allowAvatarImage": {
      -        "description": "Allow avatar image",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "autoCountryCode": {
      -        "description": "Boolean indicating whether to automatically detect country code",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "chatIcon": {
      -        "description": "Message Chat Circle",
      -        "example": "messageChatCircle",
      -        "type": "string"
      -      },
      -      "chatType": {
      -        "description": "Chat Type",
      -        "example": "emailChat",
      -        "type": "string"
      -      },
      -      "countryCode": {
      -        "description": "Country code",
      -        "example": "US",
      -        "type": "string"
      -      },
      -      "dimensions": {
      -        "allOf": [
      -          {
      -            "properties": {
      -              "position": {
      -                "description": "Position",
      -                "example": "left",
      -                "type": "string"
      -              },
      -              "sizes": {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "height": {
      -                        "description": "Height",
      -                        "example": 360,
      -                        "type": "number"
      -                      },
      -                      "width": {
      -                        "description": "Width",
      -                        "example": 360,
      -                        "type": "number"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "description": "Typography Color Options",
      -                "example": {
      -                  "height": 600,
      -                  "width": 360
      -                }
      -              }
      -            },
      -            "type": "object"
      -          }
      -        ],
      -        "description": "Customizations",
      -        "example": {
      -          "position": "right"
      -        }
      -      },
      -      "enableRevisitMessage": {
      -        "description": "Boolean indicating whether to enable a revisit message",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "heading": {
      -        "description": "Heading text",
      -        "example": "Welcome to Our Website",
      -        "type": "string"
      -      },
      -      "isPromptAvatarImageOptimize": {
      -        "description": "Avatar Image Optimization",
      -        "example": false,
      -        "type": "boolean"
      -      },
      -      "legalMsg": {
      -        "description": "Legal message",
      -        "example": "By using this website, you agree to our terms and conditions.",
      -        "type": "string"
      -      },
      -      "liveChatAckMsg": {
      -        "description": "Message acknowledging a live chat",
      -        "example": "Thank you for reaching out. How may I assist you today?",
      -        "type": "string"
      -      },
      -      "liveChatEndedMsg": {
      -        "description": "Message indicating the end of a live chat",
      -        "example": "Thank you for chatting with us. Have a great day!",
      -        "type": "string"
      -      },
      -      "liveChatFeedbackMsg": {
      -        "description": "Message asking for feedback after a live chat",
      -        "example": "We would appreciate your feedback. Please rate your experience.",
      -        "type": "string"
      -      },
      -      "liveChatFeedbackNote": {
      -        "description": "Note regarding live chat feedback",
      -        "example": "Your feedback helps us improve our services.",
      -        "type": "string"
      -      },
      -      "liveChatIntroMsg": {
      -        "description": "Introduction message for a live chat",
      -        "example": "Hello! Welcome to our live chat support. How can I assist you today?",
      -        "type": "string"
      -      },
      -      "liveChatUserInactiveMsg": {
      -        "description": "Message for inactive users during a live chat",
      -        "example": "Are you still there? Please let us know if you need assistance.",
      -        "type": "string"
      -      },
      -      "liveChatUserInactiveTime": {
      -        "description": "Time for considering a user inactive during a live chat",
      -        "example": "5 minutes",
      -        "type": "string"
      -      },
      -      "liveChatVisitorInactiveMsg": {
      -        "description": "Message for inactive visitors during a live chat",
      -        "example": "Looks like you stepped away. Feel free to return whenever you need help.",
      -        "type": "string"
      -      },
      -      "liveChatVisitorInactiveTime": {
      -        "description": "Time for considering a visitor inactive during a live chat",
      -        "example": "10 minutes",
      -        "type": "string"
      -      },
      -      "locale": {
      -        "description": "Locale setting",
      -        "example": "en_US",
      -        "type": "string"
      -      },
      -      "locationCountryCode": {
      -        "description": "Location Country Code",
      -        "example": "US",
      -        "type": "string"
      -      },
      -      "promptAvatar": {
      -        "description": "Avatar for prompts",
      -        "example": "avatar.jpg",
      -        "type": "string"
      -      },
      -      "promptAvatarAltText": {
      -        "description": "Prompt Avatar Alt Text",
      -        "example": "company logo",
      -        "type": "string"
      -      },
      -      "promptMsg": {
      -        "description": "Prompt message",
      -        "example": "Need assistance? Feel free to ask us anything!",
      -        "type": "string"
      -      },
      -      "promptType": {
      -        "description": "Prompt Type",
      -        "example": "avatar",
      -        "type": "string"
      -      },
      -      "representativeAssignedMessage": {
      -        "description": "Representative Assigned Message",
      -        "example": "#4285F4",
      -        "type": "string"
      -      },
      -      "revisitPromptMsg": {
      -        "description": "Message for revisiting prompts",
      -        "example": "Welcome back! How can we help you today?",
      -        "type": "string"
      -      },
      -      "sendActionText": {
      -        "description": "Text for send action",
      -        "example": "Send",
      -        "type": "string"
      -      },
      -      "showAgencyBranding": {
      -        "description": "Boolean indicating whether to show agency branding",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "showConsentCheckbox": {
      -        "description": "Boolean indicating whether to show a consent checkbox",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "showLiveChatWelcomeMsg": {
      -        "description": "Boolean indicating whether to show a welcome message for live chat",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "showPrompt": {
      -        "description": "Boolean indicating whether to show prompts",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "subHeading": {
      -        "description": "Subheading text",
      -        "example": "We are here to help you!",
      -        "type": "string"
      -      },
      -      "successMsg": {
      -        "description": "Success message",
      -        "example": "Your message has been sent successfully.",
      -        "type": "string"
      -      },
      -      "supportContact": {
      -        "description": "Contact information for support",
      -        "example": "support@example.com",
      -        "type": "string"
      -      },
      -      "thankYouMsg": {
      -        "description": "Thank you message",
      -        "example": "Thank you for visiting our website!",
      -        "type": "string"
      -      },
      -      "theme": {
      -        "allOf": [
      -          {
      -            "properties": {
      -              "colors": {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "avatarBackgroundColor": {
      -                        "description": "Avatar Background Color",
      -                        "example": "#fffff",
      -                        "type": "string"
      -                      },
      -                      "avatarBorderColor": {
      -                        "description": "Avatar Border Color",
      -                        "example": "#fffff",
      -                        "type": "string"
      -                      },
      -                      "backgroundColor": {
      -                        "description": "Background Color",
      -                        "example": "#fffff",
      -                        "type": "string"
      -                      },
      -                      "buttonColor": {
      -                        "description": "Button Color",
      -                        "example": "#fffff",
      -                        "type": "string"
      -                      },
      -                      "chatBubbleColor": {
      -                        "description": "Chat Bubble Color",
      -                        "example": "#fffff",
      -                        "type": "string"
      -                      },
      -                      "headerColor": {
      -                        "description": "Header Color",
      -                        "example": "#fffff",
      -                        "type": "string"
      -                      },
      -                      "receivedMessageColor": {
      -                        "description": "Received Message Color",
      -                        "example": "#fffff",
      -                        "type": "string"
      -                      },
      -                      "senderMessageColor": {
      -                        "description": "Sender Message Color",
      -                        "example": "#fffff",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "description": "Custom Color Options",
      -                "example": {
      -                  "chatBubbleColor": "#4285F4",
      -                  "name": "theme1"
      -                }
      -              },
      -              "name": {
      -                "description": "Theme Name",
      -                "example": "theme1",
      -                "type": "string"
      -              }
      -            },
      -            "type": "object"
      -          }
      -        ],
      -        "description": "Theme",
      -        "example": {
      -          "name": "theme1"
      -        }
      -      },
      -      "useEmailField": {
      -        "description": "Boolean indicating whether to use an email field",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "waNumber": {
      -        "description": "WhatsApp number",
      -        "example": "+1234567890",
      -        "type": "string"
      -      },
      -      "widgetId": {
      -        "description": "Widget Id",
      -        "example": "92929283937922",
      -        "type": "string"
      -      },
      -      "widgetPlacement": {
      -        "description": "Widget Placement",
      -        "example": "embedded",
      -        "type": "string"
      -      },
      -      "widgetPrimaryColor": {
      -        "description": "Primary color for the widget",
      -        "example": "#4285F4",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "chatType",
      -      "chatIcon"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "acknowledgementDetails": {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "icon": {
      +                "description": "Acknowledgement icon. Either a preset name (`Check`, `CheckCircle`, `MessageDotsCircle`, `MessageSmileSquare`) or an absolute URL to a custom uploaded image.",
      +                "example": "Check",
      +                "oneOf": [
      +                  {
      +                    "enum": [
      +                      "Check",
      +                      "CheckCircle",
      +                      "MessageDotsCircle",
      +                      "MessageSmileSquare"
      +                    ],
      +                    "type": "string"
      +                  },
      +                  {
      +                    "format": "uri",
      +                    "type": "string"
      +                  }
      +                ]
      +              },
      +              "liveChatIcon": {
      +                "description": "Live-chat acknowledgement icon. Either a preset name (`Check`, `CheckCircle`, `MessageDotsCircle`, `MessageSmileSquare`) or an absolute URL to a custom uploaded image.",
      +                "example": "Check",
      +                "oneOf": [
      +                  {
      +                    "enum": [
      +                      "Check",
      +                      "CheckCircle",
      +                      "MessageDotsCircle",
      +                      "MessageSmileSquare"
      +                    ],
      +                    "type": "string"
      +                  },
      +                  {
      +                    "format": "uri",
      +                    "type": "string"
      +                  }
      +                ]
      +              },
      +              "liveChatPlaceholderColor": {
      +                "description": "Placeholder color for live chat",
      +                "example": "#000",
      +                "type": "string"
      +              },
      +              "placeholderColor": {
      +                "description": "Placeholder color",
      +                "example": "#000",
      +                "type": "string"
      +              }
      +            },
      +            "title": "AcknowledgementDetailsDTO",
      +            "type": "object"
      +          }
      +        ],
      +        "description": "Acknowledgement Details",
      +        "example": {}
      +      },
      +      "advanceSettings": {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "addSupportingText": {
      +                "description": "Add Supporting Text",
      +                "example": true,
      +                "type": "boolean"
      +              },
      +              "allInOneChatTypes": {
      +                "description": "All In One Chat Type",
      +                "example": [],
      +                "items": {
      +                  "type": "string"
      +                },
      +                "type": "array"
      +              },
      +              "allInOneInitialMsg": {
      +                "description": "All In One Initial Msg",
      +                "example": "Choose a chat option to get started.",
      +                "type": "string"
      +              },
      +              "allowAttachments": {
      +                "description": "Allow visitors to send attachments (images, PDFs, files) alongside their messages",
      +                "example": true,
      +                "type": "boolean"
      +              },
      +              "allowVoiceNotes": {
      +                "description": "Allow visitors to record and send voice notes from the chat window",
      +                "example": true,
      +                "type": "boolean"
      +              },
      +              "brandingTitle": {
      +                "description": "Branding Title",
      +                "example": "Agency",
      +                "type": "string"
      +              },
      +              "businessOfficeHours": {
      +                "allOf": [
      +                  {
      +                    "properties": {
      +                      "enableBusinessHours": {
      +                        "description": "Enable Business Hours",
      +                        "example": false,
      +                        "type": "boolean"
      +                      },
      +                      "openHours": {
      +                        "description": "Open Hours",
      +                        "example": [
      +                          {
      +                            "daysOfTheWeek": [
      +                              1,
      +                              2,
      +                              3,
      +                              4,
      +                              5
      +                            ],
      +                            "hours": [
      +                              {
      +                                "closeHour": "16",
      +                                "closeMinute": "30",
      +                                "openHour": "09",
      +                                "openMinute": "00"
      +                              }
      +                            ]
      +                          }
      +                        ],
      +                        "items": {
      +                          "properties": {
      +                            "daysOfTheWeek": {
      +                              "description": "Day of week",
      +                              "example": [
      +                                1
      +                              ],
      +                              "items": {
      +                                "type": "string"
      +                              },
      +                              "type": "array"
      +                            },
      +                            "hours": {
      +                              "description": "Hours",
      +                              "example": [
      +                                {
      +                                  "closeHour": "16",
      +                                  "closeMinute": "30",
      +                                  "openHour": "09",
      +                                  "openMinute": "00"
      +                                }
      +                              ],
      +                              "items": {
      +                                "type": "string"
      +                              },
      +                              "type": "array"
      +                            }
      +                          },
      +                          "title": "OpenHoursDTO",
      +                          "type": "object"
      +                        },
      +                        "type": "array"
      +                      },
      +                      "outsideOfficeHoursWelcomeMsg": {
      +                        "description": "Time Zone",
      +                        "example": "Asia/Calcutta",
      +                        "type": "string"
      +                      },
      +                      "timezone": {
      +                        "description": "Time Zone",
      +                        "example": "UTC",
      +                        "type": "string"
      +                      }
      +                    },
      +                    "title": "BusinessOfficeHoursDTO",
      +                    "type": "object"
      +                  }
      +                ],
      +                "description": "Business Office Hours",
      +                "example": {}
      +              },
      +              "contactFormIntroMessage": {
      +                "description": "Contact Form Intro Message",
      +                "example": "Please share contact details",
      +                "type": "string"
      +              },
      +              "contactFormOptions": {
      +                "description": "Ordered list of fields shown on the chat-widget contact form. Standard fields are identified by `value` = `name | phone | email | message`; custom fields use the contact custom-field id.",
      +                "example": [
      +                  {
      +                    "dataType": "TEXT",
      +                    "fieldKey": "contact.name",
      +                    "label": "Name",
      +                    "required": true,
      +                    "value": "name"
      +                  },
      +                  {
      +                    "dataType": "EMAIL",
      +                    "fieldKey": "contact.email",
      +                    "label": "Email",
      +                    "required": true,
      +                    "value": "email"
      +                  },
      +                  {
      +                    "dataType": "PHONE",
      +                    "fieldKey": "contact.phone",
      +                    "label": "Phone",
      +                    "required": false,
      +                    "value": "phone"
      +                  }
      +                ],
      +                "items": {
      +                  "properties": {
      +                    "dataType": {
      +                      "description": "Data type of the field, used to pick the input control and validation.",
      +                      "enum": [
      +                        "TEXT",
      +                        "LARGE_TEXT",
      +                        "TEXTAREA",
      +                        "EMAIL",
      +                        "PHONE",
      +                        "DATE",
      +                        "NUMERICAL",
      +                        "MONETORY",
      +                        "SINGLE_OPTIONS"
      +                      ],
      +                      "example": "EMAIL",
      +                      "type": "string"
      +                    },
      +                    "disabled": {
      +                      "description": "Whether the field is shown but disabled in the form editor.",
      +                      "example": false,
      +                      "type": "boolean"
      +                    },
      +                    "fieldKey": {
      +                      "description": "Dotted field key used to write the value onto the contact (e.g. `contact.email`).",
      +                      "example": "contact.email",
      +                      "type": "string"
      +                    },
      +                    "id": {
      +                      "description": "Client-assigned field identifier; the chat-widget UI round-trips this on save.",
      +                      "example": "1",
      +                      "type": "string"
      +                    },
      +                    "label": {
      +                      "description": "Display label shown next to the field in the form.",
      +                      "example": "Email",
      +                      "type": "string"
      +                    },
      +                    "picklistOptions": {
      +                      "description": "Choices for option-type custom fields (SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX).",
      +                      "example": [
      +                        "Option 1",
      +                        "Option 2"
      +                      ],
      +                      "items": {
      +                        "type": "string"
      +                      },
      +                      "type": "array"
      +                    },
      +                    "placeholder": {
      +                      "description": "Placeholder text rendered inside the input.",
      +                      "example": "Email",
      +                      "type": "string"
      +                    },
      +                    "required": {
      +                      "description": "Whether the field must be filled in to submit the form.",
      +                      "example": true,
      +                      "type": "boolean"
      +                    },
      +                    "value": {
      +                      "description": "Field identifier. For standard fields use one of: `name`, `phone`, `email`, `message`. For custom fields use the contact custom-field id.",
      +                      "example": "email",
      +                      "type": "string"
      +                    }
      +                  },
      +                  "title": "ContactFormOptionsDTO",
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "contactFormSystemMessage": {
      +                "description": "Contact Form System Message",
      +                "example": "Please share contact details",
      +                "type": "string"
      +              },
      +              "defaultConsentCheck": {
      +                "description": "By default consent check for contact form",
      +                "example": true,
      +                "type": "boolean"
      +              },
      +              "enableContactForm": {
      +                "description": "Boolean for showing contact form at start",
      +                "example": true,
      +                "type": "boolean"
      +              },
      +              "fbPage": {
      +                "allOf": [
      +                  {
      +                    "properties": {
      +                      "facebookPageId": {
      +                        "description": "Facebook Page ID",
      +                        "example": "1234567890",
      +                        "type": "string"
      +                      },
      +                      "facebookPageName": {
      +                        "description": "Facebook Page Name",
      +                        "example": "Facebook Page Name",
      +                        "type": "string"
      +                      }
      +                    },
      +                    "title": "FBPageDTO",
      +                    "type": "object"
      +                  }
      +                ],
      +                "description": "Facebook Page",
      +                "example": {}
      +              },
      +              "instagramPage": {
      +                "allOf": [
      +                  {
      +                    "properties": {
      +                      "facebookPageId": {
      +                        "description": "Facebook Page ID",
      +                        "example": "1234567890",
      +                        "type": "string"
      +                      },
      +                      "facebookPageName": {
      +                        "description": "Facebook Page Name",
      +                        "example": "Facebook Page Name",
      +                        "type": "string"
      +                      },
      +                      "instagramPageId": {
      +                        "description": "Instagram Page ID",
      +                        "example": "1234567890",
      +                        "type": "string"
      +                      },
      +                      "instagramUsername": {
      +                        "description": "Instagram UserName",
      +                        "example": "Instagram UserName",
      +                        "type": "string"
      +                      }
      +                    },
      +                    "title": "InstagramPageDTO",
      +                    "type": "object"
      +                  }
      +                ],
      +                "description": "Instagram Page",
      +                "example": {}
      +              },
      +              "playNotificationSound": {
      +                "description": "Play Notification Sound",
      +                "example": false,
      +                "type": "boolean"
      +              },
      +              "prefilledMessageText": {
      +                "description": "Prefilled Message Text",
      +                "example": "I want to know more",
      +                "type": "string"
      +              },
      +              "redirect": {
      +                "allOf": [
      +                  {
      +                    "properties": {
      +                      "redirectAction": {
      +                        "description": "Redirect Action",
      +                        "example": false,
      +                        "type": "boolean"
      +                      },
      +                      "redirectText": {
      +                        "description": "Redirect Text",
      +                        "example": "Click here",
      +                        "type": "string"
      +                      },
      +                      "redirectWebsite": {
      +                        "description": "Redirect Website",
      +                        "example": "www.example.com",
      +                        "type": "string"
      +                      }
      +                    },
      +                    "title": "RedirectDTO",
      +                    "type": "object"
      +                  }
      +                ],
      +                "description": "Redirect Object",
      +                "example": {}
      +              },
      +              "supportingText": {
      +                "description": "Supporting Text",
      +                "example": "We are here to help you",
      +                "type": "string"
      +              },
      +              "voiceAiAgent": {
      +                "description": "Voice AI Agent",
      +                "example": {},
      +                "type": "object"
      +              },
      +              "voiceAiAnimation": {
      +                "description": "Voice AI Animation ID. Only \"1\" is supported for now.",
      +                "enum": [
      +                  "1"
      +                ],
      +                "example": "1",
      +                "type": "string"
      +              },
      +              "voiceAiAnimationColor": {
      +                "description": "Voice AI animation visualiser color",
      +                "example": "#155EEF",
      +                "type": "string"
      +              },
      +              "voiceAiAnimationSize": {
      +                "description": "Voice AI animation size for the embedded visualiser orb",
      +                "enum": [
      +                  "sm",
      +                  "md",
      +                  "lg"
      +                ],
      +                "example": "md",
      +                "type": "string"
      +              },
      +              "voiceAiDisplayMode": {
      +                "description": "Voice AI display mode",
      +                "enum": [
      +                  "avatar",
      +                  "visualiser"
      +                ],
      +                "example": "avatar",
      +                "type": "string"
      +              },
      +              "voiceAiSendActionText": {
      +                "description": "Voice Ai Send Action Text",
      +                "example": "Call Now",
      +                "type": "string"
      +              }
      +            },
      +            "title": "AdvanceSettingsDTO",
      +            "type": "object"
      +          }
      +        ],
      +        "description": "Advance Settings",
      +        "example": {}
      +      },
      +      "agencyName": {
      +        "description": "Name of the agency",
      +        "example": "Example Agency",
      +        "type": "string"
      +      },
      +      "agencyWebsite": {
      +        "description": "Website URL of the agency",
      +        "example": "https://example.com",
      +        "type": "string"
      +      },
      +      "allowAvatarImage": {
      +        "description": "Allow avatar image",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "autoCountryCode": {
      +        "description": "Boolean indicating whether to automatically detect country code",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "chatIcon": {
      +        "description": "Icon shown on the closed chat bubble. Either a preset name (`messageChatCircle`, `messageChatSquare`, `messageSquare`, `messageDotsCircle`, `messageWhatsApp`, `phoneCall01`, `phone`, `phoneOutgoing02`, `fbMessenger`, `instagram`) or an absolute URL to a custom uploaded image.",
      +        "example": "messageChatCircle",
      +        "oneOf": [
      +          {
      +            "enum": [
      +              "messageChatCircle",
      +              "messageChatSquare",
      +              "messageSquare",
      +              "messageDotsCircle",
      +              "messageWhatsApp",
      +              "phoneCall01",
      +              "phone",
      +              "phoneOutgoing02",
      +              "fbMessenger",
      +              "instagram"
      +            ],
      +            "type": "string"
      +          },
      +          {
      +            "format": "uri",
      +            "type": "string"
      +          }
      +        ]
      +      },
      +      "chatType": {
      +        "description": "Chat Type. The public API supports only liveChat and emailChat; any other value is rejected with a 422.",
      +        "enum": [
      +          "liveChat",
      +          "emailChat"
      +        ],
      +        "example": "emailChat",
      +        "type": "string"
      +      },
      +      "countryCode": {
      +        "description": "Country code",
      +        "example": "US",
      +        "type": "string"
      +      },
      +      "dimensions": {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "position": {
      +                "description": "Widget anchor position on the host page (kebab-case).",
      +                "enum": [
      +                  "top-left",
      +                  "top-right",
      +                  "middle-left",
      +                  "middle-right",
      +                  "bottom-left",
      +                  "bottom-right"
      +                ],
      +                "example": "bottom-right",
      +                "type": "string"
      +              },
      +              "sizes": {
      +                "allOf": [
      +                  {
      +                    "properties": {
      +                      "height": {
      +                        "description": "Height in pixels. Accepts a number (640), a CSS length (\"600px\"), or \"\" for auto.",
      +                        "example": 640,
      +                        "oneOf": [
      +                          {
      +                            "type": "number"
      +                          },
      +                          {
      +                            "type": "string"
      +                          }
      +                        ]
      +                      },
      +                      "width": {
      +                        "description": "Width in pixels. Accepts a number (360), a CSS length (\"600px\"), or \"\" for auto.",
      +                        "example": 360,
      +                        "oneOf": [
      +                          {
      +                            "type": "number"
      +                          },
      +                          {
      +                            "type": "string"
      +                          }
      +                        ]
      +                      }
      +                    },
      +                    "title": "WidgetSettingsCustomizationSizeDTO",
      +                    "type": "object"
      +                  }
      +                ],
      +                "description": "Widget dimensions (width/height)",
      +                "example": {}
      +              }
      +            },
      +            "title": "WidgetSettingsCustomizationDTO",
      +            "type": "object"
      +          }
      +        ],
      +        "description": "Customizations",
      +        "example": {}
      +      },
      +      "enableRevisitMessage": {
      +        "description": "Boolean indicating whether to enable a revisit message",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "heading": {
      +        "description": "Heading text",
      +        "example": "Welcome to Our Website",
      +        "type": "string"
      +      },
      +      "isPromptAvatarImageOptimize": {
      +        "description": "Avatar Image Optimization",
      +        "example": false,
      +        "type": "boolean"
      +      },
      +      "legalMsg": {
      +        "description": "Legal message",
      +        "example": "By using this website, you agree to our terms and conditions.",
      +        "type": "string"
      +      },
      +      "liveChatAckMsg": {
      +        "description": "Message acknowledging a live chat",
      +        "example": "Thank you for reaching out. How may I assist you today?",
      +        "type": "string"
      +      },
      +      "liveChatEndedMsg": {
      +        "description": "Message indicating the end of a live chat",
      +        "example": "Thank you for chatting with us. Have a great day!",
      +        "type": "string"
      +      },
      +      "liveChatFeedbackMsg": {
      +        "description": "Message asking for feedback after a live chat",
      +        "example": "We would appreciate your feedback. Please rate your experience.",
      +        "type": "string"
      +      },
      +      "liveChatFeedbackNote": {
      +        "description": "Note regarding live chat feedback",
      +        "example": "Your feedback helps us improve our services.",
      +        "type": "string"
      +      },
      +      "liveChatIntroMsg": {
      +        "description": "Introduction message for a live chat",
      +        "example": "Hello! Welcome to our live chat support. How can I assist you today?",
      +        "type": "string"
      +      },
      +      "liveChatUserInactiveMsg": {
      +        "description": "Message for inactive users during a live chat",
      +        "example": "Are you still there? Please let us know if you need assistance.",
      +        "type": "string"
      +      },
      +      "liveChatUserInactiveTime": {
      +        "description": "Time for considering a user inactive during a live chat",
      +        "example": "5 minutes",
      +        "type": "string"
      +      },
      +      "liveChatVisitorInactiveMsg": {
      +        "description": "Message for inactive visitors during a live chat",
      +        "example": "Looks like you stepped away. Feel free to return whenever you need help.",
      +        "type": "string"
      +      },
      +      "liveChatVisitorInactiveTime": {
      +        "description": "Time for considering a visitor inactive during a live chat",
      +        "example": "10 minutes",
      +        "type": "string"
      +      },
      +      "loadStrategy": {
      +        "description": "Load strategy for the embed script: \"immediate\" loads on page load (default), \"interaction\" defers until user interacts.",
      +        "enum": [
      +          "immediate",
      +          "interaction"
      +        ],
      +        "example": "interaction",
      +        "type": "string"
      +      },
      +      "locale": {
      +        "description": "Locale setting. Use \"location\" to inherit from the location's locale, or \"auto\" to detect from the visitor's browser. Otherwise pick a BCP 47 tag in hyphen-lowercase form.",
      +        "enum": [
      +          "location",
      +          "auto",
      +          "en-us",
      +          "en-gb",
      +          "de",
      +          "fr-fr",
      +          "nl",
      +          "hu",
      +          "pt-pt",
      +          "pt-br",
      +          "es",
      +          "fr-ca",
      +          "hr",
      +          "it",
      +          "sv-se",
      +          "da-dk",
      +          "fi",
      +          "no"
      +        ],
      +        "example": "en-us",
      +        "type": "string"
      +      },
      +      "locationCountryCode": {
      +        "description": "Location Country Code",
      +        "example": "US",
      +        "type": "string"
      +      },
      +      "promptAvatar": {
      +        "description": "Avatar for prompts",
      +        "example": "avatar.jpg",
      +        "type": "string"
      +      },
      +      "promptAvatarAltText": {
      +        "description": "Prompt Avatar Alt Text",
      +        "example": "company logo",
      +        "type": "string"
      +      },
      +      "promptMsg": {
      +        "description": "Prompt message",
      +        "example": "Need assistance? Feel free to ask us anything!",
      +        "type": "string"
      +      },
      +      "promptType": {
      +        "description": "Chat bubble style — \"avatar\" shows the agent avatar, \"normal\" shows a plain bubble.",
      +        "enum": [
      +          "avatar",
      +          "normal"
      +        ],
      +        "example": "avatar",
      +        "type": "string"
      +      },
      +      "representativeAssignedMessage": {
      +        "description": "Representative Assigned Message",
      +        "example": "#4285F4",
      +        "type": "string"
      +      },
      +      "revisitPromptMsg": {
      +        "description": "Message for revisiting prompts",
      +        "example": "Welcome back! How can we help you today?",
      +        "type": "string"
      +      },
      +      "sendActionText": {
      +        "description": "Text for send action",
      +        "example": "Send",
      +        "type": "string"
      +      },
      +      "showAgencyBranding": {
      +        "description": "Boolean indicating whether to show agency branding",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "showConsentCheckbox": {
      +        "description": "Boolean indicating whether to show a consent checkbox",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "showLiveChatWelcomeMsg": {
      +        "description": "Boolean indicating whether to show a welcome message for live chat",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "showPrompt": {
      +        "description": "Boolean indicating whether to show prompts",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "subHeading": {
      +        "description": "Subheading text",
      +        "example": "We are here to help you!",
      +        "type": "string"
      +      },
      +      "successMsg": {
      +        "description": "Success message",
      +        "example": "Your message has been sent successfully.",
      +        "type": "string"
      +      },
      +      "supportContact": {
      +        "description": "Contact information for support",
      +        "example": "support@example.com",
      +        "type": "string"
      +      },
      +      "thankYouMsg": {
      +        "description": "Thank you message",
      +        "example": "Thank you for visiting our website!",
      +        "type": "string"
      +      },
      +      "theme": {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "colors": {
      +                "allOf": [
      +                  {
      +                    "properties": {
      +                      "avatarBackgroundColor": {
      +                        "description": "Avatar Background Color",
      +                        "example": "#fffff",
      +                        "type": "string"
      +                      },
      +                      "avatarBorderColor": {
      +                        "description": "Avatar Border Color",
      +                        "example": "#fffff",
      +                        "type": "string"
      +                      },
      +                      "backgroundColor": {
      +                        "description": "Background Color",
      +                        "example": "#fffff",
      +                        "type": "string"
      +                      },
      +                      "buttonColor": {
      +                        "description": "Button Color",
      +                        "example": "#fffff",
      +                        "type": "string"
      +                      },
      +                      "chatBubbleColor": {
      +                        "description": "Chat Bubble Color",
      +                        "example": "#fffff",
      +                        "type": "string"
      +                      },
      +                      "headerColor": {
      +                        "description": "Header Color",
      +                        "example": "#fffff",
      +                        "type": "string"
      +                      },
      +                      "receivedMessageColor": {
      +                        "description": "Received Message Color",
      +                        "example": "#fffff",
      +                        "type": "string"
      +                      },
      +                      "senderMessageColor": {
      +                        "description": "Sender Message Color",
      +                        "example": "#fffff",
      +                        "type": "string"
      +                      }
      +                    },
      +                    "title": "WidgetSettingsThemeCustomColorDTO",
      +                    "type": "object"
      +                  }
      +                ],
      +                "description": "Custom Color Options",
      +                "example": {}
      +              },
      +              "name": {
      +                "description": "Theme preset name. Use \"custom\" together with a colors/typography object to override.",
      +                "enum": [
      +                  "blue",
      +                  "teal",
      +                  "tan",
      +                  "lavender",
      +                  "golden",
      +                  "instagram",
      +                  "facebook",
      +                  "custom"
      +                ],
      +                "example": "blue",
      +                "type": "string"
      +              },
      +              "typography": {
      +                "allOf": [
      +                  {
      +                    "properties": {
      +                      "colors": {
      +                        "allOf": [
      +                          {
      +                            "properties": {
      +                              "headerMessageTextColor": {
      +                                "description": "Header Message Text Color",
      +                                "example": "#fffff",
      +                                "type": "string"
      +                              },
      +                              "receivedMessageTextColor": {
      +                                "description": "Received Message Text Color",
      +                                "example": "#fffff",
      +                                "type": "string"
      +                              },
      +                              "senderMessageTextColor": {
      +                                "description": "Sender Message Text Color",
      +                                "example": "#fffff",
      +                                "type": "string"
      +                              },
      +                              "systemMessageTextColor": {
      +                                "description": "System Message Text Color",
      +                                "example": "#fffff",
      +                                "type": "string"
      +                              },
      +                              "welcomeMessageTextColor": {
      +                                "description": "Welcome Message Text Color",
      +                                "example": "#fffff",
      +                                "type": "string"
      +                              }
      +                            },
      +                            "title": "WidgetSettingsTypographyColorDTO",
      +                            "type": "object"
      +                          }
      +                        ],
      +                        "description": "Typography Color Options",
      +                        "example": {}
      +                      },
      +                      "fontFamily": {
      +                        "description": "Font Family",
      +                        "example": "inter",
      +                        "type": "string"
      +                      }
      +                    },
      +                    "title": "WidgetSettingsTypographyDTO",
      +                    "type": "object"
      +                  }
      +                ],
      +                "description": "Typography Options",
      +                "example": {}
      +              },
      +              "value": {
      +                "description": "Resolved theme value / preset identifier persisted alongside the preset name.",
      +                "example": "blue",
      +                "type": "string"
      +              }
      +            },
      +            "title": "WidgetSettingsThemeDTO",
      +            "type": "object"
      +          }
      +        ],
      +        "description": "Theme",
      +        "example": {}
      +      },
      +      "waNumber": {
      +        "description": "WhatsApp number",
      +        "example": "+1234567890",
      +        "type": "string"
      +      },
      +      "widgetPlacement": {
      +        "description": "Widget Placement. \"sticky\" keeps the widget pinned to a page corner; \"embedded\" renders inline within the host page.",
      +        "enum": [
      +          "sticky",
      +          "embedded"
      +        ],
      +        "example": "embedded",
      +        "type": "string"
      +      },
      +      "widgetPrimaryColor": {
      +        "description": "Primary color for the widget",
      +        "example": "#4285F4",
      +        "type": "string"
      +      }
      +    },
      +    "title": "WidgetSettingsDTO",
      +    "type": "object"
      +  }
      +]
    • removedInput schema / properties / body / properties / settings / example / chatType
      Removed value: -"emailChat"
    • addedInput schema / properties / body / properties / settings / example / heading
      Added value: +"Welcome to Acme"
    • addedInput schema / properties / body / properties / settings / example / locale
      Added value: +"en-us"
    • addedInput schema / properties / body / properties / settings / example / promptType
      Added value: +"avatar"
    • addedInput schema / properties / body / properties / settings / example / theme
      Added value: +{
      +  "name": "blue"
      +}
    • addedInput schema / properties / body / properties / settings / example / widgetPrimaryColor
      Added value: +"#4285F4"
    • addedInput schema / properties / body / title
      Added value: +"UpdateWidgetDTO"
  2. First observedv2.0.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=true), and the description adds genuinely useful context beyond them: the exact HTTP method/path, API version header, required Sub-Account token, and the OAuth scope needed. It stops short of the one thing that matters most for a PATCH on a deeply nested body — whether unspecified nested fields (e.g. settings.theme.colors) are merged or replaced.

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 verb+resource before endpoint and auth details. The OpenAPI source-file reference (v3/chat-widget-v3.json) is provenance noise rather than agent-usable information, which keeps it just below a 5.

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?

Auth, scope, endpoint, and version are all covered, which is more than many siblings offer, and there is no output schema to explain. But for a mutation tool with a very large nested body and no annotations about reversibility, the missing description of partial-merge behavior and of the response payload leaves an agent under-informed about the operation's actual effect.

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 schema already documents id, locationId, and the entire nested body. The description only echoes the path templating ({locationId}/{id}) and adds no merge/patch semantics or required-vs-optional field guidance beyond it. Baseline 3 is appropriate when the schema carries the full burden.

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 ("applies a partial update to an existing chat widget") and names the concrete endpoint, so the agent knows this is a mutation on an existing widget. It does not explicitly contrast with the sibling ghl_chat_widget_update (full replace) or ghl_chat_widget_create, leaving the partial-vs-full distinction to inference from the word "partial".

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?

The word "partial" implies when to choose this over a full update, and the description states the auth prerequisite (Sub-Account/location token, scope chat-widget.write). However, no explicit when-to-use vs ghl_chat_widget_update or when-not guidance is given, so routing between the chat-widget siblings still requires guessing.

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