Skip to main content
Glama

Get an example diagram

get_example
Read-only

Fetch a complete example diagram to learn from or adapt, or list available examples when no name is provided. Supports labels in English or Spanish.

Instructions

Returns a complete example diagram to learn from or adapt. Without a name, lists the available examples (recipes, software architecture, OAuth login, order process, timelines, live order trackers and more).

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

Input Schema

NameRequiredDescriptionDefault
langNoLanguage of the labels. Default en.
nameNoExample name from the list, for example "sequence" or "tracker". Omit to list them.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds value beyond that by disclosing the two-mode behavior and enumerating the example categories that come back in listing mode, though it says nothing about the diagram format or size.

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?

Two sentences, zero padding, with the primary return behavior front-loaded and the listing fallback immediately after. Nothing repeats the title or wastes the agent's reading budget.

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 two-optional-parameter read-only tool with full schema coverage, the description covers both invocation modes and the nature of the return value. The only gap is the diagram's serialization format, which matters if the agent needs to consume or adapt the output.

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%, and the schema already documents both parameters, including the "Omit to list them" guidance and the default language. The description's parenthetical example list adds only marginal color beyond the schema, so 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 names a specific verb and resource ("Returns a complete example diagram") and clarifies the dual output mode (single example vs. list of examples). It does not differentiate itself from the sibling get_guide, which is the closest potential point of confusion, so it stops short of 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 Guidelines3/5

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

Usage is implied rather than stated: "to learn from or adapt" gives intent, and "Without a name, lists the available examples" gives the mode-switch condition. There is no explicit when-not-to-use guidance and no mention of when get_guide or validate_diagram would be the better choice.

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