Chatway Live Chat

Remove Custom Data

remove-custom-data

Destructive

Remove a named custom-field value from a Chatway visitor/contact. Use update-custom-data instead when the value should change rather than be removed.

Input Schema

Name	Required	Description	Default
`name`	Yes	Name of the custom field whose value should be removed.
`visitor_id`	Yes	UUID of the visitor/contact, for example `contact.id` from `get-conversation` or `id` from `search-contacts`.

Output Schema

Name	Required	Description	Default
`visitor_id`	No	Visitor/contact UUID.
`removed_field`	No	Name of the removed custom field.

Schema Changelog

Changes observed during successful MCP inspections.

Changed6 schema fields changedNov 6, 2026

removedInput schema / properties / confirmation_token

Removed value: -{
-  "description": "Required after the confirmation challenge. Ask the user to approve before calling again with this token.",
-  "type": "string"
-}

removedOutput schema / properties / affected_count

Removed value: -{
-  "description": "Number of records the action will change.",
-  "type": "integer"
-}

removedOutput schema / properties / confirmation_required

Removed value: -{
-  "description": "True when the user must approve before the action runs.",
-  "type": "boolean"
-}

removedOutput schema / properties / confirmation_token

Removed value: -{
-  "description": "Pass back as confirmation_token after the user approves.",
-  "type": "string"
-}

removedOutput schema / properties / expires_in_seconds

Removed value: -{
-  "description": "How long the confirmation token stays valid.",
-  "type": "integer"
-}

removedOutput schema / properties / message

Removed value: -{
-  "description": "Message describing the action or its result.",
-  "type": "string"
-}

Changed4 schema fields changedOct 15, 2026

addedInput schema / properties / confirmation_token / description

Added value: +"Required after the confirmation challenge. Ask the user to approve before calling again with this token."

addedInput schema / properties / name / description

Added value: +"Name of the custom field whose value should be removed."

addedInput schema / properties / visitor_id / description

Added value: +"UUID of the visitor/contact, for example `contact.id` from `get-conversation` or `id` from `search-contacts`."

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "affected_count": {
+      "description": "Number of records the action will change.",
+      "type": "integer"
+    },
+    "confirmation_required": {
+      "description": "True when the user must approve before the action runs.",
+      "type": "boolean"
+    },
+    "confirmation_token": {
+      "description": "Pass back as confirmation_token after the user approves.",
+      "type": "string"
+    },
+    "expires_in_seconds": {
+      "description": "How long the confirmation token stays valid.",
+      "type": "integer"
+    },
+    "message": {
+      "description": "Message describing the action or its result.",
+      "type": "string"
+    },
+    "removed_field": {
+      "description": "Name of the removed custom field.",
+      "type": "string"
+    },
+    "visitor_id": {
+      "description": "Visitor/contact UUID.",
+      "type": "string"
+    }
+  },
+  "type": "object"
+}

First observedOct 15, 2026

TDQS

A4/5.0

Behavior3/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false and idempotentHint=false, so the safety profile is covered structurally. The description adds the useful scoping nuance that only the value is removed, not the field itself, but it never says whether the call fails or silently no-ops when the field is absent, nor whether removal is reversible — gaps that matter for a destructive tool.

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?

Two tight sentences: the action and scope come first, the alternative routing second. No filler or restated title text.

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?

An output schema exists and both parameters are fully documented, so the description does not need to explain return values. For a destructive two-parameter mutation, the only missing piece is the error/no-op behavior when the named field is not present on the visitor.

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%, including a concrete hint that visitor_id comes from `get-conversation` or `search-contacts`. The description adds no further semantics about the parameters, so the baseline 3 applies with the schema doing all the work.

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?

States a specific verb (remove) and a precisely scoped resource (a named custom-field value on a Chatway visitor/contact). The phrasing 'custom-field value' distinguishes it from deleting a field definition, and the tool is clearly differentiable from add-custom-data and update-custom-data.

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?

Explicitly routes the agent to `update-custom-data` when the value should change rather than be removed, which is the primary ambiguity for this operation. It does not address the related case of a value that does not yet exist, where `add-custom-data` would be the correct sibling, so one meaningful branch is left unstated.

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

All Chatway Live Chat tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?