Skip to main content
Glama
diagrammo
by diagrammo

generate_report

Generate a polished HTML report with multiple DGMO diagrams, table of contents, and optional source blocks. Opens in browser by default. For DGMO syntax call get_language_reference.

Instructions

Generate a polished HTML report with multiple DGMO diagrams, table of contents, and optional source blocks. Opens in browser by default. For DGMO syntax call get_language_reference.

Input Schema

NameRequiredDescriptionDefault
openNoOpen the report in the browser
themeNoColor themelight
titleYesReport title
paletteNoColor palette for the page and every diagram. Given, it beats each diagram's own palette line; omitted, each diagram uses its own, and the page uses slate.
sectionsYesReport sections, each with a diagram
subtitleNoOptional subtitle
include_sourceNoShow DGMO source in collapsible blocks

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.29.10
    • removedInput schema / properties / palette / default
      Removed value: -"slate"
    • changedInput schema / properties / palette / description
      Previous value: -"Color palette"New value: +"Color palette for the page and every diagram. Given, it beats each diagram's own palette line; omitted, each diagram uses its own, and the page uses slate."
  2. Changed1 schema field changedv0.29.5
    • changedInput schema / properties / sections / items / properties / dgmo / description
      Previous value: -"DGMO diagram markup. Color a label by appending a lowercase color name as the trailing token (e.g. \"Sales red\"); capitalize (\"Red\") to use a color word as literal text."New value: +"DGMO diagram markup. For syntax call get_language_reference."
  3. Changed1 schema field changedv0.9.1
    • changedInput schema / properties / theme / default
      Previous value: -"dark"New value: +"light"
  4. Changed1 schema field changedv0.2.4
    • changedInput schema / properties / palette / default
      Previous value: -"nord"New value: +"slate"
  5. Addedv0.2.2
  6. Removedv0.1.21
  7. First observedv0.1.13

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, openWorldHint=true, and destructiveHint=false, lowering the bar. The description adds a genuinely useful side-effect disclosure ('Opens in browser by default') that the annotations do not convey, though it omits where the report file is written or returned.

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?

Three short sentences, front-loaded with the core capability, then the behavioral default, then the prerequisite pointer. Zero filler.

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?

There is no output schema, so the description should carry the return-value burden, but it only says the report 'opens in browser by default'. For a tool that produces a file artifact, the missing output location/path leaves the agent unable to report where the report lives.

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?

Schema description coverage is 100%, so each parameter is already documented, giving a baseline of 3. The description lightly reinforces 'source blocks' (include_source) and browser opening (open) but adds no syntax or precedence detail beyond the schema, which already explains palette behavior better.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Generate a polished HTML report') and enumerates the distinguishing output features (multiple DGMO diagrams, table of contents, optional source blocks). This clearly separates it from single-diagram siblings like render_diagram and preview_diagram.

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?

Provides one explicit routing pointer ('For DGMO syntax call get_language_reference') that resolves the likely prerequisite. However, it does not state when to choose this over render_diagram or preview_diagram, so usage context is clear but incomplete.

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