Skip to main content
Glama
olgasafonova

productplan-mcp-server

by olgasafonova

manage_bar

Destructive

Create, update, or delete roadmap bars by adding features, adjusting dates, changing colors, or nesting items. Handles single-bar changes with precise field control.

Instructions

Create, update, or delete a bar on a roadmap.

USE WHEN: "Add feature", "Update dates", "Delete item", "Change color", "Nest this bar under that one" For many bars at once (e.g. "color these 30 bars"), use bulk_update_bars, bulk_create_bars, or bulk_delete_bars instead. Actions: create (roadmap_id + name + lane or lane_id), update (bar_id + any fields), delete (bar_id) Color a bar with legend (a legend NAME from get_roadmap_legends); legend:"" or clear_legend:true removes the color. Omitted fields are never sent, so an update only touches what you pass. New bars are parked (off the timeline) by ProductPlan's default. When you give starts_on and ends_on on create and leave parked unset, the bar defaults to parked:false so it lands on the timeline; a nested bar inherits its container's parked state. Names (legend, lane, custom field labels, dropdown values) are checked against the roadmap before writing, matched case-insensitively, and sent in canonical spelling. Returns: create gives the new bar's id plus the bar read back; update gives the exact fields sent. FAILS WHEN: create without roadmap_id, name, or a lane; update/delete without bar_id; a legend, lane, or custom field name is not on the roadmap (the error lists the valid ones); container_bar_id on a bar without both dates, or a parked state that differs from the container's. legend_id and effort are rejected with an explanation (legend_id would wipe the bar's color). A bar cannot be un-nested via the API once container_bar_id is set. WARNING: delete is permanent and cannot be undone.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
laneNoLane NAME (see get_roadmap lanes). Use this or lane_id
nameNoBar name
tagsNoTag strings; REPLACES the bar's tag list. [] clears it
notesNoAdditional notes
actionYescreate, update, or delete
bar_idNoBar ID (for update/delete)
effortNoDEPRECATED and rejected: not a ProductPlan bar field (the API ignores it). Use a custom field
legendNoLegend NAME that colors the bar (from get_roadmap_legends). Empty string clears the color
parkedNoTrue parks the bar (off the timeline, kept on the roadmap). Must match the container's when nested
ends_onNoEnd date YYYY-MM-DD
lane_idNoLane ID from get_roadmap_lanes. Use this or lane
containerNoDEPRECATED alias for is_container
legend_idNoDEPRECATED and rejected: the API reads legend_id as 'clear the color'. Use legend (name)
parent_idNoDEPRECATED alias for container_bar_id
starts_onNoStart date YYYY-MM-DD
roadmap_idNoRoadmap ID (required for create; optional on update to skip looking up the bar's roadmap)
descriptionNoDescription (markdown)
clear_legendNoTrue to remove the bar's color (same as legend:"")
is_containerNoTrue to make the bar a container for child bars
percent_doneNoProgress 0-100
strategic_valueNoFree-text strategic importance note
container_bar_idNoNumeric ID of the container bar to nest under. Requires starts_on and ends_on on the bar; cannot be removed once set
custom_text_fieldsNo[{label,value}] using labels from get_roadmap custom_text_fields
custom_dropdown_fieldsNo[{label,value}]; value must be one of the field's allowed_values from get_roadmap

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed17 schema fields changedv6.0.0
    • addedInput schema / properties / clear_legend
      Added value: +{
      +  "description": "True to remove the bar's color (same as legend:\"\")",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / container / description
      Previous value: -"Is container for children"New value: +"DEPRECATED alias for is_container"
    • addedInput schema / properties / container_bar_id
      Added value: +{
      +  "description": "Numeric ID of the container bar to nest under. Requires starts_on and ends_on on the bar; cannot be removed once set",
      +  "type": "string"
      +}
    • changedInput schema / properties / custom_dropdown_fields / description
      Previous value: -"[{name,value}] custom dropdowns"New value: +"[{label,value}]; value must be one of the field's allowed_values from get_roadmap"
    • changedInput schema / properties / custom_dropdown_fields / items / description
      Previous value: -"Custom dropdown field with name and value"New value: +"{\"label\": \"<field label>\", \"value\": \"<allowed value>\"}"
    • changedInput schema / properties / custom_text_fields / description
      Previous value: -"[{name,value}] custom text fields"New value: +"[{label,value}] using labels from get_roadmap custom_text_fields"
    • changedInput schema / properties / custom_text_fields / items / description
      Previous value: -"Custom text field with name and value"New value: +"{\"label\": \"<field label>\", \"value\": \"<text>\"}"
    • changedInput schema / properties / effort / description
      Previous value: -"Effort estimate (unitless integer, scale per team)"New value: +"DEPRECATED and rejected: not a ProductPlan bar field (the API ignores it). Use a custom field"
    • addedInput schema / properties / is_container
      Added value: +{
      +  "description": "True to make the bar a container for child bars",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / lane
      Added value: +{
      +  "description": "Lane NAME (see get_roadmap lanes). Use this or lane_id",
      +  "type": "string"
      +}
    • changedInput schema / properties / lane_id / description
      Previous value: -"Lane ID (for create; update to move)"New value: +"Lane ID from get_roadmap_lanes. Use this or lane"
    • addedInput schema / properties / legend
      Added value: +{
      +  "description": "Legend NAME that colors the bar (from get_roadmap_legends). Empty string clears the color",
      +  "type": "string"
      +}
    • changedInput schema / properties / legend_id / description
      Previous value: -"Color from get_roadmap_legends"New value: +"DEPRECATED and rejected: the API reads legend_id as 'clear the color'. Use legend (name)"
    • changedInput schema / properties / parent_id / description
      Previous value: -"Parent bar ID for nesting"New value: +"DEPRECATED alias for container_bar_id"
    • changedInput schema / properties / parked / description
      Previous value: -"True to park bar (removes from timeline, keeps on roadmap)"New value: +"True parks the bar (off the timeline, kept on the roadmap). Must match the container's when nested"
    • changedInput schema / properties / roadmap_id / description
      Previous value: -"Roadmap ID (for create)"New value: +"Roadmap ID (required for create; optional on update to skip looking up the bar's roadmap)"
    • changedInput schema / properties / tags / description
      Previous value: -"Tag strings [\"mobile\",\"urgent\"]"New value: +"Tag strings; REPLACES the bar's tag list. [] clears it"
  2. Changed3 schema fields changedv5.1.0
    • changedInput schema / properties / effort / description
      Previous value: -"Effort estimate"New value: +"Effort estimate (unitless integer, scale per team)"
    • changedInput schema / properties / parked / description
      Previous value: -"Not actively scheduled"New value: +"True to park bar (removes from timeline, keeps on roadmap)"
    • changedInput schema / properties / strategic_value / description
      Previous value: -"Strategic importance"New value: +"Free-text strategic importance note"
  3. First observedv5.0.0

TDQS

A5/5.0
Behavior5/5

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

Annotations only declare destructiveHint=true, but the description goes far beyond that: it discloses omitted fields are never sent, new bars are parked by default, names are canonicalized case-insensitively, legend_id is rejected to prevent color wiping, bars cannot be un-nested, and delete is permanent. This is substantial behavioral context that directly informs how the agent invokes the tool.

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 dense but well-structured with USE WHEN, Actions, and FAILS WHEN sections. Every section adds operational value, and front-loading the core action makes the tool's purpose immediately clear despite the large parameter surface.

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 24-parameter mutation tool with no output schema, the description covers invocation intents, alternative routing, failure conditions, return values for create/update, default behaviors, naming rules, deprecation traps, and permanence of deletion. This is as complete as an agent needs for correct selection and invocation.

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

Parameters5/5

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

Although schema coverage is 100%, the description adds critical semantic constraints not derivable from the schema alone: legend names must come from get_roadmap_legends, nested bars must match the container's parked state, container_bar_id requires both dates and cannot be removed, and effort/legend_id are rejected. This meaningfully improves parameter understanding.

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 a specific verb and resource: 'Create, update, or delete a bar on a roadmap.' It also differentiates itself from bulk siblings by explicitly naming single-bar actions and pointing to bulk_create_bars, bulk_update_bars, and bulk_delete_bars for multi-bar scenarios.

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 lists concrete user intents like 'Add feature', 'Update dates', and 'Delete item', and explicitly directs agents to bulk_* tools when handling many bars at once. The 'FAILS WHEN' section further clarifies invalid usage conditions, leaving little ambiguity about when this tool is appropriate.

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