Skip to main content
Glama
olgasafonova

productplan-mcp-server

by olgasafonova
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Go
Local

get_roadmap_comments

Read-only

Retrieve roadmap-level comments with author, body, and timestamp to display roadmap discussions. Use when you need to show comments for a specific roadmap.

Instructions

Get roadmap-level comments (not bar comments).

USE WHEN: "Show roadmap comments", "Roadmap discussion" For bar-level comments, use get_bar_comments instead. Returns array of comments with author, body, and timestamp. 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.5/5.0
Behavior4/5

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

Annotations already cover readOnlyHint=true, so the description need not restate read-only behavior. It adds a failure condition (roadmap_id not found) and suggests list_roadmaps, plus specifies the return array shape (author, body, timestamp). No contradictions with annotations.

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 compact and well-structured: a clear primary statement, usage trigger, alternative, return format, and failure mode. Every sentence adds value with no 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?

With only one parameter, a read-only annotation, an existing output schema, and clear sibling differentiation, the description covers usage, alternative, failure, and return shape. No critical information is missing for correct invocation.

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% for roadmap_id, so the schema already documents its meaning. The description adds no new parameter semantics beyond the failure condition, which is more behavioral than semantic. Baseline 3 applies.

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 clearly states the verb 'Get' and the resource 'roadmap-level comments', and explicitly contrasts with bar comments, distinguishing it from the sibling get_bar_comments. This gives an unambiguous purpose.

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?

It provides explicit trigger phrases like 'Show roadmap comments' and 'Roadmap discussion', and names the exact alternative (get_bar_comments) for bar-level comments, making the selection criteria unambiguous.

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

Deploy Server

Other Tools