Skip to main content
Glama

Search docs

search_docs
Read-onlyIdempotent

Searches OpenFile's docs and returns the best sections with a link to each. Use it when you're not sure how something works.

Input Schema

NameRequiredDescriptionDefault
qYesWhat to look for, like `registered agent` or `how do I change an application`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds that results are ranked 'best sections' with links, which is useful. It says nothing about result count, ranking basis, or what happens when nothing matches.

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?

Two short sentences with zero waste: the capability and its return are front-loaded, and the usage cue follows immediately. Nothing redundant with the title.

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 one-parameter read tool with full schema coverage and rich annotations, this covers what it does, what comes back, and when to reach for it. Only the empty-result and ranking-depth behavior remain unaddressed, which is minor here.

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% and the single parameter already ships two concrete example queries, so the schema does the heavy lifting. The description adds no query syntax or phrasing guidance beyond what the schema provides.

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 and resource ('Searches OpenFile's docs') and adds the return shape ('best sections with a link to each'), which distinguishes it from the sibling read_doc. It doesn't explicitly name read_doc or search_marks, so sibling differentiation is implied rather than stated.

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?

'Use it when you're not sure how something works' gives a clear triggering condition for an exploratory query. It stops short of the natural pairing – search first, then follow the link with read_doc – and offers no when-not guidance.

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.

Resources