Skip to main content
Glama

Write a document

ragdown_remember

Save a decision, fix, or how-to as a new Markdown document indexed immediately for later searches, without overwriting files; mark older versions as superseded so searches skip them.

Instructions

Save something worth keeping (a decision, a fix, a how-to) as a new Markdown document in the documents folder, indexed immediately so later searches find it. Never overwrites an existing file. When this document replaces an earlier one, pass that document's path as supersedes so searches stop returning the old version.

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": {
      "title": "<title>",
      "content": "<content>"
    },
    "name": "ragdown_remember"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoFile name under the documents folder, without .md; defaults to <date>-<title-slug>
tagsNo
titleYes
contentYesMarkdown body; the title and date go in frontmatter
session_idNoStable id of the conversation, recorded in the document's frontmatter
supersedesNoPaths of documents this one replaces, as returned by ragdown_recall. They stay on disk and ragdown_read_doc still opens them, but search and hook context skip them. Use it when a fact changed, not when you are merely writing about the same topic.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv6.10.0
    • removedInput schema / additionalProperties
      Removed value: -false
  2. Changed3 schema fields changedv5.16.0
    • changedInput schema / properties / name / description
      Previous value: -"File name under the notes folder, without .md; defaults to <date>-<title-slug>"New value: +"File name under the documents folder, without .md; defaults to <date>-<title-slug>"
    • changedInput schema / properties / session_id / description
      Previous value: -"Stable id of the conversation, recorded in the note's frontmatter"New value: +"Stable id of the conversation, recorded in the document's frontmatter"
    • changedInput schema / properties / supersedes / description
      Previous value: -"Paths of notes this one replaces, as returned by ragdown_recall. They stay on disk and ragdown_read_doc still opens them, but search and hook context skip them. Use it when a fact changed, not when you are merely writing about the same topic."New value: +"Paths of documents this one replaces, as returned by ragdown_recall. They stay on disk and ragdown_read_doc still opens them, but search and hook context skip them. Use it when a fact changed, not when you are merely writing about the same topic."
  3. Changed2 schema fields changedv4.0.0
    • addedInput schema / properties / session_id
      Added value: +{
      +  "description": "Stable id of the conversation, recorded in the note's frontmatter",
      +  "type": "string"
      +}
    • addedInput schema / properties / supersedes
      Added value: +{
      +  "description": "Paths of notes this one replaces, as returned by ragdown_recall. They stay on disk and ragdown_read_doc still opens them, but search and hook context skip them. Use it when a fact changed, not when you are merely writing about the same topic.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
  4. First observedv1.0.0

TDQS

A4.3/5.0
Behavior5/5

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

Goes well beyond the annotations (readOnly=false, destructive=false, openWorld=false) by disclosing the indexing side effect, the never-overwrite guarantee, and the full lifecycle of superseded documents — they stay on disk, remain readable via ragdown_read_doc, but are skipped by search and hook context. That is exactly the mutation-reversibility and downstream-effect context the annotations cannot carry.

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 sentences, front-loaded with the core action and effect, then the overwrite guarantee, then the supersedes rule. No filler and no repetition of what the schema already says.

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 6-parameter write tool with no output schema, it covers the essential behavior: indexing, non-overwrite, and supersede semantics. It does not mention what is returned (e.g. the new document's path, which the agent would need to later supersede it) or how tags/name defaults factor into searchability.

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 67%, and the description adds real meaning for the trickiest parameter, supersedes, clarifying that paths come from ragdown_recall and that old documents remain on disk but drop out of search. The remaining parameters (name, tags, session_id, title, content) are left to the schema, which is acceptable given their descriptions.

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 — save a new Markdown document in the documents folder — plus its downstream effect (indexed immediately so searches find it) and the guarantee that it never overwrites. It contrasts implicitly with overwriting/writing tools but never names a sibling such as ragdown_write or ragdown_edit, so differentiation is left to inference.

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

Usage Guidelines4/5

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

Gives concrete when-to-use examples ('a decision, a fix, a how-to') and a clear when/when-not rule for supersedes: 'Use it when a fact changed, not when you are merely writing about the same topic.' No explicit routing between this and sibling write/edit tools, which is the remaining gap.

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