Skip to main content
Glama
olgasafonova

productplan-mcp-server

by olgasafonova

get_bar_links

Read-only

Retrieve external links on a roadmap bar, such as Jira tickets, documents, and designs. Use this to view linked items or show Jira tickets for a bar.

Instructions

Get external links on a bar (Jira, docs, designs).

USE WHEN: "What's linked?", "Show Jira tickets" FAILS WHEN: bar_id not found. Returns empty list if bar has no external links.

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
Behavior5/5

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

Beyond the readOnlyHint annotation, the description discloses two failure/behavior traits: it fails when bar_id is not found and returns an empty list when there are no external links. This is useful behavioral context that an agent would not otherwise know.

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?

Three purpose-built lines: the core action, a USE WHEN trigger, and a FAILS WHEN condition. Every sentence contributes, and the core action is front-loaded.

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 single-parameter read-only lookup with an output schema, the description covers the essential usage triggers and edge cases. Nothing material is missing for an agent to invoke it correctly.

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?

The schema already documents bar_id with 100% coverage, so the baseline applies. The description mentions 'bar_id not found' but does not add format, source, or usage details beyond the schema's 'Bar ID'.

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 opening sentence names a specific verb ('Get'), resource ('external links on a bar'), and gives concrete link categories ('Jira, docs, designs'), making the tool's purpose unmistakable. This also differentiates it from similar get_* siblings by scoping it to external links rather than connections, comments, or general bar data.

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

Usage Guidelines4/5

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

The explicit 'USE WHEN' section gives trigger phrases ('What's linked?', 'Show Jira tickets') that an agent can match to user intent. It does not enumerate alternatives or when not to use the tool, but for a simple lookup this is clear contextual guidance.

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