Skip to main content
Glama

Read the Archboard guide

read_me
Read-onlyIdempotent

Returns the Archboard guide for agents as Markdown: workflow, document format, layout rules, working live next to people, plan limits and errors. The optional topic returns one detailed section instead: "shapes" (custom shapes, logos, illustrations, SVG and freehand drawings), "infographics" (charts, KPI rows, timelines, funnels, steps and posters drawn with compose_diagram), "kinds" (sequence, ER, UML, mind map, org chart, roadmap and C4 diagrams), "images" (adding images: limits, errors, upload links), "export" (render_snapshot and export_diagram: parts of large diagrams, watermark, download links, errors) or "style" (edge style and animation keys, diagram and node fonts, node style keys).

Input Schema

NameRequiredDescriptionDefault
topicNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already establish readOnlyHint, idempotentHint and openWorldHint=false, so the safety profile is covered. The description still adds real context beyond that: the return is Markdown, and supplying a topic narrows the response to a single section rather than the full guide. It doesn't mention guide length or cost of fetching the whole thing, which would help an agent decide between modes.

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?

The default behavior and return format are front-loaded before the topic enumeration, and every topic gloss carries distinct information. The second sentence is long and comma-heavy, but no clause is filler.

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

Completeness5/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 must describe return values, and it does — Markdown guide or a single section. With one optional parameter, complete topic enumeration, and annotations covering safety, an agent has everything needed to invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0% and the description fully compensates: every enum value is defined with specific content ("export" = render_snapshot and export_diagram parts, watermark, download links, errors). An agent can pick a topic without guessing what it contains.

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?

Opens with a specific verb and resource ("Returns the Archboard guide for agents as Markdown") and enumerates exactly what the guide covers: workflow, document format, layout rules, plan limits and errors. This is unmistakably the documentation tool among diagram-manipulation siblings like create_diagram and export_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?

It clearly distinguishes the two calling modes: omit topic for the whole guide, pass a topic for "one detailed section instead." Each topic label is paired with the concrete concern it resolves (e.g. "images" for limits, errors, upload links), which routes the agent well. It stops short of saying when to read the guide relative to the sibling workflow tools.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.