Skip to main content
Glama
Sign In

Ankra Docs

by ai.ankra
OverviewDiscussionsAdmin

Query documentation filesystem

query_docs_filesystem_ankra
Read-onlyIdempotent

Run a read-only shell-like query against a virtualized, in-memory filesystem rooted at / that contains ONLY the Ankra 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/https://platform.ankra.app/openapi.json' | jq '.paths | keys' — list OpenAPI endpoints

OpenAPI specs for this site are mounted at: '/openapi/https://platform.ankra.app/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

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 declare readOnly=true, idempotent=true, destructive=false, openWorld=false, and the description reinforces rather than contradicts them ("nothing runs on the user's computer, the server host, or any network", "No writes"). Beyond that it discloses non-obvious traits annotations cannot express: per-call STATELESSNESS with cwd resetting to `/` and no variable persistence, the 30KB output truncation limit, and the required batching strategy.

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 critical constraint that this is a sandbox, then bolded section headers (Workflow, paths warning), then examples — a structure an agent can scan. It is long, and a few lines are slightly redundant ("there is no separate 'get page' tool" overlaps with the workflow paragraph, and two of the seven examples repeat the same `head -80` shape), but nearly every sentence carries operational value for a free-form shell tool.

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, yet the description covers return behavior (30KB truncation, what matches look like with `-C` context) and the downstream requirement to convert `.mdx` filesystem paths back to URL paths for citations. It also pins the OpenAPI mount path verbatim, which is the one piece of environment state an agent could not discover cheaply.

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 there is a single `command` param, so the schema baseline is already 3; the description substantially exceeds it by enumerating the supported command set (rg, grep, find, tree, ls, cat, head, tail, stat, wc, sort, uniq, cut, sed, awk, jq), the exclusions (no writes, no network, no process control), the `--help` escape hatch, and seven concrete invocation examples with real flag combinations.

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 ("Run a read-only shell-like query against a virtualized, in-memory filesystem") and immediately bounds scope: the filesystem contains ONLY Ankra documentation pages and OpenAPI specs. It also distinguishes itself from the sibling search tool by naming the exact conditions (keyword/regex, structural exploration, reading a page by path) where it wins.

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 is given in both directions: use search_ankra for "broad or conceptual queries like 'how to authenticate'" and this tool for exact matching or full-page reads. The "never guess paths" instruction with a concrete fallback (`rg -il "keyword" /`) and a worked example of the wrong-path-picked failure mode is exactly the when/when-not guidance an agent needs.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Ankra Docs toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources