Chatway Live Chat

Add Custom Data

add-custom-data

Create a custom field, if necessary, and set its value on a Chatway visitor/contact. Use update-custom-data when the field already exists. Use view-custom-fields to see existing field names.

Input Schema

TableJSON Schema

Name	Required	Description
`name`	Yes	Custom field name, up to 100 characters. The field is created if it does not exist yet.
`value`	Yes	Value to store, up to 1,000 characters.
`visitor_id`	Yes	UUID of the visitor/contact, for example `contact.id` from `get-conversation` or `id` from `search-contacts`.

Output Schema

TableJSON Schema

Name	Required	Description
`name`	No	Custom field name.
`value`	No	Stored value.
`visitor_id`	No	Visitor/contact UUID.

Schema Changelog

Changes observed during successful MCP inspections.

Changed4 schema fields changedOct 15, 2026

addedInput schema / properties / name / description

Added value: +"Custom field name, up to 100 characters. The field is created if it does not exist yet."

addedInput schema / properties / value / description

Added value: +"Value to store, up to 1,000 characters."

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": {
+    "name": {
+      "description": "Custom field name.",
+      "type": "string"
+    },
+    "value": {
+      "description": "Stored value.",
+      "type": "string"
+    },
+    "visitor_id": {
+      "description": "Visitor/contact UUID.",
+      "type": "string"
+    }
+  },
+  "type": "object"
+}

First observedOct 15, 2026

TDQS

A4.3/5.0

Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds the meaningful create-if-missing (upsert) behavior, but that same fact is already repeated in the `name` parameter description, and nothing is said about side effects on the visitor record or the response shape. Modest value beyond structured fields.

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, with the primary action front-loaded and the disambiguation rules following immediately. Every sentence earns its place.

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?

With an output schema present and full annotation coverage, the description only needs to convey purpose, routing and input meaning, all of which it does. Nothing an agent needs to invoke this correctly is missing.

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 all three parameters are well documented, including length limits and where `visitor_id` comes from (contact.id from `get-conversation`, id from `search-contacts`). The description adds no parameter-level detail beyond that, so the baseline applies.

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 and resource ('Create a custom field... and set its value on a Chatway visitor/contact'), and explicitly differentiates itself from the near-identical sibling `update-custom-data`. An agent can pick the right tool without opening the 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 routing rules: use `update-custom-data` when the field already exists, and `view-custom-fields` to discover field names. This is when-to-use plus named alternatives, exactly what prevents sibling confusion in this cluster.

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?