Skip to main content
Glama

Sign off a workpaper

sign_off

Record preparer or reviewer sign-off on a workpaper and get a warning if the same person prepared and reviewed it.

Instructions

Record a preparer or reviewer sign-off. Warns (does not block) if the same person prepared and reviewed.

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>",
      "role": "<role>"
    },
    "name": "sign_off"
  }
}

Input Schema

NameRequiredDescriptionDefault
roleYes
actorNo
commentNo
workpaperIdYes
engagementIdYes

Output Schema

NameRequiredDescriptionDefault
warningNo
workpaperYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

B3.1/5.0
Behavior3/5

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

With no annotations, the description carries the full disclosure burden. It usefully discloses one real behavior beyond the schema: a self-prepared/self-reviewed case produces a warning rather than a hard block. However it says nothing about whether this is an overwriting/idempotent write, required permissions, or state preconditions of the workpaper.

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?

Two sentences, zero filler, with the core action front-loaded and the non-obvious warning rule immediately after. Nothing needs trimming or reordering.

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?

The existence of an output schema means return values need not be described, and the mutation nature is implied. But for an unannotated write tool, key caller-relevant facts are absent: permission requirements, whether a prior sign-off is replaced, and how the warning surfaces to the caller.

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% for 5 parameters, so the description must compensate and largely does not: actor, comment, engagementId and workpaperId are never explained. It only hints at role semantics ('preparer or reviewer') and the actor equality edge case, leaving most parameter meaning to inference from names and patterns.

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+resource ("Record a ... sign-off") and names the resource (workpaper, via the title) and the two roles. It is distinguishable from siblings like add_review_note and resolve_review_note, but it never explicitly contrasts itself with them, so it stops 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 when-to-use or when-not-to-use guidance and no alternatives named, despite ~40 sibling tools with overlapping audit-workflow semantics. At most, usage is faintly implied by the role enum, with nothing telling an agent when a sign-off is appropriate versus leaving a review note.

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