Skip to main content
Glama
benpalmer1

Gorgias MCP Server

by benpalmer1

Delete Customer Field Value

gorgias_delete_customer_field_value
DestructiveIdempotent

Remove a custom field value from a customer by specifying the customer ID and field ID. Use this to clear an assigned value without deleting the field definition.

Instructions

DELETE /api/customers/{customer_id}/custom-fields/{id} — Remove a custom field value from a customer. This removes the value assignment on the customer — it does NOT delete the custom field definition. The path 'id' is the custom field definition ID (field.id from GET /api/customers/{customer_id}/custom-fields). Returns 204 No Content on success.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe custom field definition ID (field.id from GET /api/customers/{customer_id}/custom-fields)
customer_idYesThe ID of the customer whose custom field value is to be deleted.
Behavior4/5

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

Annotations already indicate destructive behavior and idempotence. The description adds valuable context by explicitly stating the scope of deletion (value assignment only) and the success status code (204 No Content), which goes beyond the annotations and clarifies the tool's actual effect.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise, starting with the HTTP method and endpoint, followed by a clear explanation of the operation, a key distinction from related operations, and the expected response. Every sentence adds value with no redundancy.

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

Completeness5/5

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

For a simple two-parameter delete tool with no output schema, the description covers the essential behavioral details: the exact effect, the non-effect, and the success response. Combined with the annotations, it provides a complete picture for an agent to invoke the tool correctly.

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 parameters are fully documented in the schema. The description reinforces the meaning of 'id' but doesn't add new information beyond the schema, making it a baseline score.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly states the verb 'Remove' and the resource 'custom field value from a customer', clearly distinguishing it from deleting the custom field definition. The HTTP method and path are also given, making the tool's purpose unambiguous.

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

Usage Guidelines4/5

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

The description provides a clear 'when-not' by stating 'it does NOT delete the custom field definition', which helps prevent a common misuse. It also clarifies the id parameter references the definition ID, but it doesn't explicitly name alternative tools or broader usage context, earning a 4 rather than 5.

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/benpalmer1/Gorgias-MCP-Server'

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