Skip to main content
Glama

Add Custom Data

add-custom-data
Destructive

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 list-custom-fields to see existing field names.

Input Schema

NameRequiredDescriptionDefault
nameYesCustom field name, up to 100 characters. The field is created if it does not exist yet.
valueYesValue to store, up to 1,000 characters.
visitor_idYesUUID of the visitor/contact, for example `contact.id` from `get-conversation` or `id` from `search-contacts`.

Output Schema

NameRequiredDescriptionDefault
nameNoCustom field name.
valueNoStored value.
visitor_idNoVisitor/contact UUID.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • 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"
      +}
  2. First observed

TDQS

A4.2/5.0
Behavior3/5

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

The annotations already declare destructiveHint=true, idempotentHint=false, openWorldHint=false, so the safety profile is carried by structured data. The description adds useful context (a field is created when missing) but never warns that setting a value on an existing field overwrites it, which is exactly what a destructiveHint=true mutation tool should flag.

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, with the primary action front-loaded, then the entry-condition alternative, then the discovery tool. No sentence is redundant.

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?

For a 3-required-parameter mutation with a full output schema and safety annotations, the description covers what to do, when to pick a sibling, and how to find field names. The only real gap is the silent-overwrite behavior on an existing field, which matters given destructiveHint=true.

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 the descriptions already document the 100-character name limit, 1,000-character value limit, and how to obtain the visitor UUID. The description adds no syntax or format detail beyond the schema, so the baseline of 3 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?

The description states a specific verb and resource ('Create a custom field ... and set its value') on a named target ('Chatway visitor/contact'), and it explicitly distinguishes itself from the two closest siblings, update-custom-data and list-custom-fields.

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?

It names both alternatives and the exact condition that selects each: use update-custom-data when the field already exists, use list-custom-fields to discover existing field names. This leaves nothing to be inferred.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources