docs: finalize comprehensive documentation and MCP guide

2026-05-07 18:52:03 -03:00
parent 4d689ad6f3
commit 0f3778e3e8
2 changed files with 83 additions and 11 deletions
@@ -0,0 +1,56 @@
+# Guia do Servidor MCP: Wiki Técnica Fluig
+
+Este guia explica como configurar e utilizar o servidor MCP (Model Context Protocol) para permitir que agentes de IA (como Claude Desktop, Cursor ou IDEs) interajam de forma inteligente com a documentação técnica do Fluig extraída pelo projeto `apitdn`.
+
+## 1. Pré-requisitos
+*   Python 3.9 ou superior.
+*   Dependências instaladas:
+    ```bash
+    pip install -r requirements.txt
+    ```
+
+## 2. Arquitetura do MCP
+O servidor (`mcp_server.py`) utiliza o framework **FastMCP** e expõe o conteúdo do arquivo `fluig_chunks.json` e da `Biblioteca de Snippets`. Ele opera via interface **STDIO**, que é o padrão para integração com a maioria dos clientes de IA.
+
+## 3. Ferramentas Disponíveis (Tools)
+Ao conectar este MCP a um agente de IA, as seguintes ferramentas ficam disponíveis:
+
+*   **`search_docs(query)`**: Realiza uma busca semântica por palavras-chave nos ~1.800 chunks da documentação. Ideal para dúvidas conceituais ou de configuração.
+*   **`get_code_snippets(language)`**: Retorna todos os exemplos de código para a linguagem solicitada (`javascript`, `java` ou `sql`).
+*   **Recurso `docs://all_titles`**: Fornece uma lista completa de todos os títulos de páginas disponíveis na base de conhecimento.
+
+## 4. Configuração no Claude Desktop
+Para usar este MCP no Claude Desktop, adicione a seguinte configuração ao seu arquivo `claude_desktop_config.json`:
+
+**Caminho do arquivo (Windows):** `%APPDATA%\Claude\claude_desktop_config.json`
+
+```json
+{
+  "mcpServers": {
+    "fluig-wiki": {
+      "command": "python",
+      "args": ["C:/dev/apitdn/mcp_server.py"],
+      "env": {
+        "PYTHONPATH": "C:/dev/apitdn"
+      }
+    }
+  }
+}
+```
+*Substitua `C:/dev/apitdn` pelo caminho absoluto do seu repositório.*
+
+## 5. Como Testar
+Você pode testar se o servidor está respondendo corretamente via linha de comando usando o `mcp-cli` (se instalado) ou apenas rodando o script para verificar erros de importação:
+```bash
+python mcp_server.py
+```
+*(O comando acima não produzirá saída visível e ficará aguardando input STDIO, o que indica que está funcionando corretamente).*
+
+## 6. Sincronização com o Gitea
+Sempre que novos documentos forem extraídos do TDN via `fluig_extractor.py`, lembre-se de rodar:
+1. `python rag_processor.py` (para atualizar o `fluig_chunks.json`).
+2. `python snippet_generator.py` (para atualizar a biblioteca de códigos).
+3. `git commit -am "docs: update knowledge base"`
+4. `git push origin master`
+
+Isso garantirá que o servidor MCP sempre forneça as informações mais recentes para a sua IA.