Skip to main content
Glama
zackscriven

ghl-mcp-server-v2

by zackscriven

ghl_chat_widget_patch

Patch a chat widget resource to update its properties, including chat type, theme, settings, and compliance options.

Instructions

Patch Chat Widget Partial update of a chat widget resource. Endpoint: PATCH /chat-widget/data/{locationId}/{id} (Version header: v3; source: v3/chat-widget-v3.json) OAuth scopes: chat-widget.write

Input Schema

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

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

Annotations already indicate non-destructive, non-read-only behavior. The description adds OAuth scopes and endpoint version, but does not clarify partial update semantics (e.g., that missing fields are unchanged) or potential side effects. No contradiction with annotations.

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-loaded with the core purpose. The endpoint and OAuth scopes are useful but could be integrated more naturally. Every sentence earns its place.

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

Completeness3/5

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

For a mutation tool with a complex nested body, the description lacks information on return values, error handling, and the effect of partial updates on unspecified fields. No output schema is provided, so more context is needed.

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?

Input schema has 100% coverage with detailed descriptions for all parameters. The description adds no additional semantic meaning beyond what's in the schema, so baseline score of 3 is appropriate.

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 'Partial update of a chat widget resource,' which clearly identifies the action and resource. However, it does not differentiate from sibling tools like ghl_chat_widget_create or ghl_chat_widget_update, so it misses explicit differentiation.

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?

No guidance on when to use this tool versus alternatives (e.g., ghl_chat_widget_update for full updates). There is no mention of prerequisites, when not to use, or context that helps an agent decide.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/zackscriven/ghl-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server