Skip to main content
Glama

BlockVectra Docs

List Documentation Pages

list_docs
Read-only

List all available documentation pages, relative paths, and titles from the static documentation index. No API key required.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
langNoDocumentation language: 'en' for English or 'zh' for Chinese. Defaults to 'en'.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
docsYes
langYes
countYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover safety (readOnlyHint=true, openWorldHint=false), so the bar is lower, and the description adds useful context: the data comes from a 'static documentation index' and requires no API key. It does not describe pagination or size limits, but for a static index that is minor.

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 tight sentences, zero waste, with the scope and returned fields front-loaded before the prerequisite note.

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 zero-required-param read tool with an output schema, annotations, and full param coverage, the description is nearly sufficient; it names the returned fields so the output schema need not be inspected. Routing to read_doc/search_docs for actual content would make it complete.

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% and the single 'lang' parameter is fully documented with its enum and default in the schema, so the description adds nothing beyond it. Baseline 3 applies when the schema does the heavy lifting.

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+resource ('List all available documentation pages') plus the returned fields ('relative paths, and titles'), so an agent knows exactly what it yields. It does not explicitly differentiate itself from close siblings like read_doc or search_docs.

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?

'No API key required' gives prerequisite context, and 'list all' implies a browse/enumerate use case. However, there is no explicit when-to-use vs alternatives guidance (e.g., 'use read_doc to fetch a page's content, search_docs to find by keyword').

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.

Resources