Skip to main content
Glama

Add a review note

add_review_note

Adds a reviewer note to a workpaper by engagement and workpaper ID, capturing review feedback for internal-control assessments.

Instructions

Add a reviewer note to a workpaper.

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": {
      "engagementId": "<engagementId>",
      "workpaperId": "<workpaperId>",
      "text": "<text>"
    },
    "name": "add_review_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
textYes
authorNo
workpaperIdYes
engagementIdYes

Output Schema

NameRequiredDescriptionDefault
noteYes
workpaperYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

C2.7/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden for a mutation tool. It says nothing about who may add a note, whether the note is editable or immutable, whether it changes workpaper review status, or whether it requires the engagement to be open — all material for a write operation.

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?

It is a single front-loaded sentence with no filler, which is structurally clean. However, its brevity comes at the cost of under-specification rather than true economy.

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

Completeness2/5

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

An output schema exists, so return values need no explanation, but for a 4-parameter mutation tool with zero annotation coverage and zero schema descriptions, the definition omits author semantics and the required engagement/workpaper relationship. It is too thin for the tool's complexity.

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% across 4 parameters, so the description must compensate and does not. It never mentions the optional author field or explains the distinction between engagementId and workpaperId scoping.

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 (add) and resource (reviewer note on a workpaper), so an agent knows the basic operation. It does not differentiate from the sibling resolve_review_note, which is the obvious near-neighbor, 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 Guidelines2/5

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

There is no statement of when to use this versus resolve_review_note, note_exception, or any other note-creating tool, and no prerequisites such as whether the workpaper must already exist or be in review. The agent must infer usage entirely.

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