Skip to main content
Glama

Read the Workflow Guide

get_guide

Read before drafting or compiling to confirm requirements, map non-standard Markdown structures, and follow the compilation contract for accurate Word output.

Instructions

Read this before drafting or compiling. Explains requirements confirmation, non-standard Markdown structure mappings, and the compilation contract.

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_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

With no annotations, the description carries the full burden, and it does disclose the meaningful traits: this is a preparatory read that must precede drafting/compiling, and it names the three subject areas the content covers. It does not say whether the guide is static or version-dependent, or whether re-reading mid-task is ever needed, which is a small remaining gap for a zero-parameter content fetch.

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, no filler, with the action constraint ('Read this before drafting or compiling') front-loaded ahead of the content summary. Every clause carries information the agent needs.

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?

The tool is simple (no parameters, output schema present, so return shape need not be described), and the description covers both timing and payload. The only substantive omission for an agent's decision is how get_guide relates to its sibling get_manual.

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

Parameters4/5

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

The tool takes zero parameters, so the baseline of 4 applies. There is no argument whose meaning the description could add or omit.

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 a specific verb and resource ('Read ... guide') and enumerates the content it delivers: requirements confirmation, non-standard Markdown structure mappings, and the compilation contract. An agent knows what the call returns. It does not distinguish itself from the sibling get_manual, which is presumably also documentation, 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 Guidelines4/5

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

'Read this before drafting or compiling' gives an explicit sequencing precondition tied to the drafting and compiling phases (compile_markdown). What is missing is any exclusion or routing rule, e.g. when to use get_manual instead of get_guide, so an agent facing both documentation tools must guess.

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