Skip to main content
Glama

Search the docs

search_docs

Keyword/semantic search over docs.nyuchi.com. Returns matching pages with titles, URLs and snippets.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYesWhat to search for
top_kNoMax results (default 5, max 10)

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It discloses that the search is both keyword and semantic, and the return format includes titles, URLs, and snippets. However, it does not mention ordering, authentication needs, rate limits, or any side effects. Basic transparency is provided.

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 extremely concise—two sentences with no wasted words. It front-loads the core functionality and output format, making it easy to scan.

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?

Given the tool's simplicity (2 parameters, no output schema, no nested objects), the description covers the essential behavior: the search domain and the items returned. It is complete enough for an agent to understand what the tool does and what it returns.

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 coverage is 100%, so the baseline is 3. The description does not add any additional meaning to the parameters beyond what the schema already provides (e.g., 'What to search for' for query, max results for top_k). The description focuses on output rather than parameter details.

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 ('Keyword/semantic search'), the resource ('docs.nyuchi.com'), and the output ('matching pages with titles, URLs and snippets'). It effectively distinguishes from sibling tools like 'read_page' (which retrieves a specific page) and 'ask_docs' (which is likely Q&A).

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

Usage Guidelines3/5

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

The description does not explicitly state when to use this tool versus alternatives, nor does it provide when-not-to-use guidance or mention any prerequisites. Usage is implied but not clarified.

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.

TDQS

A4/5.0
Disambiguation5/5

Each tool targets a distinct action: Q&A, issue filing, page reading, searching, and feedback submission. There is no overlap in functionality.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern in snake_case (ask_docs, raise_issue, read_page, search_docs, submit_feedback), making them predictable.

Tool Count5/5

5 tools is well-scoped for a documentation server. It covers the primary user interactions without being excessive or insufficient.

Completeness4/5

The set covers core operations (search, read, ask, file issues, give feedback). Minor omission is a browse or list pages tool, but search compensates.