Skip to main content
Glama

Update transaction category rule

well_update_transaction_category_rule
Destructive

Save one category rule for the current workspace. This changes the written rule for the category and changes the context hash read by Well's category rule reader.

Use this only when a workspace member directly tells Well how to file one named category. Do not use it to answer a question about a rule, or when the person says not to change anything; read the rule with well_get_column_rule instead. Use the exact short category name the person gave, in English or French, and keep the rule to what they said. If the name is not an exact category name, ask which category they mean.

REQUIRED: category, the exact short category name; rule, one line stating what belongs or does not belong in it.

The call asks for confirmation in chat. On WhatsApp, a complete direct typed order may save at once. Say it was saved only after a successful result. Returns the category key and saved rule, or { success: false, error } when nothing changed.

Input Schema

NameRequiredDescriptionDefault
ruleYesOne line with the rule the person stated, without adding an assumption.
categoryYesThe exact short category name shown by Well, in English or French.
workspace_idNoTarget workspace. Omit when the token authorizes one workspace. Required when it authorizes several — a write lands in exactly one workspace and this call would not say which.
conversation_idNoThe conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation.
idempotency_keyNoOptional client-supplied key. A retried write with the same key returns the original result instead of re-applying the operation.
workspace_scopeNoRestrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace.

Output Schema

NameRequiredDescriptionDefault
codeNo
ruleNo
errorNo
successYes
categoryNo
reply_linesNo
category_keyNo
conversation_idNoThe conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation.
near_candidatesNo
newly_connectedNoTools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later.
conversation_id_noteNoPresent only when the server opened a fresh lane, stating that no choice recorded earlier was read.
conversation_id_sourceNoWhere the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened.
near_candidates_truncatedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedOutput schema / properties / code
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / near_candidates
      Added value: +{
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "company_id": {
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "company_id",
      +      "name"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / near_candidates_truncated
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / reply_lines
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
  2. Added

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already flag write/destructive, and the description adds real context beyond them: the rule is overwritten in place, the change affects the context hash read downstream, a chat confirmation is required, WhatsApp typed orders may commit immediately, and the result must be confirmed before claiming success. It also discloses the failure shape ({ success: false, error }) when nothing changed. Overwriting an existing rule is consistent with destructiveHint=true.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the effect, then usage rules, then required params and result handling — a logical order with minimal waste. The closing 'Say it was saved only after a successful result' is slightly procedural chaff but is defensible for a mutation tool.

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?

For a destructive, multi-param write with an output schema, the description still covers everything an agent needs to decide and to sequence the call: authorization context, confirmation behavior, the read alternative, and the success/failure reporting rule. Nothing material is left to inference.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds derivation guidance the schema does not: use the exact short category name as the person gave it (English or French) and keep the rule to one line of what they actually said. It does not touch workspace_id, conversation_id, or idempotency_key semantics, which the schema already documents richly.

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?

Names a specific verb and resource ('Save one category rule for the current workspace') and immediately states the concrete effect: it rewrites the category's written rule and changes the context hash consumed by Well's rule reader. That distinguishes it from siblings like well_update_workspace_category_override or well_set_transaction_category without opening their schemas.

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 an explicit trigger ('only when a workspace member directly tells Well how to file one named category'), explicit exclusions ('do not use it to answer a question about a rule, or when the person says not to change anything'), and names the alternative (well_get_column_rule) for the read case. It even handles the degenerate input case by telling the agent to ask which category is meant when the name is not an exact category.

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