Skip to main content
Glama

List the docs

list_docs
Read-only

List Druxt documentation pages, optionally for one section.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
sectionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior2/5

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

readOnlyHint=true already tells the agent this is a safe read, so the description needn't re-establish that. Beyond the annotation it adds almost nothing: no mention of ordering, pagination, result size, or what a returned page entry looks like, despite there being no output schema to fall back on.

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?

One short sentence, front-loaded with the verb and resource, with the optional qualifier trailing. There is no filler or redundancy.

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 one-optional-parameter read-only listing tool with annotations covering safety, the definition is close to sufficient. The remaining gap is that, absent an output schema, the description never indicates what a listed page comprises or how many are returned.

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 description coverage is 0%, so the description must carry the parameter meaning. It does clarify that the single `section` argument is optional and acts as a filter, which matches the enum values, but it adds no detail on omitted-section behavior or on what each enum value contains.

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 Druxt documentation pages") plus a scope qualifier (optionally one section). It is distinguishable from get_doc by being plural/list-oriented, but it never explicitly contrasts itself with search_docs, so sibling differentiation is only implicit.

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

Usage Guidelines3/5

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

"Optionally for one section" hints at the filtering use case, implying this is the browse-all entry point, but there is no explicit guidance on when to choose list_docs over search_docs or get_doc. The agent must infer the routing itself.

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.