Skip to main content
Glama

Add Request note

add_request_note

Adds a note to a ServiceDesk Plus request, letting technicians log updates, troubleshooting steps, or customer communication directly on the ticket.

Instructions

Add a request note.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYes
request_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

D1.5/5.0
Behavior1/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure, and it discloses nothing. For a mutation tool it does not state whether the note is appended or replaced, who can add notes, whether the request must be in a particular state, or what the response contains.

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

Conciseness2/5

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

A single short sentence, so there is no waste, but it is under-specification rather than conciseness. The brevity strips away information the agent needs instead of compressing it.

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

Completeness1/5

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

A two-parameter mutation tool with no annotations, no output schema, a nested undocumented body object, and 0% schema coverage gets essentially no support from the description. Every gap the structured fields leave is left unfilled.

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

Parameters1/5

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

Schema description coverage is 0% and the description adds no parameter meaning. The 'body' parameter is a nested object with additionalProperties: {} and no documented shape, and 'request_id' accepts either an integer or numeric string — none of this ambiguity is clarified by the description.

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

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Add a request note.' is a tautology that restates the tool name and title almost verbatim. It does name a verb (add) and a resource (request note), but adds no scope, no subject identification, and nothing to distinguish it from siblings like add_request_task or add_request_resolution.

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 prerequisites, and no mention of alternatives such as update_request_note or add_request_resolution. The agent must infer everything from the name alone.

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