Skip to main content
Glama

How to write a TakeSix diagram

guide
Read-only

Read the diagram format and rules before writing a TakeSix diagram, then check the blueprint for each diagram type to get layout, arrows, and levels right.

Instructions

The format and the rules that make a TakeSix diagram readable. Read it once before writing your first diagram in a conversation, then once more with the type of each kind of diagram you draw: its blueprint (layout, arrows, levels).

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

Input Schema

NameRequiredDescriptionDefault
typeNoThe blueprint to read: basic (peers, centred tiles), architecture, plan (to-do, roadmap, talk outline), flowchart (algorithm), or epic for an example that combines them. Leave out for the general guide.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.6/5.0
Behavior3/5

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

The readOnlyHint annotation already establishes this is a safe read, and the description is consistent with that, adding that the output is rules and a blueprint (layout, arrows, levels) rather than data. It does not state the return format or size, nor whether the guide is static content. With annotations covering the safety profile, this is adequate but not rich.

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?

Two sentences, no filler, and the instruction sequence (first read, then read per type) is ordered as the agent should act. The opening fragment is slightly abstract and only becomes concrete in the second half.

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 single-optional-parameter documentation tool with no output schema, the definition covers what the tool is, when to invoke it, and what the parameter selects. The only gap is not saying what form the guide comes back in, which is minor at this complexity.

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 coverage is 100% and the enum description already explains each blueprint value in detail. The description reinforces the parameter's usage pattern (read again per diagram type) and hints at blueprint contents, but adds no new semantics such as precedence or validity of combinations. Baseline 3 applies.

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 states the resource clearly: the format and readability rules for a TakeSix diagram, plus per-`type` blueprints covering layout, arrows and levels. An agent can tell this is a documentation-retrieval tool rather than an action tool. It does not differentiate itself from the `show` or `validate` siblings, which keeps it below 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 Guidelines4/5

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

Timing is explicit and actionable: read once before writing the first diagram in a conversation, then once more with the `type` of each diagram drawn. That covers the primary when-to-use case well. There is no statement of when not to call it, and the sibling tools are never referenced as alternatives.

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