Skip to main content
Glama

knotlog_search

Search Knotlog vault notes using lexical and BM25 ranking, returning matching Markdown notes with short snippets.

Instructions

Search the Knotlog vault notes (folded lexical plus BM25 ranking); returns matching notes with short snippets.

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": "knotlog_search"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of results
queryYesSearch terms

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It helpfully discloses the ranking approach and that results include short snippets, but it omits default limit behavior, pagination, permission/auth requirements, empty-result behavior, and whether the operation is strictly read-only.

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?

The description is a single front-loaded sentence with no wasted wording. It presents the core action, ranking behavior, and return format efficiently.

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 simple two-parameter search tool with a fully described schema and no output schema, the definition is mostly complete. It explains what is searched, how results are ranked, and that snippets are returned, though it could still mention the limit parameter's default or pagination behavior.

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 100%, so both the query and limit parameters are already documented in the input schema. The description adds no additional meaning about syntax, matching behavior, or limit defaults beyond what the schema provides.

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 states a specific verb and resource: search Knotlog vault notes. It also adds useful distinguishing detail about BM25-style ranking and snippet returns, though it does not explicitly contrast itself with the sibling note/context tools.

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

Usage Guidelines2/5

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

It implies search usage but gives no explicit when-to-use guidance, no when-not-to-use guidance, and no named alternative tools. An agent must infer that knotlog_search is for discovery while knotlog_note or knotlog_context may serve other retrieval needs.

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

Deploy Server

Other Tools