Skip to main content
Glama

AssetLab

Create work order comment

create_work_order_comment

Create a new comment on a work order. Requires work_order_comments:write scope.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
commentYesComment text (required)
work_order_idYesWork order ID (required)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false, so the safety profile is covered. The description adds the required auth scope (work_order_comments:write), which is genuinely useful context, but it omits the practical consequence of idempotentHint=false: repeated calls create duplicate comments.

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?

Two short sentences, no filler, with the action front-loaded ahead of the scope requirement. It is efficient, though perhaps slightly under-specified for the tool's complexity.

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

Completeness3/5

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

For a two-parameter create tool with a fully documented schema and no output schema, the definition covers the essentials (action, auth scope). It stops short of describing the created object's return or duplicate-comment behavior, leaving minor gaps.

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% for both parameters (comment text and work_order_id with uuid format), so the schema already carries the semantics. The description adds nothing about parameter format or constraints beyond what is structured, so the 3 baseline applies.

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?

States a specific verb (Create) and resource (comment on a work order), which is unambiguous against the many sibling create_* tools. It does not explicitly differentiate from create_work_order, get_work_order_comment, or update_work_order_comment, but the name plus description make the intent obvious.

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?

No when-to-use guidance, no mention of prerequisites beyond scope, and no reference to the sibling tools (e.g., use get_work_order_comment to read existing comments). The agent must infer usage entirely from the name.

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