Skip to main content
Glama

query_docs_filesystem_n_top

Read-onlyIdempotent

Run a read-only shell-like query against a virtualized, in-memory filesystem rooted at / that contains ONLY the nTop documentation pages and OpenAPI specs. This is NOT a shell on any real machine — nothing runs on the user's computer, the server host, or any network. The filesystem is a sandbox backed by documentation chunks.

This is how you read documentation pages: there is no separate "get page" tool. To read a page, pass its .mdx path (e.g. /quickstart.mdx, /api-reference/create-customer.mdx) to head or cat. To search the docs with exact keyword or regex matches, use rg. To understand the docs structure, use tree or ls.

Workflow: Start with the search tool for broad or conceptual queries like "how to authenticate" or "rate limiting". Use this tool when you need exact keyword/regex matching, structural exploration, or to read the full content of a specific page by path.

Supported commands: rg (ripgrep), grep, find, tree, ls, cat, head, tail, stat, wc, sort, uniq, cut, sed, awk, jq, plus basic text utilities. No writes, no network, no process control. Run --help on any command for usage.

Each call is STATELESS: the working directory always resets to / and no shell variables, aliases, or history carry over between calls. If you need to operate in a subdirectory, chain commands in one call with && or pass absolute paths (e.g., cd /api-reference && ls or ls /api-reference). Do NOT assume that cd in one call affects the next call.

Examples:

  • tree / -L 2 — see the top-level directory layout

  • rg -il "rate limit" / — find all files mentioning "rate limit"

  • rg -C 3 "apiKey" /api-reference/ — show matches with 3 lines of context around each hit

  • head -80 /quickstart.mdx — read the top 80 lines of a specific page

  • head -80 /quickstart.mdx /installation.mdx /guides/first-deploy.mdx — read multiple pages in one call

  • cat /api-reference/create-customer.mdx — read a full page when you need everything

  • cat /openapi/spec.json | jq '.paths | keys' — list OpenAPI endpoints

Output is truncated to 30KB per call. Prefer targeted rg -C or head -N over broad cat on large files. To read only the relevant sections of a large file, use rg -C 3 "pattern" /path/file.mdx. Batch multiple file reads into a single head or cat call whenever possible.

When referencing pages in your response to the user, convert filesystem paths to URL paths by removing the .mdx extension. For example, /quickstart.mdx becomes /quickstart and /api-reference/overview.mdx becomes /api-reference/overview.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
commandYesA shell command to run against the virtualized documentation filesystem (e.g., `rg -il "keyword" /`, `tree / -L 2`, `head -80 /path/file.mdx`).

TDQS

A5/5.0
Behavior5/5

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

Beyond the annotations, the description discloses statelessness, working directory reset, output truncation to 30KB, no writes/network/process control, and the sandbox nature of the filesystem. It also explains path-to-URL conversion. No contradiction with annotations.

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 long but well-structured with clear sections: sandbox warning, workflow, supported commands, statelessness, examples, output limits, and URL conversion. Each section adds operational value, and the most critical caveat (not a real shell) 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?

For a one-parameter shell-query tool with no output schema, the description covers command semantics, usage patterns, limitations, output handling, and page reference conventions. It is sufficiently complete for an agent to invoke the tool correctly without additional context.

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

Parameters5/5

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

The schema only defines `command` as a string, but the description enriches it with supported commands, chaining via `&&`, absolute paths, multiple file reads, and concrete examples. This goes far beyond the schema's minimal parameter 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?

The description opens with a specific verb and resource: 'Run a read-only shell-like query against a virtualized, in-memory filesystem rooted at `/`.' It clearly states this is the way to read documentation pages and distinguishes itself from the sibling search tool by emphasizing exact keyword/regex matching, structural exploration, and full-page reads.

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?

The description provides explicit workflow guidance: 'Start with the search tool for broad or conceptual queries... Use this tool when you need exact keyword/regex matching, structural exploration, or to read the full content of a specific page by path.' This names the alternative and defines when to use this tool.

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