Skip to main content
Glama

save_roadmap

Create or update a course roadmap and make it active in the workspace to give the coding agent a structured learning path.

Instructions

Create or update the course roadmap and make it active in this workspace. YAML with title (the course's name in a few plain words, at most 60 characters), goal, track (id@version; none for quiz, optional for none), style (io|unit|quiz|none), concepts [{id, title, requires, practice?, pitfalls?, refs?}] and optional sources [{title, url}]; refs are indexes into sources. Keep concept ids stable when you edit it.

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": {
      "course": "<course>",
      "roadmap": "<roadmap>"
    },
    "name": "save_roadmap"
  }
}

Input Schema

NameRequiredDescriptionDefault
courseYesCourse id, e.g. c-pointers
roadmapYesRoadmap YAML

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior3/5

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

With no annotations the description carries the full burden; it does disclose a meaningful side effect ('make it active in this workspace') and an editing caution about id stability, but says nothing about whether the roadmap is replaced wholesale, any validation/error behavior, or permission requirements.

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?

Front-loaded with the action and effect, then the format spec; every clause is load-bearing, though the format enumeration is dense and could be broken into clearer segments.

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?

Given a mutation tool with a free-form YAML parameter and no output schema, the description supplies the format knowledge an agent needs to construct a valid call; only the overwrite/validation semantics are missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema only labels the two parameters, while the description specifies the entire YAML contract: required top-level fields, the 60-character title limit, the id@version track format, the io|unit|quiz|none style values, the concept object shape, and the refs-into-sources indexing rule — substantial meaning the schema does not provide.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Create or update the course roadmap') plus the resulting effect ('make it active in this workspace'), which clearly separates it from the read-only sibling get_roadmap without naming it.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

'Create or update' implies an upsert and documents the edit case ('keep concept ids stable when you edit it'), but there is no explicit statement of when to use this versus save_track/save_lesson or what prerequisites exist (e.g. must the course exist first).

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