Skip to main content
Glama

Proa documentation

search_docs

Read-onlyIdempotent

Search official Proa Rust framework documentation by a case-insensitive phrase. Use this to find current APIs, render patterns, RSJS guidance, and deployment instructions. Returns titles, routes, Markdown URLs, and a pagination cursor; call get_doc with a returned path for the complete page.

Input Schema

NameRequiredDescriptionDefault
qYesPhrase to find in document titles, descriptions, or Markdown.
limitNoMaximum results per page; defaults to 10.
cursorNonext_cursor from a preceding search with the same q.

Output Schema

NameRequiredDescriptionDefault
totalYes
resultsYes
next_cursorYesOpaque cursor for the next page, or null when the result set is complete.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so safety is covered; the description adds behavioral value by disclosing case-insensitive matching and the pagination handoff via next_cursor. It doesn't state ordering or ranking of results, which is a minor remaining gap.

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, each doing distinct work: what/how, use cases, and return-plus-next-step. Front-loaded with the core action and no filler.

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?

With full schema coverage, an output schema, and read-only annotations, the description only needs to establish scope and the get_doc handoff — both are present. Return fields and cursor mechanics are covered jointly by the output schema and the description's summary.

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 baseline is 3; the description earns above it by adding that matching is case-insensitive and that the cursor is meant to be fed back for pagination, semantics not explicit in the schema. Limit defaults and ranges remain schema-only, which is fine.

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 (search) and resource (official Proa Rust framework documentation) with a matching constraint (case-insensitive phrase). It also distinguishes itself from the sibling get_doc by defining the search-then-fetch workflow, so an agent can pick correctly without opening either schema.

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?

Names concrete content domains where this is the right tool (current APIs, render patterns, RSJS guidance, deployment) and explicitly routes full-page retrieval to get_doc. Missing only explicit when-not criteria, e.g. what to do for non-documentation questions.

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