Skip to main content
Glama

list_all_docs

Retrieve all available documents, including disabled ones, from the open-docs-mcp server for comprehensive document management.

Instructions

List all available docs including disabled ones

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
verboseNoWhether to show detailed information

Implementation Reference

  • The main handler function for the 'list_all_docs' tool, which lists all available docs including disabled ones, showing their status, crawler start URL, and crawl history.
    case "list_all_docs": {
      // Ensure config file exists before reading it
      await ensureConfigFile();
      
      const verbose = Boolean(request.params.arguments?.verbose);
      const config = await fs.readJson(configPath);
      
      const result = docs.map(doc => {
        const isEnabled = docConfig[doc.name];
        const crawledAt = isEnabled ? (config.crawledDocs?.[doc.name] || "Not crawled") : "";
        return verbose
          ? `${doc.name} (${isEnabled ? "Enabled" : "Disabled"})\n  Start URL: ${doc.crawlerStart}\n  Last crawled: ${crawledAt || "N/A"}`
          : `${doc.name} [${isEnabled ? (crawledAt === "Not crawled" ? "Enabled, not cached" : "Enabled, cached") : "Disabled"}]`;
      });
    
      return {
        content: [{
          type: "text",
          text: result.join("\n") || "No docs found"
        }]
      };
    }
  • src/index.ts:517-529 (registration)
    Tool registration in the ListToolsRequestSchema handler, defining the name, description, and input schema for 'list_all_docs'.
      name: "list_all_docs",
      description: "List all available docs including disabled ones",
      inputSchema: {
        type: "object",
        properties: {
          verbose: {
            type: "boolean",
            description: "Whether to show detailed information",
            default: false
          }
        }
      }
    }
  • Input schema definition for the 'list_all_docs' tool, specifying optional 'verbose' boolean parameter.
    inputSchema: {
      type: "object",
      properties: {
        verbose: {
          type: "boolean",
          description: "Whether to show detailed information",
          default: false
        }
      }
    }
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions that the tool lists docs, but doesn't describe critical behaviors like whether this is a read-only operation, potential performance impacts, rate limits, or what the output looks like (e.g., list format, error handling). For a tool with no annotation coverage, this leaves significant gaps in understanding how it behaves.

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?

The description is a single, efficient sentence that directly states the tool's purpose without any unnecessary words. It's front-loaded with the core action and includes a key differentiator (including disabled docs), making it easy to parse quickly.

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?

Given the tool's low complexity (one optional parameter) and high schema coverage, the description is minimally adequate. However, with no annotations and no output schema, it lacks details on behavioral traits and return values, which are important for a listing tool. It meets basic needs but could be more complete by addressing output format or usage constraints.

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?

The input schema has 100% description coverage, with one parameter 'verbose' fully documented in the schema. The description doesn't add any parameter-specific information beyond what the schema provides, such as examples of what 'detailed information' includes. Given the high schema coverage, a baseline score of 3 is appropriate as the description doesn't compensate but doesn't need to.

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?

The description clearly states the verb ('List') and resource ('all available docs'), specifying that it includes disabled ones. This distinguishes it from 'list_enabled_docs' which presumably excludes disabled docs. However, it doesn't specify the format or scope of the listing (e.g., pagination, fields returned), keeping it from a perfect score.

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?

The description implicitly provides usage guidance by stating it includes disabled docs, suggesting it should be used when you need a complete inventory rather than just enabled ones. It doesn't explicitly name alternatives like 'list_enabled_docs' or provide when-not-to-use scenarios, but the context is clear enough for basic differentiation.

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

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