Skip to main content
Glama

Create teaching guide

create_guide

Create a new draft teaching guide with a unique name and optional project or source metadata, then acquire an exclusive edit lock and return a stable guide ID for adding sections in teaching order.

Instructions

Create a new draft teaching guide with a unique name and optional project/source metadata, and acquire its exclusive edit lock for this server process. Returns a stable guide_id. Next: add sections in teaching order with add_section.

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

Input Schema

NameRequiredDescriptionDefault
nameYesUnique guide name (case-insensitive), e.g. 'Understanding the scheduler'.
sourceNoOptional source description, e.g. book/PDF title, URLs, or document paths.
projectNoOptional project or repository name/path used for context.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4/5.0
Behavior4/5

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

Beyond the annotations, it discloses a non-obvious side effect: the call acquires an exclusive edit lock for this server process, which implies later release and explains contention behavior. It also implies name uniqueness causes a conflict, though it never states what happens on a duplicate name or how long the lock persists.

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: the creation action and lock side effect come first, the return value second, and the next-step pointer last. Every clause carries information an 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?

For a three-parameter creation tool with annotations and no output schema, this covers purpose, side effects, return value, and follow-up. The remaining gap is failure behavior on duplicate names and how the acquired lock relates to release_guide.

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%, so the schema already documents name, source, and project with examples and length limits. The description only restates them categorically ('unique name and optional project/source metadata') and adds no format or edge-case meaning, so 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?

The description gives a specific verb and resource ('Create a new draft teaching guide') plus the returned artifact ('stable guide_id'), which is far more informative than the bare title. It does not explicitly contrast itself with the sibling 'start_guide', so an agent facing both names still has a small ambiguity to resolve.

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 supplies a concrete workflow hand-off ('Next: add sections in teaching order with add_section'), which tells the agent what to do immediately after creation. It stops short of saying when not to use this tool — for example, when an existing guide should be reused via select_guide or when start_guide is the appropriate entry point.

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