Skip to main content
Glama

Search documentation

search_n_top
Read-onlyIdempotent

Search across the nTop knowledge base to find relevant information, code examples, API references, and guides. Use this tool when you need to answer questions about nTop, find specific documentation, understand how features work, or locate implementation details. The search returns contextual content with titles and direct links to the documentation pages. If you need the full content of a specific page, use the query_docs_filesystem tool to head or cat the page path (append .mdx to the path returned from search — e.g. head -200 /api-reference/create-customer.mdx).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYesSearch query

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already indicate readOnlyHint, idempotentHint, and destructiveHint false, so safety is clear. The description adds meaningful behavioral context: it explains the search returns 'contextual content with titles and direct links' and explains how to retrieve full pages via append `.mdx`. No contradictions.

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 three well-organized sentences: purpose, when to use, and alternative for deeper access. Each sentence earns its place and includes a concrete example, with no fluff or repetition.

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 a single parameter, no output schema, and rich annotations, the description is complete enough. It explains what the tool returns (titles and direct links), when to use it, and how to access full content through a sibling tool. No gaps remain.

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% with the only parameter `query` already described as 'Search query'. The description does not add additional parameter semantics beyond implying the query is used to search the knowledge base, so baseline 3 is appropriate.

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 a specific action: 'Search across the nTop knowledge base' to find relevant information, code examples, API references, and guides. It distinguishes itself from sibling tools like query_docs_filesystem_n_top by explicitly pointing to that tool for full page content.

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?

It provides explicit when-to-use guidance: 'Use this tool when you need to answer questions about nTop, find specific documentation, understand how features work, or locate implementation details.' It also gives an alternative for full content: 'use the query_docs_filesystem tool to head or cat the page path'.

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.4/5.0
Disambiguation5/5

Each tool serves a clearly distinct purpose: query_docs_filesystem_n_top is for exact filesystem-style searching and reading specific pages, search_n_top is for semantic/knowledge-base search across all docs, and submit_feedback is for reporting doc issues. There is no overlap or ambiguity between them.

Naming Consistency2/5

Two tools share the 'n_top' suffix but the prefixes are inconsistent ('query_docs_filesystem' vs 'search'), and the third tool 'submit_feedback' breaks the pattern entirely. The naming feels ad-hoc rather than following a predictable convention.

Tool Count4/5

With only 3 tools, the surface is minimal but each tool is substantive: the filesystem tool covers reading, listing, and exact searching; the semantic search covers broad discovery; and feedback closes the loop. It's on the lower end but still a reasonable scope for a documentation server.

Completeness5/5

The tools cover all core doc access needs: semantic search, exact filesystem queries for reading and exploring pages, and a feedback mechanism. There are no obvious gaps for a read-only documentation service.

Resources