Skip to main content
Glama

list_docs

List all user-configured documents. Know what documents are available for search and reference.

Instructions

所持しているドキュメントの一覧を取得

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The tool handler for 'list_docs' - an async function decorated with @mcp.tool() that returns a list of owned documents by delegating to doc_manager.list_documents()
    async def list_docs() -> str:
        """所持しているドキュメントの一覧を取得"""
        return doc_manager.list_documents()
  • Tool registration via the @mcp.tool() decorator on the list_docs async function, which registers it as an MCP tool named 'list_docs'
    @mcp.tool()
  • The DocumentManager.list_documents() method that executes the actual logic - iterates over sorted doc keys, appends metadata descriptions if available, and returns newline-joined result
    def list_documents(self) -> str:
        """ドキュメント一覧を返す"""
        result = []
        for path in sorted(self.docs_content.keys()):
            description = self.docs_metadata.get(path, "")
            if description:
                result.append(f"{path} - {description}")
            else:
                result.append(path)
        return "\n".join(result)
  • The docstring for list_docs serves as its schema/description - '所持しているドキュメントの一覧を取得' (Gets the list of owned documents). No parameters or complex schema needed as it takes no arguments and returns a string
    """所持しているドキュメントの一覧を取得"""
Behavior2/5

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

No annotations exist; the description only says 'get a list,' implying a read operation, but lacks details like limits, ordering, or whether it returns all documents.

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?

A single concise sentence that immediately conveys the tool's purpose with no unnecessary words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

While adequate for a simple list tool with no parameters and no output schema, it lacks contextual details like scope or constraints, making it minimally complete.

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?

Input schema has 0 parameters (100% coverage trivially), and the description adds sufficient meaning by describing the action. No extra parameter info needed.

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?

The description clearly states the action (get a list) and resource (documents), and distinguishes from siblings like get_doc (single) and grep_docs/semantic_search (search).

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool vs alternatives, such as grep_docs or semantic_search, leaving the agent to infer from names.

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/herring101/docs-mcp'

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