Skip to main content
Glama
macola-mcp

macola-mcp

by Banidan

comment_codes_update

Update a specified Macola Comment Code (Shipping Instruction) with provided field values to keep shipping instructions current and accurate.

Instructions

Updates the specified Comment Code (Shipping Instruction) with the data provided.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "comment_codes_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
IDNo
RowVersionNo
CommentCodeNo
DescriptionNo
Description2No

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

C2.6/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full disclosure burden for a write operation, yet it says nothing about required permissions, whether unspecified fields are preserved or cleared, or what happens on failure. It also omits the presence of RowVersion, which strongly suggests an optimistic-concurrency check the caller must satisfy — a critical behavioral detail left unstated.

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

Conciseness3/5

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

It is a single efficient sentence with the verb front-loaded and no wasted words. However, brevity here reflects under-specification rather than disciplined concision, since the same sentence count could have carried concurrency and field-update semantics.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a five-parameter mutation with no annotations, no output schema, and a concurrency token in the payload, this definition is materially incomplete. An agent can guess it is an update, but cannot determine how to target the record safely or what the response will be.

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

Parameters2/5

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

Schema description coverage is 0% across five parameters, so the description must compensate, and it does not — "with the data provided" conveys no meaning about ID, RowVersion, CommentCode, Description, or Description2. The only hint is that a record must be "specified," implying an identifier is needed, which is far short of what a 0%-coverage schema demands.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/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 ("Updates the specified Comment Code") and adds a useful gloss that the resource is a Shipping Instruction, which disambiguates terminology an agent may not know. It does not distinguish itself from the sibling operations (comment_codes_create, comment_codes_delete, comment_codes_get/find), so an agent must infer that this is the mutation-by-ID path.

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

Usage Guidelines2/5

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

There is no explicit when-to-use or when-not-to-use guidance and no mention of the sibling get/find tools that would precede an update. The phrase "the specified Comment Code" only weakly implies that an existing record must be identified first, leaving prerequisites to inference.

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

Deploy Server

Other Tools