Skip to main content
Glama

search_markdown

Search markdown documents and return relevant snippets. Choose keyword, semantic, or hybrid search to match queries against local knowledge bases without returning entire files.

Instructions

Search for markdown content and return SNIPPETS (not full files).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYesSearch term or natural language question
strategyNo"keyword" (default, fast), "semantic" (embedding-based), or "hybrid" (best quality, combines both)keyword
max_resultsNoMaximum number of snippets to return (default: 5)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

No annotations are provided, so the description carries the full burden for behavioral disclosure. It adds one key behavioral trait: results are snippets, not full files. However, it does not state whether the operation is read-only, discuss performance implications (e.g., strategy default), or mention any potential side effects or limitations.

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, focused sentence that immediately conveys the essential purpose and key limitation. It wastes no words and front-loads the primary action.

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 tool's moderate complexity, an output schema exists, and all parameters are documented in the schema, the description provides sufficient context for usage. It clearly communicates the core distinction from siblings. Minor gaps remain around when to prefer this over alternatives and metadata about the search results, but these are adequately handled by the schema and tool name.

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?

The input schema provides 100% coverage of all three parameters (query, strategy, max_results) with descriptive text. The description adds minimal additional meaning beyond reinforcing the snippet output, which relates to max_results but doesn't explain parameter syntax or interpretation.

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 clearly states the verb 'search' and resource 'markdown content', and explicitly notes it returns snippets rather than full files. This distinguishes it from sibling tools like read_file, which reads full files, and list_files, which lists files.

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?

The description provides clear context on what the tool does, and the parenthetical '(not full files)' implicitly guides users away from using it when they need complete file contents. However, it does not explicitly name alternative tools or provide when-to-use/when-not-to-use guidance.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ly2xxx/md-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server