Skip to main content
Glama

AGILEX Docs

get_doc

Read one documentation page as Markdown.

    Call this with a ``doc_id`` returned by ``search_docs`` (or a slug such as
    ``ymZimX7JLe``). Manuals are often 20k-60k characters, so this tool
    paginates: if the reply has ``truncated: true`` and a ``next_offset``,
    call again with that ``offset`` to continue. Do not re-request the same
    offset.

    Args:
        doc_id: id from search_docs (also accepts the page slug).
        max_chars: characters per call, default 20000, max 120000.
        offset: start position, default 0.

    Returns JSON: {doc_id,title,space,url,chars,offset,returned,truncated,
    next_offset,updated_at,content}. Always cite ``url``.
    

Input Schema

NameRequiredDescriptionDefault
doc_idYes
offsetNo
max_charsNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

With no annotations supplied, the description carries the full burden and does so well: it discloses page sizes (20k-60k chars), the pagination contract (truncated/next_offset/offset), and the complete response field list including url for citation. The main failure mode an agent would hit — looping or truncating content — is pre-empted.

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 purpose, then pagination protocol, then args — good ordering with no filler. The Args block partially restates schema defaults, which is mildly redundant, and the Returns section repeats schema-derivable field names, but both stay short.

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 read tool with an output schema, this covers everything an agent needs: input provenance, paging loop, size limits, and citation instruction. Nothing required to invoke it 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 description coverage is 0%, yet the description documents all three parameters with meaning beyond types: doc_id accepts a search_docs id or a page slug, max_chars carries default 20000 and max 120000, offset is the start position defaulting to 0. That fully compensates for the schema gap.

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?

Opens with a specific verb and resource ('Read one documentation page as Markdown'), which immediately separates it from list_docs/list_spaces (enumeration) and search_docs (discovery). The 'one page' scoping and the doc_id provenance make it unambiguous which sibling produces the input for this tool.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a clear entry condition: call this with a doc_id returned by search_docs, and explains the pagination continuation loop with an explicit anti-pattern ('do not re-request the same offset'). It does not state when NOT to use it (e.g., browse via list_docs instead), so it stops short of full alternative routing.

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.