Skip to main content
Glama

Assemble a workpaper

assemble_workpaper

Assemble a Markdown control-testing workpaper from a control, its risks, population, sample, test results and exceptions for internal-control review documentation.

Instructions

Assemble a Markdown control-testing workpaper from the control, its risks, population, sample, test results and exceptions.

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>",
      "controlId": "<controlId>"
    },
    "name": "assemble_workpaper"
  }
}

Input Schema

NameRequiredDescriptionDefault
titleNo
controlIdYes
engagementIdYes
testResultIdNoRestrict to a single test result.

Output Schema

NameRequiredDescriptionDefault
workpaperYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

C2.9/5.0
Behavior2/5

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

There are no annotations, so the description carries the full behavioral burden. It does not say whether assembly persists a new workpaper, whether it is idempotent, what happens when upstream data (sample, test results) is missing, or whether it requires permissions or sign-off beforehand. Calling it 'Markdown' hints at output format only.

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?

A single, front-loaded sentence with no filler; the action leads and the input scope follows. Nothing is wasted.

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?

An output schema exists, so return values need not be explained, and the input enumeration gives a reasonable picture of what is consumed. However, with a mutation-ish assembly tool that has no annotations and 75% undocumented parameters, the definition leaves behavioral and invocation context thin.

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 only 25% (just testResultId). The description loosely refers to 'the control' and 'test results' but does not clarify that engagementId and controlId are the required selectors, what 'title' governs, or that testResultId narrows scope to one result. It fails to compensate for the low coverage.

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 ('Assemble') and resource ('Markdown control-testing workpaper') and enumerates the constituent inputs it draws on, making it clearly distinct from retrieval siblings like get_workpaper or list_workpapers. It stops short of explicitly contrasting itself with those siblings, but the action is unambiguous.

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?

The description implies a precondition set (control, risks, population, sample, test results, exceptions must exist) but never states when to use this tool versus get_workpaper, list_workpapers, or sign_off, nor any required ordering after gathering data. No explicit when/when-not guidance is given.

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