Skip to main content
Glama

Add Private Note

add-note

Add a private internal note to a Chatway conversation. The note is visible to authorized teammates and is not sent to the customer. Use send-message instead when the customer should see the text.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contentYesPrivate note text, up to 10,000 characters. Only visible to teammates.
conversation_idYesUUID of the conversation to add the note to.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / content / description
      Previous value: -"Private note content."New value: +"Private note text, up to 10,000 characters. Only visible to teammates."
    • addedInput schema / properties / conversation_id / description
      Added value: +"UUID of the conversation to add the note to."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "note": {
      +      "properties": {
      +        "content": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "conversation_id": {
      +          "type": "string"
      +        },
      +        "created_at": {
      +          "description": "ISO 8601 timestamp.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "id": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations only cover the safety profile (readOnlyHint=false, destructiveHint=false, openWorldHint=true); the description adds the key behavioral fact that the note is not sent to the customer and is visible to authorized teammates. It does not discuss idempotency or whether an existing note is appended versus replaced, which keeps it short of a 5.

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 sentences, front-loaded with the action and the visibility semantics, ending with the disambiguation rule. Nothing is redundant and nothing is padding.

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, both required parameters are fully documented, and the audience/visibility semantics plus sibling routing cover what an agent needs to invoke this 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% and both parameters are documented in the schema, including the 10,000-character cap on content. The description adds no parameter-level meaning beyond what the schema already provides, so the baseline 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 (add) and resource (private internal note) scoped to a Chatway conversation, and explicitly contrasts it with the sibling send-message. An agent can distinguish this from send-message 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?

It gives an explicit routing rule: use send-message when the customer should see the text, implying use this tool when they should not. The when-not condition is stated directly rather than left to inference.

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