Skip to main content
Glama

docs_search

Search body-level chunks across Avalanche documentation, academy courses, integrations, and blog posts. Returns source citations and matching excerpts.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum number of chunk results (default: 10)
queryYesThe search query
sourceNoFilter by documentation source (optional)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of results (default: 10)"New value: +"Maximum number of chunk results (default: 10)"
  2. Added

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 must carry the behavioral burden. It discloses that the tool returns source citations and matching excerpts, which is helpful. However, it does not explicitly state read-only behavior, pagination, or any other potential side effects, though none are expected for a search tool.

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 two sentences, front-loaded with the primary action and followed by the output. Every word contributes, making it concise and well-structured.

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?

The description covers the core functionality and return type, which is sufficient for a search tool without an output schema. However, given the large sibling list and the presence of a similar tool (avalanche_docs_search), a note on differentiation or typical use cases would improve completeness.

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 has 100% coverage for all three parameters (query, limit, source), including clear descriptions. The tool description adds minimal value beyond the schema, only mentioning the sources in a general way. The baseline of 3 is appropriate since the schema does the heavy lifting.

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 clearly states the tool's function: searching body-level chunks across specific documentation sources and returning citations and excerpts. However, it does not explicitly differentiate from the sibling tool 'avalanche_docs_search', which appears to have a similar purpose.

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?

No guidance is provided on when to use this tool versus alternatives like docs_fetch or avalanche_docs_search. The description implies usage for searching but does not state exclusions or preferred scenarios, leaving the agent without clear selection criteria.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.