Skip to main content
Glama

search_reference

Find documentation references by searching cached content when you don't know the exact topic.

Instructions

Full-text search over cached references when the exact topic is unknown.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
techNo
queryYes
Behavior3/5

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

No annotations are provided, so the description must cover behavioral traits. It indicates a read-only search operation across cached data, which is helpful but lacks details on caching semantics, response format, 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, direct sentence with no extraneous information. It is appropriately sized and front-loaded.

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

Completeness2/5

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

With two parameters (one optional and undocumented) and no output schema, the description falls short. It does not explain the 'tech' parameter or what the search returns, leaving gaps for effective usage.

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

Parameters1/5

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

Schema description coverage is 0%, and the description does not elaborate on the 'query' or 'tech' parameters. The optional 'tech' parameter is left unexplained, failing to compensate for the lack of schema documentation.

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 action ('full-text search'), the resource ('cached references'), and a specific use case ('when the exact topic is unknown'). It effectively distinguishes from siblings like get_reference, which is likely for known references.

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 phrase 'when the exact topic is unknown' provides implicit guidance on when to use this tool versus related tools like get_reference. However, it does not explicitly name alternatives or contraindications.

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/jcsoftdev/web-research-mcp'

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