Skip to main content
Glama

Add an internal note

add_entry_note

Add a staff-only internal note to an entry (plain text; links are kept). Audited. Dry run by default.

Input Schema

NameRequiredDescriptionDefault
textYes
entryYesThe entry: its VHID (11 digits), its short name (as in verifiedhandles.org/<short>), or its Wikidata QID (Q42).
dry_runNotrue (the default): write nothing — show the change and the exact request it would send. false: make the change.

Output Schema

NameRequiredDescriptionDefault
noteNoA dry run: what to do next to make the change, in words.
resultNoA real run: the route’s own answer, where the tool adds facts of its own beside it.
confirmNoA dry run of a change that needs it: the exact target to send back as `confirm` with dry_run: false.
dry_runNotrue: a dry run, which wrote nothing. Absent from a real run.
replayedNoA real run with an idempotency_key already used for this change: the first call’s answer, given back; nothing was written now.
would_sendNoA dry run: the exact request the real run would send (`method`, `path`, any `headers` such as an Idempotency-Key, and its `body`, `form` or `query`), or the requests, in order.
may_edit_liveNoA dry run of a live edit: whether this key’s account may edit this entry live.
refused_becauseNoA dry run the real run would be refused for: why, in words.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.6/5.0
Behavior4/5

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

Adds traits the annotations don't: 'staff-only' discloses visibility scope, 'Audited' discloses that the action is logged, and 'Dry run by default' warns that the call previews rather than writes unless overridden. This is meaningful context for a non-readOnly, non-idempotent mutation, though it omits who is authorized and whether repeated identical adds create duplicates.

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?

Three compact fragments, purpose front-loaded, no filler. Each clause ('staff-only', 'links are kept', 'Audited', 'Dry run by default') carries a distinct piece of information.

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 an output schema present, return values need not be described, and the identifier semantics for entry are covered in-schema. The description covers visibility, audit, and the dry-run gate, leaving only minor gaps around authorization and duplicate-note behavior.

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 67%: entry and dry_run are documented in-schema, while text is not. The description partially compensates by specifying that text is 'plain text' and that 'links are kept', which is real semantic value the schema lacks, but it says nothing about length limits or content restrictions.

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+resource ('Add a ... note to an entry') and qualifies the note as 'staff-only internal', which sets it apart from public comments like comment_on_application. It doesn't explicitly differentiate from edit_entry_note or delete_entry_note, but the verb choice makes the distinction inferable.

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

Usage Guidelines2/5

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

No statement of when to use this tool versus edit_entry_note, delete_entry_note, or list_entry_notes, and no prerequisites or exclusions. The only usage signal is the default dry_run behavior, which is implied rather than explained as a workflow step.

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.