Skip to main content
Glama

list_docs

List all documentation files by category (product, architecture, operations, api, guides, reference) to discover or overview documentation in Project MCP.

Instructions

List all available documentation files organized by category. Use this to discover what documentation is available or to get an overview of the documentation structure.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
categoryNoOptional: Filter by category. Options: product, architecture, operations, api, guides, reference, or leave empty for all.
Behavior3/5

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

No annotations, so description provides basic behavior: list operation with category organization. Lacks details on output format, but acceptable for a simple list tool.

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 concise sentences with no waste, front-loaded with action.

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?

Fully sufficient for a simple list tool with one optional parameter and no output schema; covers discovery and overview use cases.

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 has high coverage (100%) with enum, description adds minimal context ('organized by category') beyond schema.

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?

Clearly states it lists documentation files by category, distinct from sibling tools like get_doc (specific retrieval) and search_docs (search).

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?

Explicitly says to use for discovering documentation or getting an overview; implicitly suggests alternatives like get_doc for specific files, but doesn't name them.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/pouyanafisi/project-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server