Skip to main content
Glama

query_docs_filesystem_mintlify

Read-onlyIdempotent

Run a read-only shell-like query against a virtualized, in-memory filesystem rooted at / that contains ONLY the Mintlify 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 to head or cat — a page at the URL path /some/page lives at /some/page.mdx. To search the docs with exact keyword or regex matches, use rg. To understand the docs structure, use tree or ls.

Paths are specific to this site — never guess them. Discover real paths with tree / -L 2, ls /, or the search tool before reading. If a path does not exist, that only means the guess was wrong; it does NOT mean the topic is undocumented — use rg -il "keyword" / to find where it is covered.

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 /some-directory && ls or ls /some-directory). Do NOT assume that cd in one call affects the next call.

Examples (replace the placeholder paths with real ones from tree or search):

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

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

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

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

  • head -80 /page-one.mdx /page-two.mdx /section/page-three.mdx — read multiple pages in one call

  • cat /some/page.mdx — read a full page when you need everything

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

OpenAPI specs for this site are mounted at: /openapi/zh/openapi.json, /openapi/fr/openapi.json, /openapi/es/openapi.json, /openapi/openapi.json, /openapi/zh/discovery-openapi.json, /openapi/fr/discovery-openapi.json, /openapi/es/discovery-openapi.json, /openapi/discovery-openapi.json, /openapi/zh/static-export-openapi.json, /openapi/fr/static-export-openapi.json, /openapi/es/static-export-openapi.json, /openapi/static-export-openapi.json, /openapi/zh/analytics.openapi.json, /openapi/fr/analytics.openapi.json, /openapi/es/analytics.openapi.json, /openapi/analytics.openapi.json, /openapi/zh/admin-openapi.json, /openapi/fr/admin-openapi.json, /openapi/es/admin-openapi.json, /openapi/admin-openapi.json. Use them to answer questions about endpoints, request/response schemas, parameters, and authentication.

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, /some/page.mdx becomes /some/page.

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`).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, closed-world, non-destructive), and the description adds substantial context beyond them: per-call statelessness with cwd resetting to `/`, no shell variables/aliases/history, 30KB output truncation, the supported command whitelist, and the absence of writes/network/process control. The statelessness caveat is behavior an agent would otherwise get wrong on the second call.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the purpose and the critical 'not a real shell' disclaimer, and organized under bold headers with concrete examples. The one inefficiency is the ~20-item enumeration of OpenAPI spec paths, which is discoverable via a single `ls /openapi` and bloats the description; otherwise every paragraph earns its place.

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 no output schema, the description carries the return-side burden and does so: it documents the 30KB truncation limit, recommends targeted `rg -C`/`head -N` over broad `cat`, and instructs converting `.mdx` paths back to URL paths for user-facing citations. Nothing an agent needs to call this correctly or interpret its output is missing.

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% and there is only one parameter, so the baseline is 3, but the description materially deepens it: it explains what the command string should be composed of, supplies worked examples, and — critically — notes that statelessness forces chaining with `&&` or absolute paths rather than relying on `cd`. That is real semantic guidance the schema's one-line description does not carry.

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+resource with explicit scope: a read-only shell-like query against a virtualized in-memory filesystem containing ONLY Mintlify docs and OpenAPI specs. It actively distinguishes itself from the sibling search_mintlify by declaring 'there is no separate get page tool' and positioning itself as the read/exact-match path.

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?

Explicit routing 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.' It also warns against guessing paths and gives the recovery action (`rg -il`) when a path fails, so both when-to-use and when-not are covered.

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