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 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

  • head -100 /openapi/openapi.yaml — read the start of an OpenAPI spec

OpenAPI specs for this site are mounted at: /openapi/openapi.yaml. 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.9/5.0
Behavior5/5

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

Even though annotations already declare readOnly/idempotent/non-destructive, the description adds substantial behavioral detail: statelessness across calls, reset working directory, no writes/network/process control, output truncation at 30KB, and the sandboxed-vs-real-machine distinction. This goes well beyond what annotations provide.

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-structured and relevant. It front-loads the core concept and safety boundary, then moves through command usage, stateless behavior, examples, and output limitations. A few points are lightly redundant (e.g., repeated advice about targeted rg/head vs cat), but the length is justified by the tool's complexity.

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 single-parameter tool with no output schema, the description is remarkably complete. It covers purpose, safety, usage workflow, supported commands, path resolution, statelessness, output truncation, examples, and how to map filesystem paths back to URLs. Nothing essential for correct invocation is missing.

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 already describes the command parameter, but the description greatly expands on how to use it: supported commands, `--help`, chaining with `&&`, absolute paths, path-to-URL conversion, and multiple examples. This is far more actionable than the schema alone.

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 precise verb and resource: 'Run a read-only shell-like query against a virtualized, in-memory filesystem' containing TheRundown docs. It explicitly states this is not a real machine and explains that this tool is the way to read documentation pages, which distinguishes it from the search sibling.

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 routing guidance: use the search tool for broad/conceptual queries and this tool for exact keyword/regex matching, structural exploration, or full page reads. It also tells the agent to discover paths first rather than guessing, and explains how to read pages via head/cat.

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.