RAG MCP Server
An API that enables document querying through a Retrieval-Augmented Generation system implemented with Memory-Controller-Policy architecture for improved maintainability and scalability.
README
Projeto de RAG com Arquitetura MCP
Aplicação de Busca Aumentada por Geração (RAG) para consulta de documentos, reestruturada com a arquitetura Memory, Controller, Policy (MCP) para maior clareza, manutenibilidade e escalabilidade.
Relatório de Melhorias: Da Arquitetura Inicial para MCP
1. Estado Inicial do Projeto
O projeto inicial já era funcional e implementava um fluxo RAG básico. No entanto, a arquitetura apresentava os seguintes desafios:
- Alto Acoplamento: A lógica de negócio, as chamadas à API do Pinecone e a formatação de prompts para o LLM estavam misturadas nos mesmos arquivos de rota da API (ex:
llm_router.py). - Dificuldade de Manutenção: Qualquer alteração, como a troca do modelo de embedding ou a adição de uma nova regra de negócio, exigiria modificar múltiplos arquivos e funções interligadas.
- Baixa Escalabilidade: Adicionar novos fluxos, como um histórico de conversas ou regras de acesso mais complexas, seria complicado e tornaria o código progressivamente mais confuso.
2. Solução Implementada (Arquitetura MCP)
Para resolver esses desafios, o projeto foi refatorado para adotar o padrão de arquitetura Memory, Controller, Policy (MCP), que separa claramente as responsabilidades do sistema.
Componentes da Arquitetura MCP:
-
Memory(Memória):- Responsabilidade: Gerenciar o estado e o conhecimento de longo prazo do sistema.
- Implementação: A pasta
memory/e o arquivopinecone_memory.pyagora centralizam toda a interação com o banco de dados vetorial (Pinecone). Qualquer operação de busca ou salvamento de documentos passa por esta camada.
-
Policy(Política):- Responsabilidade: Aplicar regras de negócio, validações e restrições.
- Implementação: A pasta
policy/e o arquivopolicy.pycontêm a lógica para validar perguntas, filtrar resultados com base em score de relevância, ou aplicar quaisquer outras regras de negócio (ex: anonimização de dados, controle de acesso).
-
Controller(Controlador):- Responsabilidade: Orquestrar todo o fluxo de uma requisição. Ele atua como o "cérebro" da operação.
- Implementação: A pasta
controller/e o arquivocontroller.pyrecebem a requisição, utilizam aMemorypara buscar o contexto, aplicam as regras daPolicye, finalmente, montam o prompt e chamam o LLM (Gemini) para gerar a resposta.
3. Principais Vantagens da Nova Arquitetura
- Separação de Responsabilidades: Cada componente tem um único trabalho, tornando o código mais limpo e fácil de entender.
- Facilidade de Manutenção: Precisa trocar o Pinecone por outro banco vetorial? Modifique apenas a camada de
Memory. Quer adicionar novas regras de negócio? Trabalhe apenas na camada dePolicy. - Escalabilidade: É simples adicionar novas funcionalidades. Por exemplo, para implementar um histórico de conversas, basta expandir a camada de
Memorye ajustar oControllerpara usá-lo. - Testabilidade: Cada camada (Memory, Controller, Policy) pode ser testada de forma isolada, garantindo maior qualidade e confiabilidade do código.
Diagrama da Nova Arquitetura
graph TD
subgraph "API Layer"
A[FastAPI: /mcp/ask]
end
subgraph "Application Core (MCP)"
B[Controller]
C[Policy]
D[Memory]
end
subgraph "External Services"
E[Pinecone DB]
F[Gemini LLM]
end
A -- Requisição --> B
B -- Aplica Regras --> C
B -- Busca Contexto --> D
D <--> E
B -- Gera Resposta --> F
F -- Resposta --> B
B -- Resposta Final --> A
Como Configurar e Rodar o Projeto
Pré-requisitos
- Python 3.9+
- Conta no Pinecone
- Chave de API da Google (Gemini)
1. Crie o Ambiente Virtual
python -m venv venv
2. Ative o Ambiente Virtual
- Windows (PowerShell):
.\venv\Scripts\activate - Linux/macOS:
source venv/bin/activate
3. Instale as Dependências
pip install -r requirements.txt
4. Configure as Variáveis de Ambiente
- Renomeie o arquivo
.env.examplepara.env. - Abra o arquivo
.enve preencha com suas chaves de API:PINECONE_API_KEY="SUA_CHAVE_PINECONE" PINECONE_HOST="SEU_HOST_PINECONE" PINECONE_INDEX_NAME="brito-ai" GEMINI_API_KEY="SUA_CHAVE_GEMINI"
5. Rodar o Back-End
uvicorn api_mcp:app --reload --host 0.0.0.0 --port 8000
6. Rodar o Front-End
cd frontend
npm run dev
7. Rode o Servidor da API
uvicorn api_mcp:app --reload
O servidor estará disponível em http://127.0.0.1:8000/docs.
Como Usar a API
- Acesse a documentação interativa no seu navegador: http://127.0.0.1:8000/docs.
- Encontre o endpoint
POST /mcp/ask. - Clique em "Try it out".
- Preencha o corpo da requisição com sua pergunta. Exemplo:
{ "pergunta": "Quais são as principais cláusulas do contrato de aluguel?", "max_results": 3 } - Clique em "Execute" para ver a resposta gerada pelo sistema.
推荐服务器
Baidu Map
百度地图核心API现已全面兼容MCP协议,是国内首家兼容MCP协议的地图服务商。
Playwright MCP Server
一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。
Magic Component Platform (MCP)
一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。
Audiense Insights MCP Server
通过模型上下文协议启用与 Audiense Insights 账户的交互,从而促进营销洞察和受众数据的提取和分析,包括人口统计信息、行为和影响者互动。
VeyraX
一个单一的 MCP 工具,连接你所有喜爱的工具:Gmail、日历以及其他 40 多个工具。
graphlit-mcp-server
模型上下文协议 (MCP) 服务器实现了 MCP 客户端与 Graphlit 服务之间的集成。 除了网络爬取之外,还可以将任何内容(从 Slack 到 Gmail 再到播客订阅源)导入到 Graphlit 项目中,然后从 MCP 客户端检索相关内容。
Kagi MCP Server
一个 MCP 服务器,集成了 Kagi 搜索功能和 Claude AI,使 Claude 能够在回答需要最新信息的问题时执行实时网络搜索。
e2b-mcp-server
使用 MCP 通过 e2b 运行代码。
Neon MCP Server
用于与 Neon 管理 API 和数据库交互的 MCP 服务器
Exa MCP Server
模型上下文协议(MCP)服务器允许像 Claude 这样的 AI 助手使用 Exa AI 搜索 API 进行网络搜索。这种设置允许 AI 模型以安全和受控的方式获取实时的网络信息。