<div align="center"> <img src="assets/header.svg" alt="DocuMind MCP Server" width="800">

<div align="center"> <a href="README.md"><img src="https://img.shields.io/badge/english-document-blue.svg" alt="EN doc"></a> <a href="README.ja.md"><img src="https://img.shields.io/badge/ドキュメント-日本語-blue.svg" alt="JA doc"/></a> </div> </div>

🌐 DocuMind MCP 服务器

"文档与数字智能的交汇之处"

下一代模型上下文协议 (MCP) 服务器，通过先进的神经处理彻底改变文档质量分析。

⚡ 核心系统

• 🧠 神经文档分析: 用于全面 README 评估的先进算法
• 🔮 全息头部扫描: 用于视觉元素的尖端 SVG 分析
• 🌍 多维语言支持: 跨语言文档验证
• 💫 量子建议引擎: AI 驱动的改进建议

🚀 系统启动序列

系统要求

• Node.js 18+
• npm || yarn

初始化核心

npm install

编译矩阵

npm run build

神经开发链接

建立实时神经连接：

npm run watch

🛸 操作协议

系统配置

与 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: [
          "考虑添加语言徽章",
          // ... 其他建议
        ]
      })
    }
  ]
}

🔮 开发矩阵

调试协议

通过 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 模式
   • 遵循徽章放置指南

🔬 API 文档

核心类

ReadmeService

用于 README 分析和评估的主要服务。

class ReadmeService {
  // 分析项目中的所有 README 文件
  async evaluateAllReadmes(projectPath: string): Promise<ReadmeEvaluation[]>
  
  // 评估单个 README 文件
  private async evaluateReadme(dirPath: string, readmePath: string): Promise<ReadmeEvaluation>
  
  // 评估语言徽章配置
  private evaluateLanguageBadges(content: string): BadgeEvaluation
}

SVGService

用于 SVG 头部图像分析的专用服务。

class SVGService {
  // 评估 SVG 头部图像质量
  public evaluateHeaderImageQuality(imgSrc: string, content: string): HeaderImageQuality
  
  // 检查 SVG 中特定于项目的元素
  private checkProjectSpecificImage(svgContent: string, readmeContent: string): boolean
}

核心接口

interface ReadmeEvaluation {
  filePath: string;
  hasHeaderImage: boolean;
  headerImageQuality: HeaderImageQuality;
  isCentered: {
    headerImage: boolean;
    title: boolean;
    badges: boolean;
  };
  hasBadges: {
    english: boolean;
    japanese: boolean;
    isCentered: boolean;
    hasCorrectFormat: boolean;
  };
  score: number;
  suggestions: string[];
}

interface HeaderImageQuality {
  hasGradient: boolean;
  hasAnimation: boolean;
  hasRoundedCorners: boolean;
  hasEnglishText: boolean;
  isProjectSpecific: boolean;
}

错误处理

服务器实现了全面的错误处理：

try {
  const evaluations = await readmeService.evaluateAllReadmes(projectPath);
  // 处理结果
} catch (error) {
  const errorMessage = error instanceof Error ? error.message : String(error);
  return {
    content: [{
      type: 'text',
      text: `Evaluation error: ${errorMessage}`
    }],
    isError: true
  };
}

⚡ 许可证

在 MIT 协议下运行。