Skip to main content
Glama

Finish guide

finish_guide

Validate a draft guide, mark it finished, and export it as a portable teaching-guide.md with guidelines, ordered contents, and section content. Releases the edit lock on success.

Instructions

Validate a draft guide, mark it finished (read-only), and generate a portable teaching-guide.md containing teaching guidelines, the ordered contents journey, and all section content. Requires this server process to hold the draft's edit lock and releases that lock on success. Invalid for empty guides or guides already finished.

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

Input Schema

NameRequiredDescriptionDefault
guide_idYesDraft guide id (g_...).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.6/5.0
Behavior3/5

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

Adds meaningful behavior beyond the annotations: lock ownership requirement, lock release on success, and explicit failure conditions for empty/finished guides. However, the parenthetical '(read-only)' next to 'mark it finished' is confusing since finishing is a state mutation, and the description does not clarify whether the guide remains editable afterward or whether the generated markdown is written to disk or returned.

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?

Three tight sentences, front-loaded with the action and the artifact, followed by prerequisites and failure conditions. No filler, though the '(read-only)' insertion adds ambiguity rather than value.

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?

With no output schema, the description correctly describes what the generated artifact contains (guidelines, ordered contents journey, section content). The remaining gap is whether that artifact is returned in the response or persisted as a file, which an agent would want to know.

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 single guide_id parameter is already documented as a draft id (g_...). The description reinforces that only drafts qualify via the edit-lock precondition, but adds no syntax or format detail beyond the schema, so the 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?

States a specific verb chain (validate, mark finished, generate teaching-guide.md) and names the concrete artifact produced, which lets an agent predict the outcome. It never distinguishes itself from nearby siblings such as release_guide or start_guide, so differentiation is left implicit rather than stated.

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?

Gives real preconditions: the server process must hold the draft's edit lock, and the call is invalid for empty or already-finished guides. What is missing is guidance on the alternative path — e.g., how to abandon or unlock a draft instead of finishing it.

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