Chatway Live Chat

Remove Custom Data

remove-custom-data

Destructive

Remove a named custom-field value from a Chatway visitor/contact. This is destructive and requires user confirmation. Use update-custom-data instead when the value should change rather than be removed.

Input Schema

TableJSON Schema

Name	Required	Description
`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`.
`confirmation_token`	No	Required after the confirmation challenge. Ask the user to approve before calling again with this token.

Output Schema

TableJSON Schema

Name	Required	Description
`message`	No	Message describing the action or its result.
`visitor_id`	No	Visitor/contact UUID.
`removed_field`	No	Name of the removed custom field.
`affected_count`	No	Number of records the action will change.
`confirmation_token`	No	Pass back as confirmation_token after the user approves.
`expires_in_seconds`	No	How long the confirmation token stays valid.
`confirmation_required`	No	True when the user must approve before the action runs.

Schema Changelog

Changes observed during successful MCP inspections.

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/5.0

Behavior4/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false, so the safety profile is covered. The description still adds real value by stating the confirmation requirement and the two-step resubmission flow (reinforced by the confirmation_token parameter), but it does not clarify side effects beyond the named field value or any auth/rate-limit constraints.

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?

Three short sentences, zero filler. The core action is front-loaded, the destructive/confirmation caveat follows, and the alternative routing comes last where an agent will look for it.

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?

An output schema exists, so return values need no explanation. For a destructive mutation the description covers the action, the target scope, the confirmation workflow, and the sibling alternative — everything needed to invoke it safely.

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 includes a concrete example for visitor_id, so the schema already carries parameter meaning. The description only echoes the `name` field implicitly via 'named custom-field value' and adds no syntax or format detail beyond the schema. Baseline 3 is appropriate.

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) plus the exact resource and scope: a named custom-field value on a Chatway visitor/contact. It explicitly distinguishes itself from the sibling `update-custom-data`, so an agent can route correctly without opening either schema.

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

Usage Guidelines5/5

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

Gives explicit when-to-use guidance by naming the alternative (`update-custom-data`) and the condition that selects it (value should change rather than be removed). It also flags the pre-call requirement of user confirmation, leaving nothing to inference.

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?