Skip to main content
Glama

update_note

Modify existing wiki notes with partial title, body, or tag edits, automatic backups, last-updated timestamps, and dry-run previews.

Instructions

기존 wiki 노트 수정 — 부분 수정 가능, 자동 .bak 백업, last_updated 자동 갱신.

안전장치: - 수정 전 자동 백업 (.bak.) - body/title/tags 각각 독립적 부분 수정 (None 시 해당 필드 유지) - last_updated 자동 갱신 (오늘 날짜) - dry_run=True 시 변경사항 미리보기만 반환

Args: id: 수정할 노트 ID body: 새 본문. None 시 본문 유지. append=True면 기존 본문 끝에 추가. title: 새 제목. None 시 제목 유지. tags: 새 태그 목록. None 시 태그 유지. append: True 시 body를 기존 본문에 추가 (교체 아님). 기본 False. dry_run: True 시 미리보기만 반환, 파일 미수정. 기본 False.

Returns: JSON — status (ok/error/preview), path, backup, changes

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": {
      "id": "<id>"
    },
    "name": "update_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
bodyNo
tagsNo
titleNo
appendNo
dry_runNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

A4/5.0
Behavior4/5

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

With no annotations supplied, the description carries the full burden and does substantial work: it discloses that an automatic timestamped .bak backup file is written before each edit, that last_updated is auto-refreshed, that omitted fields are preserved, and that dry_run prevents file modification. It omits error conditions, permission requirements, and concurrency concerns, which keeps it from a 5.

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?

The first line front-loads purpose and the three behavioral traits, with structured safety/Args/Returns sections after. There is some redundancy — 'None 시 유지' is stated in the safety list and again per parameter — which costs a bit of tightness but aids scanability.

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 mutation tool with six parameters and no annotations, the definition covers purpose, side effects, per-parameter semantics, and preview mode. Return values are already covered by the existing output schema, so the brief Returns note is a bonus rather than a necessity; only permission/error behavior is missing.

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

Parameters5/5

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

Schema description coverage is 0%, so the description must compensate entirely, and it does: all six parameters get explicit meaning, including the None-keeps-field semantics for body/title/tags, the append interaction with body, and the defaults for append and dry_run. This is exactly the added value the schema lacks.

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 ('기존 wiki 노트 수정' — modify an existing wiki note) and immediately qualifies scope with '부분 수정 가능' and '기존', which implicitly separates it from create_note. It stops short of naming any sibling tool explicitly, so an agent must infer the create-vs-update boundary itself.

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 definition gives useful in-tool routing: body/title/tags are independently optional, append=True means append rather than replace, and dry_run=True previews. However it never says when to prefer a sibling (create_note, delete_note) or when not to use this tool, so alternative selection is left to inference.

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