Skip to main content
Glama

Show a TakeSix diagram

show

Validates a TakeSix document and writes it as a self-contained HTML file that opens in any browser without a network, or inline in MCP Apps, returning the file path.

Instructions

Validates a TakeSix document and writes it as one self-contained HTML file (opens in any browser, no network). In apps that support MCP Apps the diagram also opens in the conversation. Returns the file path.

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": "show"
  }
}

Input Schema

NameRequiredDescriptionDefault
fileNoPath to a .takesix.json file, instead of `document`
creditNoShow a small "Made with TakeSix" link in the corner of the HTML file. Default: true; set false when the user asks to leave it out
outputNoWhere to write the HTML file. Default: next to `file`, or in a takesix folder in the temp directory
documentNoThe takesix document as a JSON object ({ "takesix": "1.0", "title", "blocks", "links" })

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations at all, the description carries the whole burden and does a good job: it discloses a filesystem write side effect, that output is a self-contained file requiring no network, where the file lands by default, the opt-out credit link, and that the file path is returned. It does not say what happens when validation fails or whether existing files are overwritten, which is the main remaining gap for a mutation tool.

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 action, then the MCP Apps behavior, then the return value. No filler and nothing repeated from the schema.

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?

For a tool with no annotations, no output schema and a nested document object, the description covers the action, output artifact, environment requirement and return value adequately. Error behavior on invalid documents and overwrite semantics are left unspecified, which is a modest but real omission.

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 all four parameters already carry their own explanations and the baseline is 3. The description adds meaning only at the margins by noting the returned file path and the no-network property of the output, not by clarifying parameter syntax or the file-vs-document precedence.

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 description gives a concrete verb+resource: validates a TakeSix document and writes it as a single self-contained HTML file, and adds that it opens a diagram in MCP Apps hosts. That is far clearer than the bare name 'show'. It does not explicitly contrast itself with the sibling 'validate', so it stops short of full sibling differentiation.

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?

Usage context is implied by mentioning that a document is validated as part of rendering, hinting at an overlap with 'validate'. There is no explicit statement of when to pick this over 'validate' or 'guide', and no when-not-to-use condition.

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

Deploy Server

Other Tools