Skip to main content
Glama

add_note

Log progress or findings as a note on a task card without alerting agents, altering outcomes, or ending the turn; use when no action is needed.

Instructions

Write a note on a card that wakes nobody: no mention or handoff delivery, no outcome, the checkout untouched. For progress logs and findings that need no action; a note does not end your turn — finish it with wait_for, continue_next, ask_agent, ask_human, finish_task or hand_off.

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>",
      "text": "<text>"
    },
    "name": "add_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
textYesNote body in markdown.
task_idYesThe card to write the note on (UUID or 6-12 hex short id).
turn_idNoOptional turn id within the session (max 200 chars), copied onto the outcome.
session_idNoOptional runner session id (max 200 chars), copied onto the recorded outcome and wait.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.7

TDQS

A4.4/5.0
Behavior4/5

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

The annotations only declare generic hints (not read-only, not destructive, not idempotent), so the description carries most of the load — and it does, disclosing that the note wakes nobody, records no outcome, leaves the checkout alone, and leaves the turn open. The one undisclosed trait is that repeated calls are not idempotent (duplicate notes are presumably created), which an agent might reasonably want to 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?

Two sentences, zero filler, with the core effect and its negative scope front-loaded before the follow-up obligation. The compressed phrasing ("the checkout untouched") is dense but readable.

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?

With no output schema, the description still fully conveys side effects and the required next step, which is what an agent needs most here. The only shortfall is that duplicate-note behavior (non-idempotence) and any visibility/permission expectations on the card are left unstated.

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 every parameter including turn_id and session_id is already documented in the schema. The description adds no additional meaning about parameter formats or the copy-onto-outcome behavior of turn_id/session_id, so it sits at the baseline for schema-complete tools.

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?

"Write a note on a card" gives a specific verb and resource, and the rest of the sentence delimits it negatively: no mention delivery, no handoff, no outcome, checkout untouched. An agent knows exactly what this produces and what it does not, distinguishing it from comment/mention/handoff-style siblings 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 Guidelines5/5

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

It states the intended use case ("progress logs and findings that need no action") and then warns that the note does not end the turn, listing the six tools that must follow. That is both a when-to-use rule and an explicit routing instruction to alternatives.

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