Skip to main content
Glama

Update Planner Task Details

update_planner_task_details
Destructive

Update a Planner task's description, checklist items, and reference links in one call. Add, edit, or remove entries by GUID or URL; omitted fields keep their current values.

Instructions

Update a Planner task's details: description, checklist items, and references (links). The ETag is fetched automatically. Add, update, or remove entries — updates merge (omitted fields keep their current value); update/remove of a missing item is reported as skipped, not a silent no-op. Checklist items are addressed by their GUID (from get_planner_task); references by their URL.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "task_id": "<task_id>"
    },
    "name": "update_planner_task_details"
  }
}

Input Schema

NameRequiredDescriptionDefault
task_idYesTask ID
descriptionNoTask description / notes
preview_typeNoWhat shows on the task card face
add_checklistNoChecklist items to add
add_referencesNoReference links to add
remove_checklistNoChecklist item GUIDs to remove
update_checklistNoChecklist items to edit, addressed by GUID (e.g. toggle isChecked)
remove_referencesNoReference URLs to remove
update_referencesNoReference links to edit, addressed by URL (e.g. rename the alias)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior5/5

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

Goes well beyond the destructiveHint=true annotation: it discloses that the ETag is fetched automatically (no concurrency handling needed by the caller), that omitted fields are preserved by merge semantics, and that updating/removing a missing entry is reported as skipped rather than silently ignored. Those are exactly the behaviors an agent needs before performing a destructive mutation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tight sentences, front-loaded with the resource and field scope, then semantics, then addressing keys. The semicolon-and-parenthetical density is slightly heavy but no sentence is filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 9-parameter mutation tool with no output schema, it covers the tricky parts: merge behavior, ETag handling, identifier sources, and skip reporting. Minor omissions remain around preview_type behavior and what a successful response contains.

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?

Schema coverage is 100%, so the baseline is 3, and the description adds real meaning on top: checklist items are keyed by GUID while references are keyed by URL, and omitted fields retain current values. The preview_type enum values are left unmentioned, which is the main remaining gap.

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?

States a specific verb and resource plus the exact field scope it owns: description, checklist items, and references. That scope implicitly separates it from the sibling update_planner_task, so an agent can pick the right tool without opening a schema.

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?

Explicitly frames the three operations (add, update, remove) and names the prerequisite source of identifiers, telling the agent to pull GUIDs from get_planner_task and to address references by URL. It stops short of naming update_planner_task as the alternative for non-detail fields or stating when not to use this tool.

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