Skip to main content
Glama

Generate the review report

generate_report

Creates a Markdown internal-control review report covering scope, risks, controls, testing, workpapers, deficiencies, and COSO coverage for a given engagement.

Instructions

Generate a Markdown internal-control review report: scope, risks, controls, testing, workpapers, deficiencies and COSO coverage.

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

Input Schema

NameRequiredDescriptionDefault
engagementIdYes

Output Schema

NameRequiredDescriptionDefault
countsYes
markdownYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

B3/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 behavioral burden. It usefully discloses the output format (Markdown) and the content sections, but says nothing about whether generation is a safe read-only operation, whether it writes a file or returns content, whether it can fail on incomplete engagements, or its cost/size profile. An output schema exists, which covers the return shape, but the operational behavior is left implicit.

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?

One compact sentence with the action and output format front-loaded and the section list packaged efficiently after the colon. The list of report sections is long but each item conveys real scope information, so there is little waste.

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 covers what the report looks like, so return values need not be explained. However, for a report generator with no annotations, the description omits key operational context: preconditions on engagement data, whether the report is persisted or returned, and permission requirements. Adequate but clearly incomplete.

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 says nothing about engagementId at all — not even that it selects which engagement's data feeds the report. The name is largely self-explanatory, which limits the damage, but the description does not compensate for the documentation gap as required at this coverage level.

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 (Generate) and resource (Markdown internal-control review report) and enumerates the sections the report contains, so the artifact is unambiguous. It does not differentiate itself from aggregation-flavored siblings such as assemble_workpaper or aggregate_deficiencies, which is the only gap.

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 guidance, no stated prerequisites (e.g., whether the engagement must already have scope items, risks, controls and test results recorded), and no mention of alternatives. The only implicit context is that this belongs to an internal-control review workflow.

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