productplan-mcp-server

Overview Schema Source Related Servers Discussions Admin

get_roadmap

Read-only

Retrieve roadmap name, date range, sharing settings, and metadata to identify accepted values for legends, lanes, and custom fields before managing bars.

Instructions

Get roadmap settings and metadata.

USE WHEN: "Tell me about roadmap X", "Roadmap settings", "What custom fields does this roadmap have?" For all data in one call (bars, lanes, milestones), use get_roadmap_complete. Returns roadmap name, date range, sharing settings, and metadata, including the vocabulary bar writes must use: legends (names), lanes (names), custom_text_fields [{label}], and custom_dropdown_fields [{label, allowed_values}]. manage_bar and the bulk_*_bars tools validate against exactly these. FAILS WHEN: roadmap_id not found (get valid IDs from list_roadmaps first).

Input Schema

TableJSON Schema

Name	Required	Description	Default
`roadmap_id`	Yes	Roadmap ID from list_roadmaps

Output Schema

TableJSON Schema

Name	Required	Description	Default
`data`	Yes	The ProductPlan payload (object or array) returned by the API, passed through verbatim
`summary`	Yes	Human-readable summary of the result (e.g. "Found 3 roadmaps")

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv6.0.0Sep 25, 2026

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"
+}

First observedv5.0.0Mar 9, 2026

TDQS

A4.9/5.0

Behavior5/5

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

Beyond the readOnlyHint annotation, the description explains what the call returns and that the returned vocabulary (legends, lanes, custom fields) is exactly what manage_bar and bulk_*_bars tools validate against. It also discloses the failure mode for missing roadmap IDs, adding genuinely useful behavioral context.

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?

The description is well-structured into clear sections with no filler. The core purpose is front-loaded, and each section—USE WHEN, alternative, return content, FAILS WHEN—earns its place without redundancy.

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 read-only settings/metadata tool with a single fully-documented parameter and an output schema, the description covers everything an agent needs: purpose, usage context, sibling differentiation, failure behavior, and prerequisite. Nothing critical is missing.

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

Parameters4/5

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

The schema already fully documents roadmap_id with 100% coverage, so the baseline is 3. The description adds value by explicitly instructing the agent to obtain valid IDs from list_roadmaps first and by stating the failure condition when the ID is not found, reinforcing the parameter's provenance and validation expectations.

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 opens with 'Get roadmap settings and metadata,' a specific verb and resource. It differentiates from the sibling get_roadmap_complete by explicitly limiting scope to settings/metadata, and the USE WHEN examples make the tool's purpose unmistakable.

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?

Provides explicit USE WHEN examples and names the alternative get_roadmap_complete for cases needing all data in one call. The FAILS WHEN section identifies the prerequisite of getting valid IDs from list_roadmaps first, giving clear selection and sequencing guidance.

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

Deploy Server