Skip to main content
Glama

tasks_note

Append a dated note to a sprint, task, or subtask to record progress, decisions, or patch pointers.

Instructions

Append a dated note to an item (progress, decisions, pointers to patches).

Input Schema

NameRequiredDescriptionDefault
idYesItem id: sprint '1', task '1.2', subtask '1.2.3'
textYesNote text

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.6

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare this is a non-destructive mutation. The description adds that notes are appended and dated, which is useful behavioral context, but it does not describe return behavior, idempotency, or what happens to prior notes.

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?

A single sentence with the action front-loaded and zero wasted words. The parenthetical examples are compact and informative.

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 simple two-parameter note-append tool with full schema coverage and non-destructive annotations, the description is nearly complete. A minor gap is that it does not mention confirmation or return behavior, though no output schema exists requiring that detail.

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%, so both parameters are already documented. The description adds examples of note content, but it does not add syntax or format details beyond the schema's 'Note text' and 'Item id' definitions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: 'Append a dated note to an item,' with examples of note content. It is clear what the tool does, though it does not explicitly distinguish itself from siblings like tasks_log or tasks_edit.

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 parenthetical examples (progress, decisions, pointers to patches) give clear context for when to use this tool. There is no explicit when-not guidance or named alternative, but the intended use is evident.

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