Skip to main content
Glama

Update Request note

update_request_note

Modify an existing note on a service desk request by providing the request ID, note ID, and new body content.

Instructions

Update a request note.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYes
note_idYes
request_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

D1.3/5.0
Behavior1/5

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

With no annotations provided, the description carries the full behavioral burden, and it discloses nothing. It is silent on whether this is a full replace or partial merge, permission requirements, concurrency behavior, or what happens to unspecified note fields.

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?

The single sentence is short, but that brevity reflects under-specification rather than efficient communication. There is nothing to front-load because no useful content is present.

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?

For a mutation tool with three required undocumented parameters, a nested free-form object body, no annotations, and no output schema, the description is wholly inadequate. An agent cannot safely construct a call from the information given.

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% for all three required parameters. The 'body' parameter is an arbitrary nested object with additionalProperties: {} and no constraint documentation, and the description adds no meaning about its expected shape or the id formats.

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 'Update a request note' is a verbatim restatement of the tool title and name, adding no information beyond the identifier. It does not distinguish this tool from close siblings such as update_request_task, update_request, or update_change.

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

Usage Guidelines1/5

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

No guidance whatsoever on when to use this tool versus alternatives like update_request_task or the sibling note tools (add_request_note, delete_request_note). No prerequisites, no conditions, no exclusions are stated.

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