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), "style" (edge style and animation keys, diagram and node fonts, node style keys) or "pages" (fixed-size pages: sizes, order, multi-page PDF).

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

Input Schema

NameRequiredDescriptionDefault
topicNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / topic / enum
      Previous value: -[
      -  "shapes",
      -  "infographics",
      -  "kinds",
      -  "images",
      -  "export",
      -  "style"
      -]New value: +[
      +  "shapes",
      +  "infographics",
      +  "kinds",
      +  "images",
      +  "export",
      +  "style",
      +  "pages"
      +]
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent and non-destructive behavior, so the safety profile is covered. The description adds that the return value is Markdown and that supplying a topic narrows the response to one section, which is useful behavioral context absent from annotations.

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?

Core behavior is front-loaded in the first clause, with the topic enumeration following. The topic list is dense but each item adds real routing value; the sentence is long, though, and could be split or bulleted for easier scanning.

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?

With no output schema, the description must characterize the return value, and it does (Markdown guide text, or one section). For a single optional-enum read tool, nothing an agent needs to invoke it correctly is missing.

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 description coverage is 0%, so the description carries the full burden for the single enum parameter. It glosses every one of the seven topic values with concrete contents ('shapes' = custom shapes, logos, SVG, freehand; 'pages' = sizes, order, multi-page PDF), fully compensating for the bare schema.

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?

States a specific verb and resource ('Returns the Archboard guide for agents as Markdown') and enumerates the content it covers (workflow, document format, layout rules, plan limits, errors). No sibling tool does this, and the definition makes that distinction obvious.

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?

Explains the two modes clearly: full guide by default, or a single detailed section when 'topic' is supplied, and lists what each topic covers so an agent can pick the right one. It stops short of stating when to consult the guide relative to siblings (e.g., read before calling create_diagram), which keeps it from a 5.

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.