DocuMind MCP Server

🌐 DocuMind MCP Server

"Onde a Documentação Encontra a Inteligência Digital"

Um servidor de Model Context Protocol (MCP) de próxima geração que revoluciona a análise de qualidade de documentação por meio de processamento neural avançado.

⚡ Sistemas Principais

• 🧠 Análise Neural de Documentação: Algoritmos avançados para avaliação abrangente de READMEs
• 🔮 Varredura Holográfica de Cabeçalhos: Análise de SVG de ponta para elementos visuais
• 🌍 Suporte Multidimensional a Idiomas: Verificação de documentação entre idiomas
• 💫 Mecanismo Quântico de Sugestões: Recomendações de melhoria impulsionadas por IA

🚀 Sequência de Inicialização do Sistema

Requisitos do Sistema

• Node.js 18+
• npm || yarn

Inicializar Núcleo

npm install

Compilar Matriz

npm run build

Link de Desenvolvimento Neural

Estabeleça conexão neural em tempo real:

npm run watch

🛸 Protocolo de Operação

Configuração do Sistema

Integre com o mainframe do Claude Desktop:

Terminal Windows:

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

Comandos de Interface Neural

evaluate_readme

Inicia análise quântica da estrutura da documentação.

Parâmetros:

• projectPath: Caminho neural para o diretório de destino

Exemplo de Solicitação:

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

Exemplo de Resposta:

{
  content: [
    {
      type: "text",
      text: JSON.stringify({
        filePath: "/path/to/project/README.md",
        hasHeaderImage: true,
        headerImageQuality: {
          hasGradient: true,
          hasAnimation: true,
          // ... other quality metrics
        },
        score: 95,
        suggestions: [
          "Consider adding language badges",
          // ... other suggestions
        ]
      })
    }
  ]
}

🔮 Matriz de Desenvolvimento

Protocolo de Depuração

Acesse a rede neural através do MCP Inspector:

npm run inspector

Guia de Solução de Problemas

Problemas Comuns e Soluções

1. Imagem de Cabeçalho Não Detectada

   • Certifique-se de que o arquivo SVG esteja no diretório assets/
   • Valide se o arquivo SVG contém estrutura XML adequada
   • Verifique as permissões do arquivo

2. Badges de Idioma Não Reconhecidos

   • Verifique se os badges usam o formato shields.io
   • Confira se a estrutura HTML segue o padrão recomendado
   • Garanta o alinhamento central adequado

3. Erros de Build

   • Limpe node_modules e reinstale as dependências
   • Certifique-se de que a versão do TypeScript atenda aos requisitos do projeto
   • Verifique erros de sintaxe nos arquivos modificados

4. Problemas de Conexão MCP

   • Verifique a configuração de transporte stdio
   • Confira a configuração do Claude Desktop
   • Garanta caminhos de arquivo corretos na configuração

Otimização de Desempenho

1. Análise de SVG

   • Minimize a complexidade do SVG para análise mais rápida
   • Use gradientes e animações eficientes
   • Otimize o tamanho do arquivo mantendo a qualidade

2. Varredura de README

   • Estruture o conteúdo para análise ideal
   • Use padrões de markdown recomendados
   • Siga as diretrizes de posicionamento de badges

🔬 Documentação da API

Classes Principais

ReadmeService

Serviço principal para análise e avaliação de READMEs.

class ReadmeService {
  // Analyzes all README files in a project
  async evaluateAllReadmes(projectPath: string): Promise<ReadmeEvaluation[]>
  
  // Evaluates a single README file
  private async evaluateReadme(dirPath: string, readmePath: string): Promise<ReadmeEvaluation>
  
  // Evaluates language badge configuration
  private evaluateLanguageBadges(content: string): BadgeEvaluation
}

SVGService

Serviço especializado para análise de imagens de cabeçalho SVG.

class SVGService {
  // Evaluates SVG header image quality
  public evaluateHeaderImageQuality(imgSrc: string, content: string): HeaderImageQuality
  
  // Checks for project-specific elements in SVG
  private checkProjectSpecificImage(svgContent: string, readmeContent: string): boolean
}

Interfaces Principais

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

Tratamento de Erros

O servidor implementa tratamento abrangente de erros:

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

⚡ Licença

Operando sob o Protocolo MIT.