Skip to main content
Glama

ServiceTrade MCP by usefulapi

Add a comment to a record

servicetrade_add_comment
Destructive

WRITE: add a new comment to a job, asset, invoice, quote, deficiency or location. Each call creates one more comment (not idempotent: do not retry blindly). ServiceTrade API: POST /comment.

Input Schema

NameRequiredDescriptionDefault
contentYesThe comment text.
entityIdYesThe record id.
entityTypeYesThe kind of record to comment on.
visibilityNoWho can see it (default: ServiceTrade default). Assets accept only public and tech.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Goes beyond the annotations by disclosing that each call appends a new comment, that the operation is not idempotent, and that the underlying call is POST /comment. The destructiveHint=true annotation is not contradicted, but the description could have clarified why (append-only mutation) and whether comments can be edited or deleted afterwards.

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?

Two compact sentences with the write classification and target resource front-loaded, followed by the one operational caveat that matters (non-idempotent). No filler.

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?

Adequate for a 4-parameter mutation: it conveys target scope, append semantics and the API endpoint. The remaining gap is the return value — with no output schema, the agent does not learn whether the created comment or its id is returned, which matters for follow-up calls.

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%, so the schema already documents content, entityId, entityType and visibility, including the asset-only public/tech restriction. The description repeats the entity types from the enum but adds no new parameter meaning, so 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?

States a specific verb (add/create) and resource (comment) and enumerates the exact record types it can attach to. The 'WRITE:' prefix and 'add a new comment' phrasing cleanly separate it from servicetrade_list_comments, which is the only near sibling.

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

Usage Guidelines3/5

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

Usage is implied by the write-oriented framing and the entity enumeration, and the non-idempotency warning gives a caution about retries. However it never explicitly says when to use this versus list_comments, nor does it state prerequisites such as needing a valid entityId or existing record.

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.