Skip to main content
Glama
Trestle MCP

Trestle MCP

Official

Generate Catalog Markdown Controls

trestle_author_catalog_generate
Destructive

Generate control-wise Markdown files from an OSCAL catalog in a Trestle workspace, with options for headers and overwriting existing output.

Instructions

Generate Catalog controls in markdown form from a catalog in the trestle workspace.

Args: params (TrestleCatalogGenerateInput): Input parameters with: - name (str): Catalog model name (required) - output (str): Output markdown folder (required) - force_overwrite (bool): Force overwrite markdowns (optional) - yaml_header (Optional[str]): Path to yaml header file (optional) - overwrite_header_values (bool): Overwrite markdown header values (optional) - trestle_root (Optional[str]): Trestle workspace root path (optional) - verbose (bool): Display verbose output (optional)

Returns: str: Success or error message

Examples: - Use when: "Generate markdown controls from a catalog" - Use when: "Split a catalog JSON into control-wise markdowns" - Don't use when: "Catalog is missing or output directory already exists and not overwritten"

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": {
      "params": "<params>"
    },
    "name": "trestle_author_catalog_generate"
  }
}

Input Schema

NameRequiredDescriptionDefault
paramsYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, and non-idempotent, so the safety profile is known. The description adds real context on top: it discloses the overwrite condition (output directory existing without overwrite is a do-not-use case), the force_overwrite and overwrite_header_values flags, and that a success/error string is returned. It stops short of stating exactly what is destroyed or whether overwriting is per-file.

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?

Front-loaded purpose sentence, followed by structured Args/Returns/Examples sections – easy to scan and nothing wasted. Slight redundancy in restating types that the schema also carries, but the layout is efficient.

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

Completeness5/5

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

Given an output schema exists (so return values need no prose), a single-object parameter shape, and a destructive write operation, the definition covers required inputs, optional modifiers, failure conditions, and return type. Nothing an agent needs to invoke it correctly appears missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The Args block enumerates every parameter with type and required/optional status, and clarifies the required pair (name, output) plus optional behavior like trestle_root defaulting to the workspace root. This compensates for the reported 0% schema description coverage and maps the top-level params wrapper to its nested fields.

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 first sentence gives a specific verb and resource – 'Generate Catalog controls in markdown form from a catalog in the trestle workspace' – which clearly states the transformation (catalog JSON to markdown control files). It does not explicitly distinguish itself from the sibling assemble tool, but the naming and verb make the split reasonably inferable.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

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

Explicit 'Use when' and 'Don't use when' examples give concrete triggering conditions: generating markdown controls, splitting catalog JSON into control-wise markdowns, and the failure case where the catalog is missing or the output directory already exists without overwrite. No alternative sibling is named for the inverse case, which keeps it from a 5.

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