Skip to main content
Glama

Update Knowledge Note

update_knowledge_note
Destructive

Replace the text of a note in a notebook with new text.

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": {
      "note_id": "<note_id>",
      "content": "<content>"
    },
    "name": "update_knowledge_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
app_idNoOptional app whose notebooks to use. Omitted: the owner's own Business Brain.
contentYes
note_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.1/5.0
Behavior3/5

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

The annotations already declare destructiveHint=true and readOnlyHint=false, so the description's use of 'Replace' is consistent and adds the useful detail that the prior text is wholly overwritten rather than appended. It does not mention permission requirements, whether the note identity or metadata survives, or any irreversibility caveat beyond what the hint implies.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single efficient sentence with no wasted clauses, front-loaded on the verb and resource. It is arguably too terse rather than too long, but structurally clean.

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

Completeness2/5

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

For a destructive, non-idempotent mutation with no output schema and half its parameters undocumented, the definition leaves too much unsaid: what a successful response reports, what failure looks like for a bad note_id, and how the app_id scoping behaves. The annotations carry the safety profile, but the operational picture is incomplete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 33% — only app_id carries an inline description, while content and note_id have length bounds but no meaning. The description does not compensate: it never explains that note_id targets an existing note, nor that app_id scopes which notebook owner's Business Brain is used, even though it gestures vaguely at 'a notebook'.

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 pairs a specific verb with a specific resource ('Replace the text of a note in a notebook'), which is enough to distinguish it from add_knowledge_note and the rename/move notebook siblings. It stops short of clarifying whether the replacement is whole-document or partial, so the verb is slightly ambiguous against the tool name's 'update'.

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?

It implies the usage context (an existing note whose text you want to change) but never states when to prefer this over add_knowledge_note or rename_knowledge_document, nor any prerequisites such as notebook access. Nothing is misleading, but an agent must infer the selection criteria from the sibling names alone.

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.

Resources