Skip to main content
Glama
Sign In
docs-mcp

docs-mcp

Official
by apideck-libraries
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

List documentation pages

list_docs
Read-onlyIdempotent

Browse documentation structure by listing pages with path, title, description, and last-modified date. Filter by path prefix to find pages before searching.

Instructions

List documentation pages with their path, title, description and last-modified date. Useful to browse the structure before searching or to find pages under a prefix.

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
limitNoMaximum number of pages to list.
path_prefixNoOnly list pages under this path prefix.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.4.1
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and openWorldHint=false, so the safety profile is covered. The description adds value beyond that by disclosing the return shape (path, title, description, last-modified), which matters since no output schema exists. It does not mention truncation at limit=200 or whether listing is paginated.

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, with the returned fields and the use case both front-loaded. Every clause 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 two-optional-parameter read tool with full annotations and full schema coverage, the description covers purpose, return fields and usage context. Nothing an agent needs to call it correctly is missing.

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 100%, so both parameters are already documented in the schema. The description only implies path_prefix behavior via 'pages under a prefix' and says nothing about limit semantics, so the baseline 3 applies.

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 (list) and resource (documentation pages), and names the fields returned (path, title, description, last-modified date). It signals the browse-vs-search distinction implicitly ('before searching') but never names the sibling search_docs, so sibling differentiation is left to inference.

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 clear usage contexts: browsing structure before searching, or finding pages under a prefix. There are no explicit exclusions or named alternatives (search_docs, get_doc), so an agent must infer when to switch tools rather than being told.

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