Skip to main content
Glama

Check a TakeSix document

validate
Read-only

Checks a TakeSix document for format rules—at most six blocks per level, unique IDs, and links between existing blocks—and lists every problem with its JSON path.

Instructions

Checks a TakeSix document against the format: at most 6 blocks per level, unique ids, links between existing blocks. Lists every problem with its JSON path; on success, one line about the shape of the diagram.

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

Input Schema

NameRequiredDescriptionDefault
fileNoPath to a .takesix.json file, instead of `document`
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

A4/5.0
Behavior4/5

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

The readOnlyHint already establishes that this is a safe read operation. The description adds useful behavioral detail by saying it lists every problem with its JSON path and, on success, returns one line about the diagram's shape, which compensates for the absence of an output schema.

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?

The definition is two compact sentences with the validation purpose and the rule set front-loaded. Every clause contributes either scope or expected output behavior, with no wasted wording.

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 simple read-only validator, the description covers the rules checked and both success and failure output. A minor gap remains around whether file or document takes precedence when both are supplied, but the schema already marks neither as required and describes each input.

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 both the file and document parameters are already well documented. The description mentions checking a document but adds no additional syntax, precedence, or mutual-exclusion guidance beyond what the schema provides.

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?

The description states a specific verb and resource: it checks a TakeSix document against the format. It also enumerates the core rules being validated, so the agent can distinguish this from the sibling tools guide and show without opening the schema.

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 description makes the validation use case clear but does not say when to use this tool versus alternatives or when validation should be skipped. Usage is implied rather than explicitly routed.

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