RAG Documentation

RAG Documentation MCP Server

Uma implementação de servidor MCP que fornece ferramentas para recuperar e processar documentação por meio de busca vetorial, permitindo que assistentes de IA aumentem suas respostas com contexto relevante da documentação.

Recursos

• Pesquisa e recuperação de documentação baseada em vetores
• Suporte a múltiplas fontes de documentação
• Capacidades de pesquisa semântica
• Processamento automatizado de documentação
• Aumento de contexto em tempo real para LLMs

Ferramentas

search_documentation

Pesquise na documentação armazenada usando consultas em linguagem natural. Retorna trechos correspondentes com contexto, classificados por relevância.

Entradas:

• query (string): O texto a ser pesquisado na documentação. Pode ser uma consulta em linguagem natural, termos específicos ou trechos de código.
• limit (number, opcional): Número máximo de resultados a retornar (1-20, padrão: 5). Limites maiores fornecem resultados mais abrangentes, mas podem levar mais tempo para processar.

list_sources

Lista todas as fontes de documentação atualmente armazenadas no sistema. Retorna uma lista abrangente de toda a documentação indexada, incluindo URLs de origem, títulos e horários da última atualização. Use isso para entender qual documentação está disponível para pesquisa ou para verificar se fontes específicas foram indexadas.

extract_urls

Extrai e analisa todos os URLs de uma determinada página da web. Esta ferramenta rastreia a página especificada, identifica todos os hiperlinks e, opcionalmente, os adiciona à fila de processamento.

Entradas:

• url (string): O URL completo da página da web a ser analisada (deve incluir o protocolo, ex.: https://). A página deve ser publicamente acessível.
• add_to_queue (boolean, opcional): Se verdadeiro, adiciona automaticamente os URLs extraídos à fila de processamento para indexação posterior. Use com cautela em sites grandes para evitar enfileiramento excessivo.

remove_documentation

Remove fontes de documentação específicas do sistema por seus URLs. A remoção é permanente e afetará os resultados de pesquisa futuros.

Entradas:

• urls (string[]): Matriz de URLs a serem removidos do banco de dados. Cada URL deve corresponder exatamente ao URL usado quando a documentação foi adicionada.

list_queue

Lista todos os URLs atualmente aguardando na fila de processamento da documentação. Mostra as fontes de documentação pendentes que serão processadas quando run_queue for chamado. Use isso para monitorar o status da fila, verificar se os URLs foram adicionados corretamente ou verificar o backlog de processamento.

run_queue

Processa e indexa todos os URLs atualmente na fila de documentação. Cada URL é processado sequencialmente, com tratamento de erros adequado e lógica de repetição. Atualizações de progresso são fornecidas conforme o processamento ocorre. Operações de longa duração processarão até que a fila esteja vazia ou ocorra um erro irrecuperável.

clear_queue

Remove todos os URLs pendentes da fila de processamento da documentação. Use isso para redefinir a fila quando quiser começar do zero, remover URLs indesejados ou cancelar o processamento pendente. Esta operação é imediata e permanente - os URLs precisarão ser readicionados se você quiser processá-los posteriormente.

Uso

A ferramenta RAG Documentation é projetada para:

• Aprimorar respostas de IA com documentação relevante
• Construir assistentes de IA cientes da documentação
• Criar ferramentas sensíveis ao contexto para desenvolvedores
• Implementar pesquisa semântica de documentação
• Aumentar bases de conhecimento existentes

Configuração

Uso com Claude Desktop

Adicione isso ao seu claude_desktop_config.json:

{
  "mcpServers": {
    "rag-docs": {
      "command": "npx",
      "args": [
        "-y",
        "@hannesrudolph/mcp-ragdocs"
      ],
      "env": {
        "OPENAI_API_KEY": "",
        "QDRANT_URL": "",
        "QDRANT_API_KEY": ""
      }
    }
  }
}

Você precisará fornecer valores para as seguintes variáveis de ambiente:

• OPENAI_API_KEY: Sua chave de API da OpenAI para geração de embeddings
• QDRANT_URL: URL da sua instância de banco de dados vetorial Qdrant
• QDRANT_API_KEY: Chave de API para autenticação com Qdrant

Licença

Este servidor MCP é licenciado sob a Licença MIT. Isso significa que você é livre para usar, modificar e distribuir o software, sujeito aos termos e condições da Licença MIT. Para mais detalhes, consulte o arquivo LICENSE no repositório do projeto.

Agradecimentos

Este projeto é um fork de qpd-v/mcp-ragdocs, originalmente desenvolvido por qpd-v. O projeto original forneceu a base para esta implementação.