Skip to main content
Glama
olgasafonova

productplan-mcp-server

by olgasafonova

get_roadmap_complete

Read-only

Fetch all roadmap elements (details, bars, lanes, milestones) in a single call to get a full roadmap overview or summary.

Instructions

Get complete roadmap in one call. Details, bars, lanes, milestones combined.

USE WHEN: "Full roadmap overview", "Summarize roadmap X" For settings/metadata only, use get_roadmap. Returns combined roadmap details, bars, lanes, and milestones in one response. FAILS WHEN: roadmap_id not found (use list_roadmaps).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
roadmap_idYesRoadmap ID

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesThe ProductPlan payload (object or array) returned by the API, passed through verbatim
summaryYesHuman-readable summary of the result (e.g. "Found 3 roadmaps")

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv6.0.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "data": {
      +      "description": "The ProductPlan payload (object or array) returned by the API, passed through verbatim",
      +      "type": "object"
      +    },
      +    "summary": {
      +      "description": "Human-readable summary of the result (e.g. \"Found 3 roadmaps\")",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "summary",
      +    "data"
      +  ],
      +  "type": "object"
      +}
  2. First observedv5.0.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, and the description adds meaningful behavioral context beyond that: it is a combined aggregation call, it returns multiple data categories in one response, and it fails when the roadmap_id is missing. This is useful complementary transparency, though auth and rate-limit details are not mentioned.

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?

The description is front-loaded and compact, with clear USE WHEN and FAILS WHEN sections. However, the opening sentence and the later sentence both repeat the same combined-return information, creating minor redundancy that prevents a perfect score.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter, read-only tool with an output schema, the description covers the essential context: what it returns, when to use it, when not to use it, and what happens on failure. Nothing an agent needs to call it correctly is missing.

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%, and the only parameter, roadmap_id, is already documented as 'Roadmap ID'. The description does not add additional semantic detail about the parameter, so the baseline score of 3 is appropriate.

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?

The description uses a specific verb ('Get'), names the exact resource ('complete roadmap'), and clarifies that it combines details, bars, lanes, and milestones. It distinguishes itself from get_roadmap, so an agent can tell them apart without needing to inspect schemas.

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

Usage Guidelines5/5

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

The 'USE WHEN' section gives concrete example queries ('Full roadmap overview', 'Summarize roadmap X'), explicitly directs the agent to get_roadmap for settings/metadata only, and provides a failure fallback ('use list_roadmaps' when roadmap_id is not found). This leaves no ambiguity about when to select this tool.

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