Software Documentation Analysis

🚀 🌐 DocuMind MCP Server

DocuMind MCP Server 是新一代的模型上下文協議（MCP）服務器，藉助高級神經處理技術，徹底革新了文檔質量分析，實現了文檔與數字智能的完美交匯。

🚀 快速開始

系統要求

• Node.js 18+
• npm || yarn

初始化核心

npm install

編譯矩陣

npm run build

神經開發連接

建立即時神經網絡連接：

npm run watch

✨ 主要特性

• 🧠 神經文檔分析：用於全面README評估的高級算法
• 🔮 全息標題掃描：用於SVG元素分析的尖端技術
• 🌍 多維度語言支持：跨語言文檔驗證
• 💫 量子建議引擎：AI驅動的改進建議

📦 安裝指南

系統配置

與Claude Desktop主框架集成：

Windows終端:

// %APPDATA%/Claude/claude_desktop_config.json
{
  "mcpServers": {
    "documind-mcp-server": {
      "command": "/path/to/documind-mcp-server/build/index.js"
    }
  }
}

神經接口命令

evaluate_readme

發起量子分析文檔結構。

參數：

• projectPath：目標目錄的神經路徑

示例請求：

{
  name: "evaluate_readme",
  arguments: {
    projectPath: "/path/to/project"
  }
}

示例響應：

{
  content: [
    {
      type: "text",
      text: JSON.stringify({
        filePath: "/path/to/project/README.md",
        hasHeaderImage: true,
        headerImageQuality: {
          hasGradient: true,
          hasAnimation: true,
          // ... 其他質量指標
        },
        score: 95,
        suggestions: [
          "考慮添加語言徽章",
          // ... 其他建議
        ]
      })
    }
  ]
}

💻 使用示例

基礎用法

npm install

此命令用於初始化核心，安裝項目所需的依賴。

高級用法

npm run build

該命令用於編譯矩陣，為項目的運行做準備。

npm run watch

此命令用於建立即時神經網絡連接，開啟開發模式。

📚 詳細文檔

調試協議

通過MCP Inspector訪問神經網絡：

npm run inspector

常見問題解決指南

常見問題及解決方案

1. 標題圖片未被檢測

   • 確保SVG文件位於assets/目錄中
   • 驗證SVG文件包含正確的XML結構
   • 檢查文件權限

2. 語言徽章未識別

   • 確認徽章使用shields.io格式
   • 檢查HTML結構遵循推薦模式
   • 確保正確居中對齊

3. 構建錯誤

   • 清除node_modules並重新安裝依賴項
   • 確保TypeScript版本與項目要求匹配
   • 檢查修改文件中的語法錯誤

4. MCP連接問題

   • 驗證stdio傳輸配置
   • 檢查Claude Desktop配置
   • 確保配置文件路徑正確

性能優化

1. SVG分析

   • 最小化SVG複雜度以提高解析速度
   • 使用高效的漸變和動畫
   • 在保證質量的前提下優化文件大小

2. README掃描

   • 結構化內容以實現最佳解析
   • 使用推薦的Markdown模式
   • 遵循徽章放置指南

🔧 技術細節

服務器實現了全面的錯誤處理：

try {
  const evaluations = await readmeService.evaluateAllReadmes(projectPath);
  // 處理結果
} catch (error) {
  const errorMessage = error instanceof Error ? error.message : String(error);
  return {
    content: [{
      type: 'text',
      text: `評估錯誤：${errorMessage}`
    }],
    isError: true
  };
}

📄 許可證

根據MIT協議運行。