Skip to main content
Glama

Get roadmap

get_roadmap
Read-onlyIdempotent

A roadmap's lanes, rows, items, milestones, checklists, progress and dependencies, with the ids the other tools need. roadmap.features says which optional features (goals, initiatives) are on for this roadmap. When switched on, items also carry priority, status, owner, risk flag, goal and initiative; the result adds roadmap health, goal progress, initiative roll-ups (span and progress), the attached holiday lists and the holidays within the roadmap's range.

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

Input Schema

NameRequiredDescriptionDefault
roadmapIdYesRoadmap id from list_roadmaps

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent and non-destructive, so the safety profile is covered. The description adds real behavioral context beyond that: the result is conditional on roadmap.features, and specific extra fields (priority, status, owner, risk, goal, initiative, health, roll-ups, holidays) only appear when features are switched on. That variable-shape disclosure is genuinely useful and not derivable from the schema.

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?

Content is front-loaded: what is returned comes first, then the conditional shape. It is a dense enumeration rather than wasted prose, though the packing of feature-conditional fields into one long sentence costs some readability.

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 takes on the burden of explaining what comes back, and does so thoroughly including conditional extras. The remaining gap is the absence of guidance on when this is the right call versus the sibling listing/summary tools.

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?

There is a single parameter with 100% schema description coverage already telling the agent it is a roadmap id from list_roadmaps. The description adds no constraint, format, or sourcing detail beyond that, so the baseline 3 for high schema coverage 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 names the specific resource (a roadmap) and enumerates its contents — lanes, rows, items, milestones, checklists, progress, dependencies — plus the key value proposition of returning ids other tools need. It is not a tautology, but it never states the verb explicitly and does not contrast itself with list_roadmaps, leaving the sibling distinction implicit.

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?

The phrase 'with the ids the other tools need' implies this is the entry point before calling downstream tools, which is useful implied guidance. There is no explicit when-to-use versus when-not (e.g. when to prefer export_roadmap_summary or list_roadmaps), so the agent must infer the routing.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources