Skip to main content
Glama

Start teaching a guide

start_guide
Read-only

Starts a teaching session on a finished guide and returns teaching guidelines plus the selected or first section. Optionally resume from a section_id; drafts cannot be taught.

Instructions

Begin a teaching session on a finished guide. Returns the teaching guidelines and the selected section (or the first section). Optionally choose a section_id to resume. Drafts cannot be taught.

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": {
      "guide_id": "<guide_id>"
    },
    "name": "start_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
guide_idYesFinished guide id (g_...).
section_idNoOptional section id (s_...) to start from; defaults to the first section.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already establish the safety profile (readOnly, non-destructive, closed-world), so the bar is lower. The description still adds value: it says what comes back, states the requirement that the guide be finished rather than a draft, and signals that starting a session can resume from a section instead of always starting at the first. It doesn't say how a session ends or whether starting again resets state.

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?

Three short sentences, zero filler: purpose first, return value second, optional parameter behavior third, and the constraint last. Every sentence carries distinct information an agent needs.

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?

There is no output schema, and the description compensates by naming the two things returned. For a two-parameter read-only tool, nothing needed to call it correctly is absent; the only minor gap is how the teaching session progresses afterwards.

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%, so the baseline is 3. The description adds meaning beyond the schema fields: it casts section_id as a resume mechanism rather than just 'start from,' which tells the agent the session already exists, and it restates the default-to-first-section behavior in operational terms.

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: 'Begin a teaching session on a finished guide,' and it clarifies the response payload (teaching guidelines plus the selected section). It never names a sibling such as select_guide or read_section, so an agent must infer the boundary between starting a session and merely reading or selecting a guide.

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?

It gives a clear when-not condition ('Drafts cannot be taught') and a usage hint for section_id ('to resume'). What is missing is an explicit alternative: there is no statement such as 'to advance within a session, use next_section' or 'to just view a guide, use read_section,' so the agent has to reason out that boundary.

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