Skip to main content
Glama

Write a note

set_note
Destructive

Write or edit notes explaining what a database table or column means; omit the column to describe the table itself, or leave the note empty to remove it.

Instructions

Write or edit the user's note on what a table, or one of its columns, means. Leave out column for the table's own note; an empty note removes it.

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": {
      "source": "<source>",
      "table": "<table>",
      "note": "<note>"
    },
    "name": "set_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
noteYes
tableYes
columnNo
sourceYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false and destructiveHint=true, and the description adds concrete, non-redundant detail: an empty note string is the deletion mechanism, and the write targets the user's own note rather than a shared one. It stops short of describing what happens to an existing note on overwrite or what the call returns.

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, front-loaded with the action, and each clause carries real information: the target resource, the column-omission rule, and the empty-note deletion behavior. Nothing is padded or redundant.

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

Completeness3/5

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

For a destructive mutation with zero schema description coverage and no output schema, the definition covers the highest-risk semantics (deletion via empty note) but leaves `source` unexplained and says nothing about permissions, overwrite behavior, or the effect on existing content. Adequate to call correctly but not fully complete.

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 0%, so the description must carry parameter meaning, and it explains the two semantically tricky ones well: `note` (empty string removes) and `column` (omit for the table-level note). The `source` parameter is never mentioned and `table` is only implied, leaving a meaningful gap on a four-parameter tool.

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 gives a specific verb pair ('Write or edit') and a precise resource ('the user's note on what a table, or one of its columns, means'), and the 'leave out column' clause clarifies the two target types. It does not distinguish itself from the sibling 'column_note', so the agent cannot tell from this text alone which one to pick.

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?

The conditional 'Leave out `column` for the table's own note' is genuine usage guidance for selecting between two modes of the same call. However, there is no guidance on when to use this tool versus alternatives such as column_note, and no prerequisites or scope warnings for a write operation.

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