Skip to main content
Glama

List Applivery documentation sections

list_doc_sections
Read-onlyIdempotent

List the top-level documentation sections and landing pages from the site's curated index (llms.txt). Use for orientation, then drill in with search_docs or get_doc_page.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sectionNoOptional filter on section name or title.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
totalYes
sectionsYes

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true. The description adds context that data comes from llms.txt and that only top-level sections are returned, which is useful beyond the annotations but doesn't detail pagination or filtering behavior.

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?

Two sentences, no filler. The first states the action and resource, the second gives workflow guidance. Every word earns its place.

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 simple read-only list tool with one optional parameter and an output schema, the description covers source, scope, and next steps. The output schema handles return details, so no additional burden falls on the description.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% because the only parameter 'section' has a description. The tool description does not mention the optional filter, so it adds no extra parameter semantics beyond the schema, but this is acceptable given full schema coverage.

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 uses a specific verb ('List') and identifies the resource as 'top-level documentation sections and landing pages from the site's curated index (llms.txt).' It clearly distinguishes from siblings by noting this is for orientation and that deeper content requires search_docs or get_doc_page.

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?

Explicitly states 'Use for orientation, then drill in with search_docs or get_doc_page.' This gives clear when-to-use guidance and names alternatives for follow-up tasks, though it doesn't mention get_api_endpoint as an alternative.

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.

TDQS

A4.5/5.0
Disambiguation5/5

Each tool has a distinct purpose: get_api_endpoint for API definitions, get_doc_page for fetching content, list_doc_sections for navigation, and search_docs for discovery. There is no overlap or ambiguity.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern in snake_case: get_api_endpoint, get_doc_page, list_doc_sections, search_docs. No deviations.

Tool Count5/5

Four tools are well-scoped for a documentation server, covering the essential actions without being too few or too many.

Completeness5/5

The set covers the full workflow: search to find, list sections to navigate, get_doc_page to read, and get_api_endpoint for API details. No obvious gaps.