Skip to main content
Glama

AGILEX Docs

list_spaces

List the public documentation spaces with page counts.

    Call this when the caller is unsure which product family a document
    belongs to, or to explain coverage.

    Returns JSON: {count, spaces:[{space,name,docs,chars}]}.
    

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full disclosure burden. It establishes the 'public' scope and that this is a read/enumeration operation with no side effects, but says nothing about authorization requirements, whether the space list is complete or filtered per caller, or ordering/pagination of results.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three compact blocks: purpose first, usage condition second, return payload third. Every sentence carries information and nothing is repeated from the schema.

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 nullary discovery tool with an output schema present, the description supplies the purpose, the selection condition, and an inline sketch of the return shape, which is sufficient to invoke it correctly. It stops short of explaining whether the space list is caller-scoped or what the 'chars' field measures.

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 tool takes zero parameters, so there is nothing for the description to disambiguate; baseline is 4. The description correctly signals that enumeration is unfiltered and that the caller must do any narrowing downstream.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('List the public documentation spaces') plus a qualifier ('with page counts'), which is enough for an agent to distinguish it from the doc-level siblings get_doc, list_docs and search_docs. It never names those siblings explicitly, so the differentiation is implied by resource granularity rather than stated.

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 concrete trigger: use it when the caller is unsure which product family a document belongs to, or to explain coverage. That is a real disambiguation rule against the search/list-docs siblings. It lacks an explicit when-not or a statement that this is the entry point for discovering space identifiers.

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.