Skip to main content
Glama

Write a note

write_note
DestructiveIdempotent

Save a note in your notebook, or replace the note that already has this name. Text up to 8000 characters.

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": {
      "notebook": "<notebook>",
      "key": "<key>",
      "value": "<value>"
    },
    "name": "write_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
keyYesNote name, e.g. todo or project/status.
valueYesNote text: plain text, Markdown or JSON.
notebookYesSecret notebook token returned by create_notebook.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.8/5.0
Behavior4/5

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

The description adds real behavioral context beyond the annotations: the replacement semantics explain and reinforce destructiveHint=true and idempotentHint=true, and the 8000-character cap is a constraint that appears nowhere in the schema. It does not cover error behavior for an invalid or expired notebook token, which is the remaining gap.

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 short sentences, both of which carry load: the first defines the operation and its overwrite behavior, the second states a hard size limit. Front-loaded with the primary action and no 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 three-parameter write tool with full schema coverage, annotations covering the safety profile, and no output schema, this is nearly sufficient: operation, overwrite behavior, and size limit are all present. Only failure modes (invalid notebook token, key collisions outside the pattern) are left unaddressed.

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 coverage is 100%, so the baseline is 3; key, value, and notebook are all documented in the schema itself. The description adds the 8000-character limit on value, which is meaningful new information not encoded as maxLength in the schema, but nothing further about key naming or token handling beyond what the schema already says.

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?

States a specific verb and resource ("Save a note in your notebook") and clarifies the upsert semantics with "or replace the note that already has this name." An agent can distinguish it from read_notes and delete_note by inference, but no sibling is named explicitly.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: the word "Save" signals a write operation, and the overwrite clause tells the agent what happens when the key exists. There is no explicit guidance on when to choose this versus read_notes, or any prerequisite such as requiring a notebook created via create_notebook.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.