Skip to main content
Glama

search_knowledge_file

Read-only

Find exact text matches within a specific knowledge base file to quickly locate relevant passages without invoking a model.

Instructions

Find literal text matches inside one knowledge base file; no DeepTutor model call

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum matches; max 10
queryYesLiteral phrase to find
kb_nameYesKnowledge base name
filenameYesFile path from list_knowledge_files

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes原始 DeepTutor 工具返回值;其具体字段由对应 DeepTutor API 决定。

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.8/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds one meaningful behavioral trait—that no DeepTutor model call is made—but does not disclose limit defaults, case sensitivity, or error behavior when no matches exist.

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?

A single, front-loaded sentence states the core behavior and the critical non-behavior ('no DeepTutor model call'). Every word earns its place, and the description is neither padded nor underspecified.

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?

Given the 100% schema parameter coverage, readOnly annotations, and an existing output schema, the description provides the one crucial contextual distinction—literal search without model invocation. Minor missing details like result limits or search semantics are already handled by the schema and output schema, so nothing essential is absent.

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 each parameter is already documented in the schema. The description reinforces that 'query' is a literal phrase, matching the schema's 'Literal phrase to find', but contributes little meaning beyond what the schema already states. Baseline 3 is appropriate.

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?

The description names a specific verb ('find'), a specific resource ('one knowledge base file'), and the exact behavior ('literal text matches'). It also explicitly distinguishes itself from a model-based search via 'no DeepTutor model call', which differentiates it from search_vector_knowledge without needing to inspect that sibling.

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

Usage Guidelines3/5

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

The description implies the tool is for exact literal search within a single file, and the phrase 'no DeepTutor model call' hints that it is the cheaper/non-semantic alternative. However, it does not explicitly state when to choose this over read_knowledge_file or search_vector_knowledge, leaving usage conditions to inference.

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