Skip to main content
Glama
olgasafonova

productplan-mcp-server

by olgasafonova

get_bar_comments

Read-only

Retrieve comments and feedback for a specific bar by its ID to review input on roadmap items.

Instructions

Get comments on a bar.

USE WHEN: "Show comments", "What's the feedback on this bar?" For roadmap-level comments, use get_roadmap_comments instead. FAILS WHEN: bar_id not found.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bar_idYesBar 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 declare readOnlyHint=true, so the read-only nature is covered. The description adds a valuable behavioral detail: the tool fails when bar_id is not found, which is not captured in annotations or schema. This extra failure mode disclosure goes beyond the structured metadata, though it doesn't detail return format or pagination (likely covered by output schema).

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 extremely concise, with a one-line purpose, a clear 'USE WHEN' block, and a 'FAILS WHEN' block. No wasted words. The main purpose is front-loaded, and the usage guidance is immediately actionable.

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 simple read-only tool with one parameter and an output schema, the description covers all necessary aspects: what it does, when to use it, what to use instead, and a known failure condition. The output schema handles return format, so nothing critical 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% (bar_id has a description 'Bar ID'), so the schema already documents the parameter. The description does not add additional meaning about bar_id, but given the high coverage, the baseline of 3 is appropriate. The tool name and description context make the parameter's role clear.

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 and resource: 'Get comments on a bar.' It also distinguishes itself from the closely related sibling get_roadmap_comments by explicitly saying to use that tool for roadmap-level comments. This makes the purpose unmistakable and differentiates it from similar get_* tools.

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 description provides explicit 'USE WHEN' triggers with example user phrases and names the alternative tool for a different scenario (roadmap-level comments). It also includes a 'FAILS WHEN' condition (bar_id not found). This gives clear, actionable guidance on when to choose this tool over siblings.

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