Skip to main content
Glama

Get build guide

get_build_guide
Read-only

A published build guide by slug as markdown: parts, assembly steps, connections and firmware.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "slug": "<slug>"
    },
    "name": "get_build_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
slugYesThe guide's slug as returned by search_build_guides, e.g. 'build-a-co2-room-monitor'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / slug / description
      Added value: +"The guide's slug as returned by search_build_guides, e.g. 'build-a-co2-room-monitor'."
  2. 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, destructiveHint=false and openWorldHint=false, so safety is covered. The description adds two things beyond that: the response format is markdown and only published guides are served, which is the key behavioral constraint an agent needs. It stops short of saying what error or empty result an unknown slug produces.

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?

A single compact clause with the lookup key and the returned sections front-loaded; no filler, no repetition of the title.

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 one-parameter read tool with no output schema, the description covers the returned sections and the format, which is what an agent most needs. The remaining gap is failure behavior for missing or unpublished slugs, a minor omission given full annotation coverage.

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 slug property already carries a description with an example and a pointer to search_build_guides. The description only restates that the lookup is by slug, adding no format, casing or validation detail beyond the schema, so this sits at the baseline.

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?

States the resource (a published build guide) and the lookup key (slug) plus the returned content shape: parts, assembly steps, connections and firmware. That distinguishes it from search_build_guides, which returns multiple candidates, though the description never explicitly frames it as a retrieval-by-identifier operation.

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 phrase 'by slug' implies the caller already has an identifier and therefore has already used search_build_guides, and the word 'published' hints at a constraint. There is no explicit when-to-use statement, no named alternative, and no stated behavior when the slug is invalid or the guide is unpublished.

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.