Skip to main content
Glama

Search documents

ragdown_recall
Read-only

Search Markdown documents with hybrid semantic and keyword matching to find relevant sections and context before answering questions.

Instructions

Hybrid (semantic + keyword) search over the user's Markdown documents. Returns the most relevant sections with file path, line range, heading breadcrumb and cosine similarity (above ~0.8 is usually on topic) and the day the file last changed. A section of a document an agent wrote says so. Use it before answering anything the documents may cover; follow up with ragdown_read_doc for the surrounding 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": {
      "query": "<query>"
    },
    "name": "ragdown_recall"
  }
}

Input Schema

NameRequiredDescriptionDefault
tagNoOnly search documents with this tag (frontmatter tags or inline #tags); 'project' also matches 'project/alpha'
queryYesWhat to look for, as a question or keywords
top_kNo
formatNotext
max_charsNotext format: characters per hit before it is clipped (0 = never)
written_byNoOnly documents an agent wrote ('agent': frontmatter has created_by) or only the user's own ('user')
path_prefixNoOnly search files under this subfolder, relative to the documents root, e.g. 'projects/'

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv6.10.0
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / max_chars / maximum
      Added value: +9007199254740991
  2. Changed3 schema fields changedv5.16.0
    • changedInput schema / properties / path_prefix / description
      Previous value: -"Only search files under this subfolder, relative to the notes root, e.g. 'projects/'"New value: +"Only search files under this subfolder, relative to the documents root, e.g. 'projects/'"
    • changedInput schema / properties / tag / description
      Previous value: -"Only search notes with this tag (frontmatter tags or inline #tags); 'project' also matches 'project/alpha'"New value: +"Only search documents with this tag (frontmatter tags or inline #tags); 'project' also matches 'project/alpha'"
    • addedInput schema / properties / written_by
      Added value: +{
      +  "description": "Only documents an agent wrote ('agent': frontmatter has created_by) or only the user's own ('user')",
      +  "enum": [
      +    "agent",
      +    "user"
      +  ],
      +  "type": "string"
      +}
  3. Changed2 schema fields changedv5.2.0
    • changedInput schema / properties / path_prefix / description
      Previous value: -"Only search files under this folder, relative to the notes root, e.g. 'projects/'"New value: +"Only search files under this subfolder, relative to the notes root, e.g. 'projects/'"
    • addedInput schema / properties / tag
      Added value: +{
      +  "description": "Only search notes with this tag (frontmatter tags or inline #tags); 'project' also matches 'project/alpha'",
      +  "type": "string"
      +}
  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?

Annotations only declare readOnlyHint and openWorldHint, so the description carries the real burden and does: it discloses the exact return shape (file path, line range, heading breadcrumb, cosine similarity, last-changed day), interprets the similarity score (~0.8 usually on topic), and flags provenance when a section was written by an agent. That is substantive context an agent cannot get from the annotations or schema.

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?

Three sentences, front-loaded with the core identity, with zero filler. The middle sentence is densely packed with several return-value clauses, but each clause is informative rather than redundant.

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 no output schema, the description correctly assumes responsibility for explaining return values and the similarity threshold, which it does. Minor gaps remain around result limits and the trade-off among the seven filters, but an agent has enough to call it correctly.

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 description coverage is 71%, so the baseline is 3; the description adds no per-parameter meaning beyond what the schema already says about query, tag, written_by, path_prefix and max_chars. The undocumented top_k and format are also unaddressed in prose, leaving the schema to do all the work.

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 a specific verb and resource ("Hybrid (semantic + keyword) search over the user's Markdown documents") and marks its own scope, making it clearly distinct from ragdown_list and ragdown_read_doc siblings it names. An agent can identify what this does without opening the schema.

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 an explicit usage trigger ("Use it before answering anything the documents may cover") and an explicit follow-up route (ragdown_read_doc for surrounding text). It does not state when NOT to use it, e.g. when an exact path is already known and read_doc should be used directly, so it falls short of full alternative routing.

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