Skip to main content
Glama

query_docs_filesystem_political_comms

Read-onlyIdempotent

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

A4.8/5.0
Behavior5/5

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

The description goes beyond the readOnlyHint annotation by detailing the sandbox nature (no real machine, no network), statelessness (working directory resets, no variables/aliases/history), output truncation to 30KB, and the need to chain commands. It also explains how to convert paths to URLs, providing rich behavioral context that annotations alone do not convey.

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 detailed and well-structured with clear sections (workflow, supported commands, statelessness, examples, output limits). While it is long, every section adds value and the examples are practical. It is appropriately front-loaded with the core purpose and usage.

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 (multiple commands, statelessness, output limits) and the single parameter, the description is comprehensive. It covers all necessary aspects: what the tool does, how to use it, limitations, and output handling. The lack of an output schema is compensated by the detailed description of output truncation and command behavior.

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?

The schema already describes the 'command' parameter with examples, and the description adds extensive context on how to use it, including supported commands, chaining with '&&', and absolute paths. Since schema coverage is 100% and the description enriches the parameter's usage, a score of 4 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 the tool runs read-only shell-like queries against a virtualized in-memory filesystem containing only Political Comms documentation. It explicitly distinguishes itself from a real shell and from sibling tools by noting there is no separate 'get page' tool, making its purpose unambiguous.

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 search for broad queries, use this tool for exact keyword/regex matching, structural exploration, or reading specific pages. It also contrasts with the sibling search_political_comms tool by specifying when to use this tool versus alternatives, and includes examples of command usage.

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 has a clear, distinct purpose: query_docs_filesystem for reading full pages, search_political_comms for finding relevant snippets, and submit_feedback for reporting issues. No overlap in functionality.

Naming Consistency2/5

Tool names are inconsistent: one is very long with nested underscores (query_docs_filesystem_political_comms), another is shorter (search_political_comms), and submit_feedback follows a different pattern. No consistent verb_noun structure across all names.

Tool Count4/5

Three tools cover the core needs of documentation access and feedback. While slightly minimal, the set is well-scoped for its purpose and does not feel bloated or incomplete.

Completeness4/5

The server provides search and full-page retrieval (via filesystem commands) plus feedback. Users can explore, read, and report issues. Minor gap: no dedicated 'list pages' tool, but tree/ls in query covers it. Suitable for the domain.

Resources