Skip to main content
Glama

AGILEX Docs

list_docs

List documented pages, optionally inside one space.

    Use when the caller wants an inventory ("what manuals exist for ranger")
    rather than an answer.

    Args:
        space: optional space slug or name fragment.
        limit: 1-300, default 100.
        offset: pagination offset.

    Returns JSON: {count, total_shown, docs:[{doc_id,title,space,url,chars}]}.
    

Input Schema

NameRequiredDescriptionDefault
limitNo
spaceNo
offsetNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden. It usefully discloses pagination via offset, limit range and default, and the return JSON shape, but it does not state permission/access scope, ordering, rate limits, or whether all accessible spaces are searched when 'space' is omitted.

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 short, front-loaded, and well-structured with Args and Returns sections. The return-shape line is somewhat redundant because an output schema already exists, but the parameter documentation is efficient and earns its space.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple three-parameter listing tool with an output schema and no annotations, the description provides the key usage context, all parameter meanings, and pagination behavior. Minor omissions remain around access scope and result ordering, but nothing critical to invoking it correctly is missing.

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?

Schema description coverage is 0%, so the description must compensate, and it documents all three parameters with useful meaning: space accepts a slug or name fragment, limit is constrained to 1-300 with default 100, and offset supports pagination. The offset explanation is minimal, but the definition fills the main 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?

The description gives a specific verb and resource: 'List documented pages, optionally inside one space.' It also distinguishes the inventory-style use case from answer-seeking search with 'rather than an answer,' which separates it from search_docs and get_doc without requiring the sibling schemas to be opened.

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?

The description clearly states when to use it: when the caller wants an inventory of manuals rather than an answer. It implies the alternative search behavior, but it does not explicitly name search_docs or give other exclusions, so it falls short of fully explicit 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.