Skip to main content
Glama

Create or replace a hand-written note

brain_write
DestructiveIdempotent

Create or replace a hand-maintained note under Notes/ or Captures/ for hubs, guides, and runbooks, setting its type and metadata; only designated vault paths can be written.

Instructions

Create a note at a path you choose under Notes/ or Captures/, or replace one there with overwrite=true. Use it for hubs, guides and runbooks maintained by hand. Unlike brain_capture you set the type, including 'hub': a hub groups every note whose frontmatter project matches its title. Generated notes elsewhere in the vault cannot be written. The reply lists existing notes the body names without linking.

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": {
      "path": "<path>",
      "title": "<title>",
      "body": "<body>"
    },
    "name": "brain_write"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesMarkdown body, without frontmatter or the # title heading. Link related notes inside the sentence that says how they relate.
pathYesVault path, e.g. 'Notes/Harbor Ledger.md'
typeNonote, hub, moc, guide, runbook, plan, decision, ...note
orderNoPosition among Notes/ guides on Start Here
titleYes
topicsNoConcept names, e.g. ['OAuth', 'RAG']
projectNoHub this note belongs to, e.g. 'Harbor Ledger'
summaryNoOne line; Start Here shows it next to Notes/ guides
overwriteNoReplace the note if the path already exists

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.5.2
    • changedInput schema / properties / body / description
      Previous value: -"Markdown body, without frontmatter or the # title heading"New value: +"Markdown body, without frontmatter or the # title heading. Link related notes inside the sentence that says how they relate."
  2. First observedv0.4.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare destructiveHint and idempotentHint, so the safety bar is lower; the description still adds real context beyond them: the path-root restriction, that overwrite replaces an existing note, and the non-obvious return behavior (existing notes named without linking, with no output schema to convey it). It doesn't spell out what is lost on overwrite (frontmatter/body replacement), which is the one gap.

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?

Front-loaded with the create/replace action and followed by usage, differentiation, and return behavior in four tight sentences. Every sentence carries information; the hub sentence is slightly dense but not wasteful.

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 9-parameter mutation tool with no output schema, the description covers the path constraint, overwrite semantics, type/hub behavior, and partial return information. Remaining details (order, topics, summary) are handled by high schema coverage, so nothing critical is missing.

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

Parameters4/5

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

Schema coverage is 89%, so the baseline is 3, but the description adds meaning the schema lacks: the 'hub' type's semantics (groups notes whose frontmatter project matches its title) and the overwrite replace behavior. It says less about order, topics, and summary, but those are documented in the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States the specific verb and resource ('Create a note at a path... or replace one with overwrite=true') and scopes it to Notes/ or Captures/. It explicitly distinguishes itself from brain_capture by noting the caller sets the type, so an agent can choose between the two without opening the schemas.

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

Usage Guidelines5/5

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

Gives positive usage ('use it for hubs, guides and runbooks maintained by hand'), names the alternative it supersedes (brain_capture) with the differentiating condition, and states an exclusion ('Generated notes elsewhere in the vault cannot be written'). When/when-not/alternative are all present.

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