Skip to main content
Glama

list_doc_sections

Retrieve the main sections of deepset AI Platform documentation to identify available topics, navigate users, and obtain section IDs for filtered searches.

Instructions

List the main sections of the deepset AI Platform documentation.

Use this to understand what documentation is available and help users navigate to the right section. Pass a section id to search_docs as section to limit search results to that part of the docs.

:returns: A list of documentation sections with descriptions and URLs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.27

TDQS

A4.7/5.0
Behavior4/5

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

No annotations are provided, so the description carries the burden; it discloses that this is a read-only enumeration returning sections with descriptions and URLs via the ':returns:' note. It does not mention pagination or rate limits, but for a zero-argument list tool the behavioral profile is essentially complete.

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 short sentences: the purpose is front-loaded, followed by usage guidance and the return contract, with no filler. Every sentence 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 trivial no-arg read tool with no output schema, the description covers purpose, when to use it, the sibling relationship, and the shape of the return value. Nothing an agent needs 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.

Parameters4/5

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

The tool takes zero parameters, so per the rubric the baseline is 4. The description doesn't need to explain parameter syntax, though it usefully notes that a returned section id is consumed elsewhere.

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+resource (list documentation sections) with a scope qualifier ('main sections of the deepset AI Platform documentation'). It is clearly distinct from the sibling search_docs, which it references as a complementary query tool.

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 when to use it ('to understand what documentation is available and help users navigate') and how it feeds into the alternative: passing a section id to search_docs as the section parameter. Both the use case and the hand-off to a sibling are spelled out.

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

Deploy Server

Other Tools