Skip to main content
Glama

Get a workpaper

get_workpaper

Retrieve an internal-control workpaper by engagement and workpaper ID, returning the workpaper with its rendered Markdown for review and documentation.

Instructions

Return a workpaper including its rendered Markdown.

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

Input Schema

NameRequiredDescriptionDefault
workpaperIdYes
engagementIdYes

Output Schema

NameRequiredDescriptionDefault
foundYes
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?

No annotations are supplied, so the description carries the full behavioral burden. It implies a read via 'Return' and notes that rendered Markdown is included, but says nothing about permissions, whether the workpaper must exist, or error behavior — and the return-content note is largely redundant with the existing output schema.

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 wasted words. The purpose is stated immediately with the key scope detail attached.

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 output schema already documents the return shape, so the description needn't explain return values, and both parameters are simple identifiers. Still, the combination of 0% parameter coverage and zero usage guidance leaves an agent without routing or input context it would need for correct selection.

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% and the description mentions neither engagementId nor workpaperId. With two required, undocumented parameters, the description adds no meaning beyond the bare property names and their regex 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?

The description states a specific verb (Return) and resource (a workpaper), and adds scope detail ('including its rendered Markdown'). It does not, however, distinguish itself from the sibling list_workpapers, leaving the plural/singular distinction to inference.

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 tool versus list_workpapers or assemble_workpaper, no prerequisites, and no exclusions. An agent gets no routing guidance at all.

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