Skip to main content
Glama

PolyAI Docs

Query documentation filesystem

query_docs_filesystem_poly_ai_platform
Read-onlyIdempotent

Run a read-only shell-like query against a virtualized, in-memory filesystem rooted at / that contains ONLY the PolyAI Platform 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, 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/api-reference/agents/openapi.json | jq '.paths | keys' — list OpenAPI endpoints

OpenAPI specs for this site are mounted under /openapi; run find /openapi -type f to list them. 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.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "command": "<command>"
    },
    "name": "query_docs_filesystem_poly_ai_platform"
  }
}

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

Annotations already cover read-only/idempotent/closed-world, but the description adds far more: the filesystem is a documentation-backed sandbox with nothing executing on real machines, calls are stateless with cwd resetting to /, 30KB output truncation per call, no writes/network/process control, and an enumerated command whitelist. These are operational constraints an agent cannot infer from the annotations.

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 what the tool is, then workflow, then examples — well organized with bold emphasis on the non-obvious constraints. It is long, and the path-guessing warning and statelessness point are each restated in multiple places, but for a 1-param tool with this much implicit behavior the length is largely justified.

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?

No output schema exists, and the description compensates fully: it explains what output looks like (file contents, rg match lines), the 30KB truncation ceiling, how to narrow reads, and how to convert filesystem paths back to URL paths for the user. Nothing an agent needs in order to call this correctly 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?

Schema coverage is 100% and already describes the single command parameter, but the description goes well beyond it: the supported command set, --help availability, command chaining with && versus relying on cd, the .mdx-to-URL path mapping, and seven concrete invocation examples. This is substantive meaning the schema alone does not convey.

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 and resource — a read-only shell-like query against an in-memory filesystem containing only PolyAI docs and OpenAPI specs — and immediately contrasts it with the sibling: 'Start with the search tool for broad or conceptual queries... Use this tool when you need exact keyword/regex matching.' An agent knows exactly what this does versus search_poly_ai_platform.

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 rules: use the search tool for conceptual queries, this tool for exact regex matching, structural exploration, or reading full pages by path. It also prescribes a discovery-first workflow (tree/ls/rg before reading) and warns that a missing path means a bad guess rather than an undocumented topic — a genuinely important failure-mode guard.

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