Skip to main content
Glama

Working guides

guide
Read-onlyIdempotent

Lists available workflow instructions or reads a named one to explain how to complete tasks, including converting an event into a scenario before saving it.

Instructions

The working guides of the agent: how to do the work, whatever the client.

Without name, the list. scenario-from-corpus turns an event into a scenario; read it before scenario save.

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

Input Schema

NameRequiredDescriptionDefault
nameNoThe guide to read: scenario-from-corpus, run-report or drivers. The list when omitted.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.0.2
    • addedInput schema / properties / name / description
      Added value: +"The guide to read: scenario-from-corpus, run-report or drivers. The list when omitted."
  2. Addedv1.0.1

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, non-destructive, closed-world behavior, and the description adds the important default of returning a list when `name` is absent. It also supplies a workflow prerequisite for one guide, which is useful context beyond annotations, though it does not describe pagination or list completeness.

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 description is compact and front-loaded: purpose first, default behavior second, and a specific workflow note last. The phrase “whatever the client” is slightly vague and could be trimmed, but overall there is little wasted text.

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-optional-parameter guide retrieval tool with full schema coverage, an output schema, and rich annotations, the description covers the key default behavior and a workflow prerequisite. It does not explain the content of every guide, but that is not essential for invoking the tool correctly.

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?

Schema coverage is 100% and already names the available guides, so the baseline is 3; the description adds real workflow meaning by saying `scenario-from-corpus` turns an event into a scenario and should be read before `scenario save`. The other guide values receive no extra explanation, but the added context is meaningful.

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 that the tool provides the agent's working guides and that omitting `name` returns the list, which is specific enough to identify a guide/documentation retrieval tool. It does not explicitly contrast with sibling tools such as `scenario` or `corpus` beyond the scenario-save workflow note.

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 default list behavior when `name` is omitted and tells the agent to read `scenario-from-corpus` before `scenario save`. This gives clear workflow context, but there is no broader when-not-to-use guidance or comparison against other guide-reading alternatives.

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