list_all_docs
Retrieve a comprehensive list of all documents, including disabled entries, with optional detailed information for enhanced document management on the open-docs-mcp server.
Instructions
List all available docs including disabled ones
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| verbose | No | Whether to show detailed information |
Implementation Reference
- src/index.ts:608-629 (handler)The handler function for the 'list_all_docs' tool. It lists all available docs, indicating their enabled/disabled status and crawl status, with optional verbose output.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:516-529 (registration)The registration of the 'list_all_docs' tool in the ListToolsRequestSchema handler, including its description and input schema.{ 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)The input schema for the 'list_all_docs' tool, defining an optional 'verbose' boolean parameter.inputSchema: { type: "object", properties: { verbose: { type: "boolean", description: "Whether to show detailed information", default: false } } }