Skip to main content
Glama
GetNote MCP Server

GetNote MCP Server

by iswalle

recall_knowledge

Search within a specified knowledge base using semantic recall to retrieve relevant notes, ranked by relevance.

Instructions

知识库语义搜索:在指定知识库范围内进行语义召回。适用场景:「在我的 XX 知识库搜一下 XX」。返回结果按相关度从高到低排序。需要 note.topic.recall.read scope。

Input Schema

NameRequiredDescriptionDefault
queryYes搜索关键词或语义描述(必填)
top_kNo返回数量,默认 3,最大 10
topic_idYes知识库 ID(来自 list_topics 的 topic_id 字段)(必填)
response_modeNo显式摘要模式;不传保持旧正文。需search.snippet.v1,不支持课程内语义筛选
max_snippet_charsNo每个命中的Unicode码点上限,默认400;需response_mode=snippet,full只表示完整片段

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.10.1
    • addedInput schema / properties / max_snippet_chars
      Added value: +{
      +  "description": "每个命中的Unicode码点上限,默认400;需response_mode=snippet,full只表示完整片段",
      +  "maximum": 1000,
      +  "minimum": 100,
      +  "type": "integer"
      +}
    • addedInput schema / properties / response_mode
      Added value: +{
      +  "description": "显式摘要模式;不传保持旧正文。需search.snippet.v1,不支持课程内语义筛选",
      +  "enum": [
      +    "snippet"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / topic_id / description
      Previous value: -"知识库 ID(alias id,来自 list_topics 的 id 字段)(必填)"New value: +"知识库 ID(来自 list_topics 的 topic_id 字段)(必填)"
  2. First observedv1.1.0

TDQS

A4/5.0
Behavior4/5

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

No annotations, so the description carries the burden. It discloses the relevance-descending sort order and the required scope 'note.topic.recall.read', both valuable behavioral facts beyond the schema. It omits pagination/return-shape detail, keeping it below 5.

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?

Four short sentences, front-loaded with the core identification '知识库语义搜索' followed by scenario, return ordering, and auth. Every sentence carries distinct information with zero waste.

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 5-param read tool with no annotations and no output schema, it covers the essentials: scope, trigger, ranking, and required scope. Return value structure is only summarized as relevance-ordered, which is adequate but not exhaustive given the missing output schema.

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 coverage is 100%, so all parameters (query, top_k, topic_id, response_mode, max_snippet_chars) are already documented in the schema. The description adds no parameter-level detail beyond restating the scoping to a topic, so baseline 3 applies.

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+resource: semantic recall within a specified knowledge-base scope. The phrase '在指定知识库范围内' distinguishes it from the sibling `recall`, which lacks that scoping, though the sibling is not named explicitly.

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?

Provides a concrete usage trigger and example ('在我的 XX 知识库搜一下 XX'), giving clear context for when to call it. No explicit exclusions or named alternative tools, so not a full 5.

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