Skip to main content
Glama
Trestle MCP

Trestle MCP

Official

Generate Profile Markdown Controls

trestle_author_profile_generate
Destructive

Generate markdown documentation for controls in a specified compliance profile, producing review-ready files with optional headers, section splits, and overwrite controls.

Instructions

Generate markdown documentation set for controls defined in specified profile.

This tool extracts controls defined in the specified profile (profiles//profile.json) and generates a set of markdown documents for them. This set can be used for custom documentation, reviews, and organization-specific profile documentation.

Args: params (TrestleAuthorProfileGenerateInput): - name (str): profile name (required) - output (str): output directory for markdown docs (required) - yaml_header (Optional[str]): yaml header file path - force_overwrite (bool): overwrite all in output dir - overwrite_header_values (bool): overwrite header values only - sections (Optional[str]): targeted sections in markdown - required_sections (Optional[str]): required section short names, comma-separated - trestle_root (Optional[str]): workspace root path - verbose (bool): verbose output

Returns: str: Success message or error details

Examples: - Use when: "Generate markdown controls for a given profile" - Use when: "Customize output with required sections or header overwrite" - Don't use when: Profile file does not exist

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_profile_generate"
  }
}

Input Schema

NameRequiredDescriptionDefault
paramsYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, openWorldHint=true and idempotentHint=false, so the safety profile is known. The description adds useful context that the output is a documentation set written into an output directory and that overwrite can be forced, but it never explains what happens to pre-existing files in the output directory, whether generation is partial or atomic, or what permissions/workspace state are required.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose is front-loaded in the first sentence, but the verbatim Args block duplicates the input schema, and the quoted 'Use when' example strings convey little beyond the prose. Roughly half the text earns its place; the rest is redundant scaffolding.

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

Completeness4/5

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

An output schema exists and the description still notes the return shape (success message or error details), and it documents the required inputs and output directory semantics. What is missing is only how control selection relates to sibling assembly tools, which is a modest gap for a single-nested-parameter generator.

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

Parameters3/5

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

The description enumerates all nine sub-fields of the nested params object, which compensates partially for the reported 0% schema description coverage. However, it mostly restates the schema, and two entries are less precise or arguably conflicting: yaml_header is called a 'file path' in the description while the schema describes the YAML content to insert, and 'sections' vs 'required_sections' are described vaguely as 'targeted sections' / 'required section short names' without clarifying how they interact.

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 and resource: extracts controls from profiles/<name>/profile.json and generates a set of markdown documents, and names intended uses (custom docs, reviews, org-specific documentation). It does not differentiate itself from the sibling trestle_author_profile_assemble, which an agent could reasonably assume does overlapping markdown generation for profiles.

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

Usage Guidelines3/5

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

The Examples block gives two 'Use when' phrases and a 'Don't use when: Profile file does not exist', but the latter is a precondition rather than a real alternative, and no sibling tool is named as the path for other cases (e.g., assembling vs generating). Usage is implied rather than routed.

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