Skip to main content
Glama

ERP: Comment assignment

erp_comment_assignment

Add a comment to one assignment. The comment is attributed to the caller by the ERP, so it reads as theirs everywhere it is shown. CONFIRMATION: this tool is PROPOSED, never performed directly. You get status='confirmation_required' with an action_id and a plan_token, and the write happens only after confirm_action.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "assignment_id": "<assignment_id>",
      "text": "<text>"
    },
    "name": "erp_comment_assignment"
  }
}

Input Schema

NameRequiredDescriptionDefault
textYes
assignment_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Beyond the annotations, the description adds meaningful behavior: the comment is attributed to the caller, and this tool is proposed rather than directly performed. It also discloses the confirmation handshake with status='confirmation_required', action_id, plan_token, and confirm_action. It does not cover permission requirements or failure modes, so it is strong but not exhaustive.

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?

The description is three sentences, front-loaded with purpose, followed by attribution and confirmation behavior. Every sentence carries useful information, and there is no redundant restatement of the schema or annotations.

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?

For a write tool with no output schema, the description adequately explains the unusual confirmation flow and the return fields an agent will encounter. It remains incomplete on parameter sourcing and error behavior, but the critical workflow is covered.

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%, so the description needs to compensate for parameter meaning. It only implies that assignment_id identifies 'one assignment' and text is the comment body; it does not explain assignment_id format, where to obtain it, or the 4000-character text limit present in the schema.

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: 'Add a comment to one assignment.' This is clear and distinguishes the write action from read-oriented siblings like erp_list_comments. It does not explicitly differentiate itself from other assignment mutation tools, so it falls short of a 5.

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?

The description explains the confirmation workflow, which is important usage context, but it does not say when to use this tool versus alternatives such as erp_list_comments, erp_attach_document, or other assignment writes. Usage is implied by the action itself rather than explicitly guided.

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