Skip to main content
Glama

TheRundown Documentation MCP

query_docs_filesystem_the_rundown_api

Read-onlyIdempotent

Run a read-only shell-like query against a virtualized, in-memory filesystem rooted at / that contains ONLY the TheRundown API 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`).

Schema Changelog

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

  1. First observed

TDQS

A4.9/5.0
Behavior5/5

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

The description adds substantial behavioral context beyond the annotations: it is a sandbox, not a real shell; no writes, no network, no process control; each call is stateless; working directory always resets to /; output is truncated to 30KB; and `cd` does not affect subsequent calls. These details are not present in annotations and meaningfully change how the agent should invoke the tool.

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?

The description is long but well-organized with clear sections (introduction, workflow, supported commands, statelessness, examples, output truncation, URL conversion). It is verbose because the tool is complex, but nearly every section earns its place. It has minor redundancy around preferring `rg -C`/`head` over `cat`, but this is not a major penalty for an otherwise useful, structured definition.

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 complexity and lack of output schema, the description is remarkably complete. It explains the virtual filesystem, all supported commands, statelessness, output truncation, how to batch reads, and even how to map paths back to URLs. An agent has everything needed to use this tool correctly without guessing.

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 single `command` parameter already has 100% schema coverage, but the description greatly enriches its semantics: it lists supported commands (rg, grep, find, tree, ls, cat, head, tail, stat, etc.), provides multiple examples, explains chaining with `&&`, notes absolute-path usage, and warns about statelessness. This goes far beyond the schema's one-line 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 states a very specific verb and resource: 'Run a read-only shell-like query against a virtualized, in-memory filesystem rooted at /' containing only TheRundown API docs. It distinguishes itself from the sibling search_the_rundown_api by saying the search tool is for broad/conceptual queries while this tool is for exact keyword/regex matching, structural exploration, and reading full pages by 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?

It gives explicit when-to-use 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 clarifies that this is the only way to read documentation pages and warns about statelessness and reset behavior.

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