open-docs-mcp

Instructions

Implementation Reference

• src/index.ts:608-629 (handler)

  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
        }
      }
    }
  }

• src/index.ts:519-528 (schema)

  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
      }
    }
  }