Skip to main content
Glama

Add guide section

add_section

Append a titled Markdown section to a draft teaching guide in teaching order, so you can build guides step by step while holding the draft edit lock.

Instructions

Append a section to a draft guide in teaching order. Requires title, a short one-line description, and Markdown content. Draft-only; this server process must hold the draft's edit lock (acquired by create_guide or select_guide).

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>",
      "title": "<title>",
      "description": "<description>",
      "content": "<content>"
    },
    "name": "add_section"
  }
}

Input Schema

NameRequiredDescriptionDefault
titleYesImperative, concrete section title.
contentYesFull section content in Markdown.
guide_idYesGuide id returned by create_guide/list_guides (g_...).
descriptionYesShort one-line description used in the contents journey.

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?

Annotations only declare openWorldHint=false, idempotentHint=false and destructiveHint=false, so the lock-ownership requirement and draft-only restriction are genuinely new behavioral information the description supplies. It does not describe what happens if the lock is lost or what the call returns, which keeps it below a 5.

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 tight sentences with the action and ordering first, then the requirement and lock condition. No filler, and every clause carries operational weight.

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 small four-parameter mutation tool with full schema coverage and no output schema, the definition covers the key constraints: draft-only scope, required lock, and append ordering. It leaves lock-contention or error behavior unexplained, but nothing essential to invoking it correctly is absent.

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 description coverage is 100%, so all four parameters are already documented; the description's restatement of title, one-line description and Markdown content adds little. The one genuine addition is 'append ... in teaching order', which implies there is no position parameter and the section goes to the end of the sequence.

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 (append) and resource (a section to a draft guide) plus the ordering semantic ('in teaching order'), which separates it from edit_section or read_section by implication. It stops short of explicitly naming the sibling it is not, so it lands just under a top mark.

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 clearly states the operating context: draft guides only, and the calling process must already hold the edit lock, which is acquired via create_guide or select_guide. That is a concrete prerequisite with named alternatives, though it does not explicitly route agents to edit_section for modifying existing content.

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