Skip to main content
Glama
noit-mcp-server
by Yuki-az-23

build_viewer

Generates an interactive HTML viewer and overview for STAR-pattern architecture diagrams, with optional file writing or a dry-run to a temporary directory.

Instructions

Generate the interactive HTML viewer + overview

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "build_viewer"
  }
}

Input Schema

NameRequiredDescriptionDefault
writeNoWrite the *.generated.* files next to the live ones (default: dry-run to a temp dir)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full disclosure burden, and it says nothing about what the tool touches. It does not state that output may overwrite live files when write=true, that the default is a dry-run to a temporary directory, or what happens to previously generated files — all behavior an agent needs before triggering a build.

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?

A single short sentence with the key action front-loaded and no filler, which is appropriate for a simple one-parameter tool. The "+ overview" clause is vague enough that it borders on padding without clarifying scope.

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

Completeness2/5

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

For a tool that can write generated files alongside live ones with no annotations and no output schema, the description is thin. It never establishes what the viewer renders, what the overview contains, or whether the write path is reversible, leaving meaningful gaps given the mutation risk.

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 single parameter has full schema description coverage, including its default and dry-run semantics, so the schema already does the explanatory work. The description adds nothing about the write flag beyond restating that a viewer is generated, which is the expected baseline when coverage is 100%.

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?

"Generate the interactive HTML viewer + overview" gives a specific verb (generate) and a concrete artifact (interactive HTML viewer), so an agent can tell this is a build/emit tool rather than a CRUD piece operation. It does not distinguish itself from siblings like create_diagram_piece or explain what "overview" adds, so it stops short of a 5.

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 prerequisites, and no mention of alternatives such as when to preview versus when to emit. The agent must infer from the name alone that this is the final rendering step in a diagram workflow.

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