Provides HTML documentation hosted on GitHub Pages with complete setup guides, configuration instructions, and API reference for the MCP RAG server
Uses Hugging Face's sentence transformers API to generate embeddings for semantic search in the RAG system, specifically leveraging the sentence-transformers/all-MiniLM-L6-v2 model for document and memory vectorization
MCP RAG
Um servidor MCP (Model Context Protocol) completo para RAG (Retrieval-Augmented Generation) com gerenciamento de arquivos e memória vetorial para agentes.
🚀 Características
📄 Gerenciamento de Arquivos: Adicione, remova e pesquise documentos em diversos formatos (PDF, DOCX, TXT, MD, CSV, JSON)
🧠 Memória Vetorial: Sistema separado para que agentes armazenem informações importantes para uso futuro
🔍 Busca Semântica: Utiliza embeddings do Hugging Face para busca semântica avançada
💾 Banco Vetorial Local: ChromaDB local para armazenamento eficiente de vetores e metadados
🛠️ Script de Manutenção: CLI completo para gerenciamento e manutenção do sistema
📚 Documentação Completa: HTML para GitHub Pages com guias de configuração
Related MCP server: RAG_MCP
📋 Pré-requisitos
Node.js 18+
npm ou yarn
Chave da API do Hugging Face
🛠️ Instalação
Clone o repositório
git clone https://github.com/seu-usuario/mcp-rag.git cd mcp-ragInstale as dependências
npm installConfigure as variáveis de ambiente
cp .env.example .envEdite o arquivo
.enve configure sua chave da API do Hugging Face:HUGGINGFACE_API_KEY=sua_chave_aquiCompile o projeto
npm run build
🔧 Configuração
Cursor
Adicione a seguinte configuração no arquivo de configurações do MCP:
Claude Desktop
Adicione a configuração no arquivo claude_desktop_config.json:
VS Code
Configure no settings.json:
🛠️ Script de Manutenção
O projeto inclui um CLI completo para manutenção:
🔍 Ferramentas MCP Disponíveis
Gerenciamento de Arquivos
add_file: Adiciona um arquivo ao sistema RAGsearch_files: Busca documentos relevantesremove_file: Remove um arquivo do sistemalist_files: Lista todos os arquivos no sistema
Gerenciamento de Memória
add_memory: Adiciona informação à memória do agentesearch_memory: Busca na memória do agenteremove_memory: Remove uma entrada da memóriaget_memory_by_agent: Obtém toda a memória de um agente
Utilitários
get_stats: Obtém estatísticas do sistemaclear_data: Limpa dados do sistematest_connection: Testa a conexão com o serviço de embeddings
📊 Formatos Suportados
PDF: Documentos PDF com texto extraível
DOCX: Documentos do Microsoft Word
TXT: Arquivos de texto simples
MD: Arquivos Markdown
CSV: Arquivos de dados separados por vírgula
JSON: Arquivos de dados JSON
⚙️ Configurações
Variáveis de Ambiente
🚀 Uso
Iniciando o Servidor
Desenvolvimento
Testes
📚 Documentação
A documentação completa está disponível em HTML para GitHub Pages em docs/index.html. Ela inclui:
Guias de instalação e configuração
Instruções para Cursor, Claude Desktop e VS Code
Exemplos de uso
Solução de problemas
Referência completa das ferramentas
🤝 Contribuição
Fork o projeto
Crie uma branch para sua feature (
git checkout -b feature/AmazingFeature)Commit suas mudanças (
git commit -m 'Add some AmazingFeature')Push para a branch (
git push origin feature/AmazingFeature)Abra um Pull Request
📄 Licença
Este projeto está licenciado sob a Licença MIT - veja o arquivo LICENSE para detalhes.
🙏 Agradecimentos
Model Context Protocol - Protocolo base
Hugging Face - Serviço de embeddings
ChromaDB - Banco de dados vetorial
Anthropic - Claude e MCP
📞 Suporte
Se você encontrar problemas ou tiver dúvidas:
Verifique a documentação HTML
Abra uma issue
Consulte a seção de solução de problemas na documentação
Desenvolvido com ❤️ para a comunidade de IA