Skip to main content
Glama
MCP Connect Starter

MCP Connect Starter

by cdtalley

search_docs

Query the bundled markdown knowledge base to retrieve best-matching documents for a search term.

Instructions

Search the bundled markdown knowledge base and return the best-matching documents.

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

Input Schema

NameRequiredDescriptionDefault
limitNo
queryYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It does add real behavioral context — "bundled" signals a fixed local corpus rather than an external/remote index, and "best-matching" signals relevance ranking — but it says nothing about matching semantics (keyword vs. full-text), whether results are truncated, or how ties are ordered.

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?

A single well-formed sentence with the resource and the return behavior front-loaded; nothing is wasted. Its brevity is efficient, though it borders on under-specification rather than tight writing.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool is simple (two parameters) and an output schema exists, so return values need not be described. Still, for a search tool the omitted query semantics and lack of differentiation from read_doc leave meaningful gaps an agent must resolve by trial.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% for both parameters, so the description must compensate and does not. It never explains what "query" accepts (natural language, keywords, phrases) or what "limit" governs in relation to the ranking of "best-matching" results.

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 ("Search") and resource ("bundled markdown knowledge base") plus what comes back ("best-matching documents"). However, it does not distinguish itself from the sibling read_doc, which plausibly retrieves a specific document rather than searching — the agent must guess which to use.

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?

There is no explicit when-to-use or when-not-to-use guidance and no mention of an alternative tool. The phrase "best-matching" hints at discovery-style retrieval, but the choice between search_docs and read_doc is left entirely to inference.

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