Skip to main content
Glama

search_documents

Read-onlyIdempotent

Semantic search over this project Wiki pages and uploaded documents. It matches meaning, not keywords, so give it a question rather than a term. Returns between 1 and 10 excerpts (default 5), never whole pages — when an excerpt looks right, follow up with get_document_full_content. Always search before create_wiki_page: the point is to extend the team memory, not to duplicate it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMáximo de resultados
queryYesTermo ou pergunta para buscar nos documentos
project_idYesProject ID this call refers to. Omit it once to get the list of projects you can access.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already mark it read-only, idempotent, and non-destructive. The description adds behavioral context beyond that: it returns 1–10 excerpts, defaults to 5, never returns whole pages, and matches meaning rather than keywords.

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?

Three sentences with no filler: purpose first, then behavioral/return characteristics, then usage rules. Every sentence earns its place and the most decision-relevant guidance is front-loaded.

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

Completeness5/5

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

The description fully covers invocation behavior, result shape, and follow-up routing. It names the sibling to use for full content and the creation tool to avoid, making the tool self-sufficient even without an output schema.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3. The description adds value by explaining the query parameter's intended usage ('give it a question rather than a term'), which goes beyond the schema's generic 'Termo ou pergunta' description.

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?

States a specific verb and resource: semantic search over Wiki pages and uploaded documents. It distinguishes itself from siblings by emphasizing meaning-matching rather than keyword matching, and by noting it returns excerpts rather than full pages.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly instructs the agent to phrase queries as questions rather than keywords, to follow up with get_document_full_content when an excerpt looks right, and to always search before create_wiki_page to avoid duplicating team memory. This gives clear when-to-use and follow-up 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.