[{"_1":2,"_321":-5,"_322":-5},"loaderData",{"_3":4,"_22":23,"_24":25,"_265":266},"root",{"_5":6,"_7":8},"toasts",[],"visitor",{"_9":10,"_11":12},"viewportWidth",1280,"visitorSession",{"_13":14,"_16":17,"_18":-5,"_19":20,"_21":-5},"attributes",[15],"BOT","id",7058884,"membership","referenceId","01971406-43e3-74e8-b880-2f000258007a","userAccount","routes/_public/_layout",{},"routes/_public/mcp/servers/~namespace/~slug/_pages/_layout",{"_26":27,"_82":-5,"_83":40,"_29":84,"_184":185,"_264":143},"availableLocales",[28,40,47,54,61,68,75],{"_29":30,"_33":37,"_38":39},"mcpServer",{"_31":32,"_33":34,"_35":36},"description","Ein Server, der Tools zum Abrufen von SonarQube-Projektmetriken und Qualitätsdaten über einen vereinfachten nachrichtenbasierten Ansatz bereitstellt und Benutzern den programmgesteuerten Zugriff auf Metriken, historische Daten und Informationen auf Komponentenebene von SonarQube ermöglicht.","name","FastMCP SonarQube-Metriken","readme","# FastMCP SonarQube-Metriken\n\n![Logo](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/logo.png)\n\n## Überblick\n\nDieses Projekt bietet eine Reihe von Tools zum Abrufen von Informationen zu SonarQube-Projekten mithilfe des FastMCP-Frameworks (Fast Model Context Protocol). Es dient als Schnittstelle zu SonarQube und ermöglicht Benutzern den programmgesteuerten Zugriff auf Metriken, historische Daten und Komponentenbaummetriken für bestimmte Projekte. Dieser automatisierte Zugriff ermöglicht die Berichterstellung, Analyse und Integration von SonarQube-Daten in andere Systeme.\n\nDas Projekt zeichnet sich durch einen vereinfachten, nachrichtenbasierten Ansatz für die Interaktion mit der SonarQube-API aus und abstrahiert die Komplexität direkter API-Aufrufe und der Datenverarbeitung. Es richtet sich an Entwickler, DevOps-Ingenieure und Analysten, die SonarQube-Daten in ihre Workflows integrieren oder individuelle Berichtslösungen erstellen müssen.\n\nDieses Repository beherbergt insbesondere die Client- und Serverkomponenten, die die Kommunikation und den Datenabruf ermöglichen. Der Server stellt Tools zum Abrufen von Daten aus SonarQube bereit, während der Client eine Befehlszeilenschnittstelle bereitstellt, über die Benutzer diese Tools aufrufen und die Ergebnisse anzeigen können. Jedes interne Modul trägt zu diesem Ziel bei, indem es spezifische Funktionen wie API-Interaktion, Datenverarbeitung und Client-Server-Kommunikation kapselt.\n\nDer im Projekt enthaltene Client dient nur zum Testen der Funktionsweise des Codes. Wir empfehlen die Verwendung von [Claude Desktop](https://claude.ai/download) oder die Entwicklung eines eigenen benutzerdefinierten Clients.\n\n> ***BEDENKEN SIE, DASS DIESES REPO NOCH IN ARBEIT IST UND EINIGE FUNKTIONEN MÖGLICHERWEISE NICHT PERFEKT SIND.***\n\n## Unterstützte MCP-Tools\n\n* `get_status` : Führt eine Integritätsprüfung der konfigurierten SonarQube-Instanz durch.\n* `list_projects` : Listet alle zugänglichen SonarQube-Projekte auf, optional gefiltert nach Name oder Schlüssel.\n* `get_sonarqube_metrics` : Ruft angegebene Metriken (Fehler, Schwachstellen, Code-Smells, Abdeckung, Duplizierungsdichte) für einen bestimmten SonarQube-Projektschlüssel ab.\n* `get_sonarqube_metrics_history` : Ruft historische Metriken (Bugs, Schwachstellen, Code Smells, Abdeckung, Duplizierungsdichte) für ein bestimmtes SonarQube-Projekt mithilfe von /api/measures/search\\_history ab. Optionale Datumsfilter können angewendet werden.\n* `get_sonarqube_component_tree_metrics` : Ruft Metrikwerte für alle Komponenten (z. B. Dateien oder Verzeichnisse) in einem Projekt mithilfe von /api/measures/component\\_tree ab. Verarbeitet automatisch die Paginierung, um alle Ergebnisse abzurufen.\n* `get_project_issues` : Ruft SonarQube-Probleme für ein bestimmtes Projekt ab, optional gefiltert nach Typ, Schweregrad und Lösungsstatus. Gibt bis zu *einer bestimmten Anzahl* von Ergebnissen zurück (Standard: 10).\n\n## Technologie-Stack\n\n* **Sprache:** Python\n* **Frameworks:** FastMCP\n* **Bibliotheken:** httpx, pydantic, dotenv, asyncio, json, pathlib, typing, base64\n* **Tools:** SonarQube API\n\n## Verzeichnisstruktur\n\n```\n├── client_test.py - Client application for testing and interacting with the server.\r\n├── server.py - Server application exposing tools to retrieve SonarQube metrics.\r\n├── client_tool.py - Client with a graphical interface to interact with the SonarQube server.\r\n├── client_langchain.py - Command-line client to interact with the FastMCP server and SonarQube tools via LangChain\r\n├── .env - Environment configuration file (stores SonarQube URL and token).\r\n└── README.md - Project documentation.\n```\n\n## Erste Schritte\n\n### Voraussetzungen\n\n* Python 3.7+\n* SonarQube-Instanz mit API-Zugriff\n* Ein SonarQube-API-Token mit entsprechenden Berechtigungen\n* FastMCP installiert ( `pip install fastmcp` )\n* httpx installiert ( `pip install httpx` )\n* pydantic installiert ( `pip install pydantic` )\n* python-dotenv installiert ( `pip install python-dotenv` )\n\n### Allgemeine Build-Schritte\n\n1. **Klonen Sie das Repository:** `git clone `\n\n2. **Navigieren Sie zum Projektverzeichnis:** `cd fastmcp-sonarqube-metrics`\n\n3. **Umgebungsvariablen einrichten:** Erstellen Sie im Stammverzeichnis des Projekts eine `.env` Datei mit folgendem Inhalt:\n\n ```\n SONARQUBE_URL=\r\n SONARQUBE_TOKEN=\r\n TRANSPORT=\r\n GEMINI_API_KEY=\r\n OPENAI_API_KEY=\n ```\n\n Ersetzen Sie `` durch die URL Ihrer SonarQube-Instanz (z. B. `http://localhost:9000` ) und `` durch Ihr SonarQube-API-Token.\n\n4. **Führen Sie den Server aus:** `python server.py`\n\n5. **Führen Sie den Client aus:** `python client_test.py`*(Optional, nur zum Testen)*\n\n6. **Stellen Sie eine Verbindung zu Ihrem Client her:** Befolgen Sie die [offizielle Dokumentation](https://modelcontextprotocol.io/quickstart/user#windows)\n\n### Modulnutzung\n\n#### Server ( `server.py` )\n\nDas Modul `server.py` definiert den FastMCP-Server, der Tools zum Abrufen von SonarQube-Metriken bereitstellt. Es initialisiert den Server, lädt Umgebungsvariablen, definiert die verfügbaren Tools und übernimmt die Kommunikation mit der SonarQube-API. Um den Server zu verwenden, müssen Sie die Umgebungsvariablen `SONARQUBE_URL` und `SONARQUBE_TOKEN` festlegen. Der Server wird durch direkte Ausführung des Skripts `server.py` gestartet.\n\n#### Client ( `client_test.py` )\n\nDas Modul `client_test.py` definiert den FastMCP-Client, der mit dem Server interagiert. Es fordert den Benutzer zur Eingabe eines SonarQube-Projektschlüssels auf, stellt eine Verbindung zum Server her, ruft die Tools `get_sonarqube_metrics` und `get_sonarqube_component_tree_metrics` auf und zeigt die Ergebnisse an. Um den Client zu verwenden, müssen Sie das Skript `client_test.py` direkt ausführen und bei entsprechender Aufforderung einen gültigen SonarQube-Projektschlüssel angeben.\n\n#### Client\\_tool ( `client_tool.py` )\n\nDas Modul `client_tool.py` implementiert den FastMCP-Client mit einer Tkinter-basierten grafischen Oberfläche zur Interaktion mit dem SonarQube-Server. Beim Start konfiguriert es Logger, um nicht notwendige Nachrichten zu unterdrücken, lädt Umgebungsvariablen und startet im Hintergrund das Chat-Backend (ChatBackend). Dieses nutzt ein LLM und die vom Server über stdio bereitgestellten MCP-Tools. Das Frontend (ChatGUI) verwaltet das Tkinter-Fenster, zeigt den Nachrichtenverlauf in einem scrollbaren Bereich an und ermöglicht dem Benutzer das Senden von Befehlen an den Server – wobei bei Bedarf ein gültiger SonarQube-Projektschlüssel abgefragt wird. Um den Client zu verwenden, führen Sie einfach das Skript `client_tool.py` aus und interagieren Sie über die GUI.\n\n#### Client\\_langchain ( `client_langchain.py` )\n\nDas Modul `client_langchain.py` bietet einen Kommandozeilen-Client für die Interaktion mit dem FastMCP-Server und den SonarQube-Tools über LangChain. Beim Start lädt es Umgebungsvariablen und konfiguriert das gewählte LLM. Es stellt eine Standardverbindung zum Server ( `server.py` ) her, initialisiert die MCP-Sitzung und lädt verfügbare Tools (Integritätscheck, aktuelle und historische Metriken, Projektliste, Problemabfrage). Eine detaillierte Systemeingabeaufforderung beschreibt jedes Tool und seine Parameter. In einer interaktiven Schleife liest es Benutzereingaben aus der Konsole, aktualisiert den Nachrichtenverlauf, ruft den React-Agenten auf und gibt die formatierte Antwort aus.\n\n### Beispiel: Integration des Tools `get_sonarqube_metrics` in ein externes Projekt\n\nUm das Tool `get_sonarqube_metrics` in einem externen Projekt zu verwenden, können Sie einen Client erstellen, der eine Verbindung zum FastMCP-Server herstellt und das Tool aufruft. Hier ist ein einfaches Beispiel:\n\n```python\nimport asyncio\r\nfrom fastmcp import Client\r\nfrom fastmcp.types import TextContent\r\n\r\nasync def get_metrics(project_key: str):\r\n server_path = \"server.py\" # Adjust if necessary\r\n client = Client(server_path)\r\n try:\r\n async with client:\r\n result = await client.call_tool(\r\n \"get_sonarqube_metrics\", {\"project_key\": project_key}\r\n )\r\n if result:\r\n content = result[0]\r\n if isinstance(content, TextContent):\r\n metrics = json.loads(content.text)\r\n print(metrics)\r\n except Exception as e:\r\n print(f\"Error: {e}\")\r\n\r\nif __name__ == \"__main__\":\r\n asyncio.run(get_metrics(\"your-project-key\")) # Replace with your project key\n```\n\nDieses Beispiel zeigt, wie Sie einen Client erstellen, eine Verbindung zum Server herstellen, das Tool `get_sonarqube_metrics` mit einem Projektschlüssel aufrufen und die Ergebnisse verarbeiten. Sie müssen die Variable `server_path` an den tatsächlichen Speicherort des Skripts `server.py` in Ihrer Umgebung anpassen.\n\n## ArchAI-SonarQube-Chat (GUI)\n\nEin leichtgewichtiger Tkinter-Client, der über stdio eine Verbindung zum FastMCP-Server herstellt und eine Echtzeit-Chat-Schnittstelle zum Abfragen von SonarQube-Metriken, Durchsuchen von Komponentenbäumen und Ausführen von Integritätsprüfungen über einen LLM-gesteuerten Assistenten bereitstellt.\n\n![img\\_tool](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/img_tool.png)\n\n## Verwendung mit TRANSPORT=SSE\n\nSie können die Transportschicht des Clients auf Server-Sent Events (SSE) umstellen, indem Sie vor dem Start der GUI die Umgebungsvariable `TRANSPORT` setzen. Dies ermöglicht unidirektionale Echtzeit-Updates vom FastMCP-Server. Beim Start des Servers im SSE-Modus wird eine persistente HTTP-Verbindung an Port **8001** geöffnet. Dies ermöglicht die Verbindung über kompatible Schnittstellen wie MCP Inspector.\\*\n\n1. **Starten Sie den Server im SSE-Modus**\n\n ```bash\n uv run mcp dev \"\" \n ```\n\n2. **Öffnen Sie MCP Inspector.** Ein Link (z. B. `http://127.0.0.1:6274` ) wird bereitgestellt, um MCP Inspector in Ihrem Browser zu starten.\n\n3. **Konfigurieren Sie SSE im MCP Inspector**\n\n * Wählen Sie **SSE** als Transporttyp\n * Geben Sie die URL ein: `http://localhost:8001/sse`\n\n4. **Verbindung herstellen**\n\n5. **Durchsuchen Sie die verfügbaren Tools** . Im Abschnitt **„Tools“** sehen Sie:\n\n * `get_status`\n * `get_sonarqube_metrics`\n * `get_sonarqube_metrics_history`\n * `get_sonarqube_component_tree_metrics`\n * `list_projects`\n * `get_project_issues`\n\n6. **Wählen Sie ein Tool aus und rufen Sie es auf.** Wählen Sie beispielsweise **„get\\_project\\_issues“** und geben Sie Folgendes ein:\n\n * `project_key` : der SonarQube-Projektschlüssel\n * `issue_type` (optional): zB `BUG` , `CODE_SMELL`\n * `severity` (optional): zB `MAJOR` , `CRITICAL`\n * `resolved` (optional): `true` oder `false`\n * `limit` (optional): Maximale Anzahl der zurückzugebenden Probleme\n\n7. **Ausführen und Ergebnisse abrufen** Der Server ruft die entsprechende SonarQube-API auf und gibt eine formatierte JSON-Antwort zurück.\n\n## Verwendung mit Claude Desktop\n\nSie können diesen Server mit fastmcp direkt in Claude Desktop installieren:\n\n1. Stellen Sie sicher, dass FastMCP installiert ist (pip install fastmcp oder uv pip install fastmcp).\n2. Konfigurieren Sie Claude für Desktop für die MCP-Server, die Sie verwenden möchten (in Windows mit VSCode): `code $env:AppData\\Claude\\claude_desktop_config.json`\n3. Fügen Sie Ihren Server hinzu und speichern Sie dann:\n\n```json\n{\r\n \"mcpServers\": {\r\n \"fastmcp-sonarqube-metrics\": {\r\n \"command\": \"uv\",\r\n \"args\": [\r\n \"--directory\",\r\n \"/ABSOLUTE/PATH/TO/PARENT/FOLDER/fastmcp-sonarqube-metrics\",\r\n \"run\",\r\n \"server.py\"\r\n ]\r\n }\r\n }\r\n}\n```\n\n4. So starten Sie es:\n\n```bash\n uv --directory /ABSOLUTE/PATH/TO/PARENT/FOLDER/fastmcp-sonarqube-metrics run server.py\n```\n\n5. Starten Sie Claude Desktop neu, falls es ausgeführt wurde. Das Tool *„FastMCP SonarQube Metrics“* sollte nun verfügbar sein.\n\n![Claude](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/img_claude_desktop.png)\n\n## Funktionale Analyse\n\n### 1. Hauptaufgaben des Systems\n\nDie Hauptaufgabe des Systems besteht darin, als Brücke zwischen dem Benutzer und der SonarQube-API zu fungieren und so den vereinfachten Abruf von Projektqualitätsmetriken zu ermöglichen. Es kapselt die Komplexität der SonarQube-API und bietet eine Reihe von Tools, die einfach aufgerufen und in automatisierte Workflows integriert werden können. Zu den Kerndiensten gehören das Abrufen von Metriken, das Abrufen historischer Daten und die Untersuchung von Metriken auf Komponentenebene innerhalb eines SonarQube-Projekts. Der grundlegende Dienst ist der FastMCP-Server, der die Tooldefinitionen und die Client-Server-Kommunikation verwaltet.\n\n### 2. Probleme, die das System löst\n\nDas System löst das Problem des programmgesteuerten Zugriffs auf SonarQube-Daten, ohne dass Benutzer direkt mit der SonarQube-API interagieren müssen. Es erfüllt den Bedarf an automatisierter Berichterstattung, Analyse und Integration von SonarQube-Metriken in andere Systeme. Insbesondere vereinfacht es Aufgaben wie:\n\n* Erstellen Sie regelmäßige Berichte zu Codequalitätsmetriken.\n* Überwachung von Trends in der Codequalität im Laufe der Zeit.\n* Identifizieren problematischer Komponenten innerhalb eines Projekts.\n* Integration von SonarQube-Daten mit anderen Entwicklungstools.\n\nDie Architektur löst diese Probleme, indem sie eine Reihe klar definierter Tools bereitstellt, die die Komplexität der SonarQube-API abstrahieren und eine konsistente Schnittstelle für den Datenzugriff bereitstellen.\n\n### 3. Zusammenspiel von Modulen und Komponenten\n\nDas System besteht aus zwei Hauptkomponenten: dem Client und dem Server. Der Client initiiert Anfragen an den Server und gibt dabei das auszuführende Tool sowie alle Eingabeparameter an. Der Server empfängt die Anfrage, interagiert mit der SonarQube-API, verarbeitet die Daten und sendet die Ergebnisse an den Client zurück.\n\nDie Interaktion zwischen Client und Server wird durch das FastMCP-Framework erleichtert, das die Nachrichtenübermittlung und Serialisierung übernimmt. Der Server definiert die verfügbaren Tools mithilfe des Dekorators `@mcp.tool()` , der die Funktionen als aufrufbare Endpunkte registriert. Der Client ruft diese Tools mithilfe der Methode `client.call_tool()` auf, die eine Nachricht mit dem Toolnamen und den Eingabeparametern an den Server sendet.\n\nDer Server verwendet die `httpx` Bibliothek, um asynchrone HTTP-Anfragen an die SonarQube-API zu senden. Er erstellt die API-URLs und Anfrageparameter basierend auf dem ausgeführten Tool und den vom Client bereitgestellten Eingabeparametern. Anschließend analysiert der Server die JSON-Antworten der SonarQube-API und extrahiert die relevanten Metrikwerte.\n\n### 4. Benutzerorientierte vs. systemorientierte Funktionalitäten\n\nDie benutzerorientierte Funktionalität des Systems ist die Client-Anwendung ( `client_test.py` ), die eine Befehlszeilenschnittstelle zum Aufrufen der SonarQube-Tools zum Abrufen von Metriken bereitstellt. Benutzer interagieren mit dem Client, indem sie einen SonarQube-Projektschlüssel und optional weitere Parameter wie Datumsbereiche oder Metrikschlüssel angeben. Der Client zeigt die abgerufenen Metriken anschließend in einem lesbaren Format an.\n\nDie systemseitigen Funktionen sind die serverseitigen Tools ( `get_sonarqube_metrics` , `get_sonarqube_metrics_history` , `get_sonarqube_component_tree_metrics` ), die in `server.py` definiert sind. Diese Tools übernehmen die Interaktion mit der SonarQube-API, die Datenverarbeitung und die Formatierung. Sie sind für Endbenutzer nicht direkt sichtbar, aber für die Bereitstellung der Kernfunktionalität des Systems unerlässlich.\n\nDer `@mcp.tool()` Dekorator wendet systematisch gemeinsame Verhaltensweisen auf alle Toolfunktionen an und stellt sicher, dass diese beim FastMCP-Server registriert und für Clients zugänglich sind. Darüber hinaus gewährleistet die Verwendung von `Annotated` und `Field` eine konsistente Parameterdefinition und Dokumentation über alle Tools hinweg.\n\n## Angewandte Architekturmuster und Designprinzipien\n\n* **Client-Server-Architektur:** Das Projekt folgt einer Client-Server-Architektur, bei der der Client Dienste vom Server anfordert.\n* **Nachrichtenübermittlung:** Das FastMCP-Framework erleichtert die Kommunikation zwischen Client und Server durch Nachrichtenübermittlung.\n* **Asynchrone Programmierung:** Die Verwendung von `asyncio` und `httpx` ermöglicht asynchrone Vorgänge und verbessert so die Leistung und Reaktionsfähigkeit der Anwendung.\n* **Konfiguration über Umgebungsvariablen:** Die SonarQube-URL und das Token werden mithilfe von Umgebungsvariablen konfiguriert, wodurch die Bereitstellung und Verwaltung der Anwendung in verschiedenen Umgebungen erleichtert wird.\n* **Toolbasiertes Design:** Der Server stellt Funktionen über klar definierte Tools bereit, sodass das Hinzufügen oder Ändern von Funktionen einfach ist.\n* **Fehlerbehandlung:** Das Projekt umfasst eine umfassende Fehlerbehandlung, um potenzielle Probleme wie Netzwerkfehler, API-Fehler und ungültige Daten ordnungsgemäß zu bewältigen.\n* **Protokollierung:** Die Verwendung des `logging` liefert detaillierte Protokolle, die beim Debuggen und Überwachen helfen.\n* **Abhängigkeitsinjektion:** Obwohl nicht explizit als Framework implementiert, ermöglicht die Konfiguration der SonarQube-URL und des Tokens über Umgebungsvariablen einen einfachen Austausch verschiedener SonarQube-Instanzen ohne Änderung des Codes.\n\n## Code-Qualitätsanalyse\n\nDa kein SonarQube-Bericht vorliegt, ist keine umfassende Analyse der Codequalität möglich. Abhängig von der Codestruktur und -funktionalität ergeben sich jedoch folgende potenzielle Problembereiche:\n\n* **Granularität der Fehlerbehandlung:** Obwohl eine Fehlerbehandlung vorhanden ist, könnten die spezifischen Fehlermeldungen verbessert werden, um dem Benutzer mehr verwertbare Informationen bereitzustellen.\n* **Testabdeckung:** Der bereitgestellte Code enthält keine Unit-Tests. Um die Zuverlässigkeit und Korrektheit des Codes sicherzustellen, sollte eine Testabdeckung hinzugefügt werden.\n* **Code-Duplizierung:** Es gibt möglicherweise Möglichkeiten, die Code-Duplizierung zu reduzieren, indem gemeinsame Logik in wiederverwendbare Funktionen oder Klassen extrahiert wird.\n\n## Schwächen und Verbesserungsbereiche\n\n* **Verbessern Sie die Klarheit der Fehlermeldungen:** Verbessern Sie die Fehlermeldungen, um den Benutzern spezifischere Anleitungen zur Problemlösung zu geben.\n* **Unit-Tests hinzufügen:** Implementieren Sie Unit-Tests für die serverseitigen Tools, um deren Richtigkeit und Zuverlässigkeit sicherzustellen.\n* **Gemeinsame Logik umgestalten:** Duplizierten Code identifizieren und in wiederverwendbare Funktionen oder Klassen umgestalten.\n* **Implementieren Sie eine Eingabevalidierung:** Fügen Sie den serverseitigen Tools eine Eingabevalidierung hinzu, um die Verarbeitung ungültiger Daten zu verhindern.\n* **Dokumentation verbessern:** Fügen Sie eine ausführlichere Dokumentation für die serverseitigen Tools hinzu, einschließlich Beispielen und Gebrauchsanweisungen.\n* **Implementieren Sie ein robustes Konfigurationssystem:** Erwägen Sie die Verwendung eines robusteren Konfigurationssystems, beispielsweise einer Konfigurationsdatei oder einer dedizierten Einstellungsklasse, anstatt sich ausschließlich auf Umgebungsvariablen zu verlassen.\n* **Unterstützung für zusätzliche SonarQube-API-Endpunkte hinzufügen:** Erweitern Sie das System, um zusätzliche SonarQube-API-Endpunkte zu unterstützen, z. B. solche zum Verwalten von Projekten, Regeln oder Qualitätsprofilen.\n* **Implementieren Sie eine benutzerfreundlichere Client-Schnittstelle:** Erwägen Sie die Entwicklung einer grafischen Benutzeroberfläche (GUI) oder einer anspruchsvolleren Befehlszeilenschnittstelle (CLI) für die Client-Anwendung.\n* **Beheben Sie potenzielle Sicherheitslücken:** Überprüfen Sie den Code auf potenzielle Sicherheitslücken, beispielsweise im Zusammenhang mit der Eingabevalidierung oder Authentifizierung.\n\n## Weitere Untersuchungsgebiete\n\n* **Leistungsengpässe:** Untersuchen Sie potenzielle Leistungsengpässe in den serverseitigen Tools, beispielsweise im Zusammenhang mit der API-Anforderungsverarbeitung oder der Datenverarbeitung.\n* **Überlegungen zur Skalierbarkeit:** Bewerten Sie die Skalierbarkeit des Systems und identifizieren Sie potenzielle Verbesserungsbereiche, z. B. die Verwendung einer Nachrichtenwarteschlange oder eines verteilten Caching-Systems.\n* **Integrationen mit externen Systemen:** Erkunden Sie mögliche Integrationen mit anderen Entwicklungstools, wie etwa CI/CD-Systemen oder Issue-Trackern.\n* **Erweiterte Funktionen:** Erforschen und implementieren Sie erweiterte Funktionen, wie etwa die Echtzeitüberwachung von Metriken oder die automatisierte Analyse der Codequalität.\n* **Code Smells und geringe Testabdeckung:** Führen Sie eine gründliche Analyse der Codebasis durch, um Code Smells und Bereiche mit geringer Testabdeckung zu identifizieren und zu beheben.\n\n## Namensnennung\n\nErstellt mit Unterstützung von [ArchAI](https://github.com/ArchAI-Labs/code_explainer) , einem automatisierten Dokumentationssystem.","German","tag","de-DE",{"_29":41,"_33":45,"_38":46},{"_31":42,"_33":43,"_35":44},"A server that provides tools for retrieving SonarQube project metrics and quality data through a simplified message-based approach, allowing users to programmatically access metrics, historical data, and component-level information from SonarQube.","FastMCP SonarQube Metrics","# FastMCP SonarQube Metrics\r\n\r\n![logo](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/logo.png)\r\n\r\n## Overview\r\n\r\nThis project provides a set of tools for retrieving information about SonarQube projects using the FastMCP (Fast Model Context Protocol) framework. It serves as an interface to SonarQube, allowing users to programmatically access metrics, historical data, and component tree metrics for specified projects. This automated access enables reporting, analysis, and integration of SonarQube data with other systems.\r\n\r\nThe project distinguishes itself by offering a simplified, message-based approach to interacting with the SonarQube API, abstracting away the complexities of direct API calls and data handling. It's designed for developers, DevOps engineers, and analysts who need to incorporate SonarQube data into their workflows or build custom reporting solutions.\r\n\r\nThis repository specifically houses the client and server components that facilitate communication and data retrieval. The server exposes tools to fetch data from SonarQube, while the client provides a command-line interface for users to invoke these tools and display the results. Each internal module contributes to this goal by encapsulating specific functionalities, such as API interaction, data processing, and client-server communication.\r\n\r\nThe client included in the project is only for testing how the code works; we recommend using [Claude Desktop](https://claude.ai/download) or developing your own custom client.\r\n\r\n> ***REMEMBER, THIS REPO IS WORK IN PROGRESS, SOME FEATURES MAY NOT BE PERFECT.***\r\n\r\n## Supported MCP Tools\r\n\r\n* `get_status`: Performs a health check on the configured SonarQube instance.\r\n* `list_projects`: Lists all accessible SonarQube projects, optionally filtered by name or key.\r\n* `get_sonarqube_metrics`: Retrieves specified metrics (bugs, vulnerabilities, code smells, coverage, duplication density) for a given SonarQube project key.\r\n* `get_sonarqube_metrics_history`: Retrieves historical metrics (bugs, vulnerabilities, code smells, coverage, duplication density) for a given SonarQube project using /api/measures/search_history. Optional date filters can be applied.\r\n* `get_sonarqube_component_tree_metrics`: Retrieves metric values for all components (e.g., files or directories) in a project using /api/measures/component_tree Automatically handles pagination to retrieve all results.\r\n* `get_project_issues`: Fetch SonarQube issues for a given project, optionally filtered by type, severity, and resolution status. Returns up to *limit* results (default: 10).\r\n\r\n## Technology Stack\r\n\r\n* **Language:** Python\r\n* **Frameworks:** FastMCP\r\n* **Libraries:** httpx, pydantic, dotenv, asyncio, json, pathlib, typing, base64\r\n* **Tools:** SonarQube API\r\n\r\n## Directory Structure\r\n\r\n```\r\n├── client_test.py - Client application for testing and interacting with the server.\r\n├── server.py - Server application exposing tools to retrieve SonarQube metrics.\r\n├── client_tool.py - Client with a graphical interface to interact with the SonarQube server.\r\n├── client_langchain.py - Command-line client to interact with the FastMCP server and SonarQube tools via LangChain\r\n├── .env - Environment configuration file (stores SonarQube URL and token).\r\n└── README.md - Project documentation.\r\n```\r\n\r\n## Getting Started\r\n\r\n### Prerequisites\r\n\r\n* Python 3.7+\r\n* SonarQube instance with API access\r\n* A SonarQube API token with appropriate permissions\r\n* FastMCP installed (`pip install fastmcp`)\r\n* httpx installed (`pip install httpx`)\r\n* pydantic installed (`pip install pydantic`)\r\n* python-dotenv installed (`pip install python-dotenv`)\r\n\r\n### General Build Steps\r\n\r\n1. **Clone the repository:** `git clone `\r\n2. **Navigate to the project directory:** `cd fastmcp-sonarqube-metrics`\r\n3. **Set up environment variables:** Create a `.env` file in the project root directory with the following content:\r\n\r\n ```\r\n SONARQUBE_URL=\r\n SONARQUBE_TOKEN=\r\n TRANSPORT=\r\n GEMINI_API_KEY=\r\n OPENAI_API_KEY=\r\n ```\r\n\r\n Replace `` with the URL of your SonarQube instance (e.g., `http://localhost:9000`) and `` with your SonarQube API token.\r\n4. **Run the server:** `python server.py`\r\n5. **Run the client:** `python client_test.py` *(Optionally, only for test)*\r\n6. **Connect to your client:** follow the [official documentation](https://modelcontextprotocol.io/quickstart/user#windows)\r\n\r\n### Module Usage\r\n\r\n#### Server (`server.py`)\r\n\r\nThe `server.py` module defines the FastMCP server that exposes tools for retrieving SonarQube metrics. It initializes the server, loads environment variables, defines the available tools, and handles communication with the SonarQube API. To use the server, you need to set the `SONARQUBE_URL` and `SONARQUBE_TOKEN` environment variables. The server is started by running the `server.py` script directly.\r\n\r\n#### Client (`client_test.py`)\r\n\r\nThe `client_test.py` module defines the FastMCP client that interacts with the server. It prompts the user for a SonarQube project key, connects to the server, invokes the `get_sonarqube_metrics` and `get_sonarqube_component_tree_metrics` tools, and displays the results. To use the client, you need to run the `client_test.py` script directly and provide a valid SonarQube project key when prompted.\r\n\r\n#### Client_tool (`client_tool.py`)\r\nThe `client_tool.py` module implements the FastMCP client with a Tkinter-based graphical interface to interact with the SonarQube server. On startup, it configures loggers to suppress non-essential messages, loads environment variables, and launches the chat backend (ChatBackend) in the background, which uses an LLM and the MCP tools exposed by the server via stdio. The frontend (ChatGUI) manages the Tkinter window, displays the message history in a scrollable area, and allows the user to send commands to the server—prompting for a valid SonarQube project key when needed. To use the client, simply run the `client_tool.py` script and interact through the GUI.\r\n\r\n#### Client_langchain (`client_langchain.py`)\r\nThe `client_langchain.py` module provides a command-line client to interact with the FastMCP server and SonarQube tools via LangChain. On startup, it loads environment variables, and configures the chosen LLM. It establishes a stdio connection to the server (`server.py`), initializes the MCP session, and loads available tools (health check, current and historical metrics, project listing, issue retrieval). A detailed system prompt describes each tool and its parameters. In an interactive loop, it reads user input from the console, updates the message history, invokes the React agent, and prints the formatted response.\r\n\r\n### Example: Integrating the `get_sonarqube_metrics` tool in an external project\r\n\r\nTo use the `get_sonarqube_metrics` tool in an external project, you can create a client that connects to the FastMCP server and invokes the tool. Here's a basic example:\r\n\r\n```python\r\nimport asyncio\r\nfrom fastmcp import Client\r\nfrom fastmcp.types import TextContent\r\n\r\nasync def get_metrics(project_key: str):\r\n server_path = \"server.py\" # Adjust if necessary\r\n client = Client(server_path)\r\n try:\r\n async with client:\r\n result = await client.call_tool(\r\n \"get_sonarqube_metrics\", {\"project_key\": project_key}\r\n )\r\n if result:\r\n content = result[0]\r\n if isinstance(content, TextContent):\r\n metrics = json.loads(content.text)\r\n print(metrics)\r\n except Exception as e:\r\n print(f\"Error: {e}\")\r\n\r\nif __name__ == \"__main__\":\r\n asyncio.run(get_metrics(\"your-project-key\")) # Replace with your project key\r\n```\r\n\r\nThis example demonstrates how to create a client, connect to the server, invoke the `get_sonarqube_metrics` tool with a project key, and process the results. You would need to adapt the `server_path` variable to the actual location of the `server.py` script in your environment.\r\n\r\n\r\n\r\n## ArchAI-SonarQube Chat (GUI)\r\n\r\nA lightweight Tkinter client that connects over stdio to the FastMCP server and exposes a real-time chat interface for querying SonarQube metrics, browsing component trees and running health checks via an LLM-driven assistant.\r\n\r\n
\r\n\r\n![img_tool](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/img_tool.png)\r\n\r\n
\r\n\r\n## Usage with TRANSPORT=SSE\r\nYou can switch the client’s transport layer to Server-Sent Events (SSE) by setting the `TRANSPORT` environment variable before launching the GUI. This enables real-time, uni-directional updates from the FastMCP server.\r\nWhen the server is started in SSE mode, a persistent HTTP connection is opened on port **8001**. This allows you to connect via compatible interfaces such as MCP Inspector.*\r\n\r\n1. **Start the server in SSE mode** \r\n ```bash\r\n uv run mcp dev \"\" \r\n ```\r\n2. **Open MCP Inspector**\r\n A link (e.g. `http://127.0.0.1:6274`) will be provided to launch MCP Inspector in your browser.\r\n3. **Configure SSE in MCP Inspector**\r\n\r\n * Select **SSE** as the transport type\r\n * Enter the URL: `http://localhost:8001/sse`\r\n\r\n4. **Initiate the connection**\r\n\r\n5. **Browse available tools**\r\n In the **Tools** section you will see:\r\n\r\n * `get_status`\r\n * `get_sonarqube_metrics`\r\n * `get_sonarqube_metrics_history`\r\n * `get_sonarqube_component_tree_metrics`\r\n * `list_projects`\r\n * `get_project_issues`\r\n\r\n6. **Select and invoke a tool**\r\n For example, choose **get\\_project\\_issues** and provide:\r\n\r\n * `project_key`: the SonarQube project key\r\n * `issue_type` (optional): e.g. `BUG`, `CODE_SMELL`\r\n * `severity` (optional): e.g. `MAJOR`, `CRITICAL`\r\n * `resolved` (optional): `true` or `false`\r\n * `limit` (optional): maximum number of issues to return\r\n\r\n7. **Execute and retrieve results**\r\n The server will call the appropriate SonarQube API and return a formatted JSON response.\r\n\r\n## Usage with Claude Desktop\r\n\r\nYou can install this server directly into Claude Desktop using fastmcp:\r\n\r\n1. Make sure FastMCP is installed (pip install fastmcp or uv pip install fastmcp).\r\n2. Configure Claude for Desktop for whichever MCP servers you want to use (in Windows using VSCode): `code $env:AppData\\Claude\\claude_desktop_config.json`\r\n3. Add your server and then save:\r\n\r\n```json\r\n{\r\n \"mcpServers\": {\r\n \"fastmcp-sonarqube-metrics\": {\r\n \"command\": \"uv\",\r\n \"args\": [\r\n \"--directory\",\r\n \"/ABSOLUTE/PATH/TO/PARENT/FOLDER/fastmcp-sonarqube-metrics\",\r\n \"run\",\r\n \"server.py\"\r\n ]\r\n }\r\n }\r\n}\r\n```\r\n\r\n4. To launch it by running:\r\n\r\n```bash\r\n uv --directory /ABSOLUTE/PATH/TO/PARENT/FOLDER/fastmcp-sonarqube-metrics run server.py\r\n```\r\n\r\n5. Restart Claude Desktop if it was running. The *\"FastMCP SonarQube Metrics\"* tool should now be available.\r\n\r\n
\r\n\r\n![claude](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/img_claude_desktop.png)\r\n\r\n
\r\n\r\n## Functional Analysis\r\n\r\n### 1. Main Responsibilities of the System\r\n\r\nThe system's primary responsibility is to act as a bridge between a user and the SonarQube API, providing a simplified way to retrieve project quality metrics. It encapsulates the complexities of the SonarQube API, offering a set of tools that can be easily invoked and integrated into automated workflows. The core services include fetching metrics, retrieving historical data, and exploring component-level metrics within a SonarQube project. The foundational service is the FastMCP server, which manages the tool definitions and client-server communication.\r\n\r\n### 2. Problems the System Solves\r\n\r\nThe system solves the problem of programmatically accessing SonarQube data without requiring users to directly interact with the SonarQube API. It addresses the need for automated reporting, analysis, and integration of SonarQube metrics with other systems. Specifically, it simplifies tasks such as:\r\n\r\n* Generating regular reports on code quality metrics.\r\n* Monitoring trends in code quality over time.\r\n* Identifying problematic components within a project.\r\n* Integrating SonarQube data with other development tools.\r\n\r\nThe architecture solves these problems by providing a set of well-defined tools that abstract away the complexities of the SonarQube API and provide a consistent interface for accessing data.\r\n\r\n### 3. Interaction of Modules and Components\r\n\r\nThe system consists of two main components: the client and the server. The client initiates requests to the server, specifying the tool to be executed and any input parameters. The server receives the request, interacts with the SonarQube API, processes the data, and sends the results back to the client.\r\n\r\nThe interaction between the client and server is facilitated by the FastMCP framework, which handles message passing and serialization. The server defines the available tools using the `@mcp.tool()` decorator, which registers the functions as callable endpoints. The client invokes these tools using the `client.call_tool()` method, which sends a message to the server with the tool name and input parameters.\r\n\r\nThe server uses the `httpx` library to make asynchronous HTTP requests to the SonarQube API. It constructs the API URLs and request parameters based on the tool being executed and the input parameters provided by the client. The server then parses the JSON responses from the SonarQube API and extracts the relevant metric values.\r\n\r\n### 4. User-Facing vs. System-Facing Functionalities\r\n\r\nThe user-facing functionality of the system is the client application (`client_test.py`), which provides a command-line interface for invoking the SonarQube metric retrieval tools. Users interact with the client by providing a SonarQube project key and, optionally, other parameters such as date ranges or metric keys. The client then displays the retrieved metrics in a human-readable format.\r\n\r\nThe system-facing functionalities are the server-side tools (`get_sonarqube_metrics`, `get_sonarqube_metrics_history`, `get_sonarqube_component_tree_metrics`) defined in `server.py`. These tools handle the interaction with the SonarQube API, data processing, and formatting. They are not directly visible to end-users but are essential for providing the core functionality of the system.\r\n\r\nThe `@mcp.tool()` decorator systematically applies common behaviors across all tool functions, ensuring they are registered with the FastMCP server and accessible to clients. Additionally, the use of `Annotated` and `Field` ensures consistent parameter definition and documentation across all tools.\r\n\r\n## Architectural Patterns and Design Principles Applied\r\n\r\n* **Client-Server Architecture:** The project follows a client-server architecture, where the client requests services from the server.\r\n* **Message Passing:** The FastMCP framework facilitates communication between the client and server using message passing.\r\n* **Asynchronous Programming:** The use of `asyncio` and `httpx` enables asynchronous operations, improving the performance and responsiveness of the application.\r\n* **Configuration via Environment Variables:** The SonarQube URL and token are configured using environment variables, making it easier to deploy and manage the application in different environments.\r\n* **Tool-Based Design:** The server exposes functionality through well-defined tools, making it easy to add or modify features.\r\n* **Error Handling:** The project includes comprehensive error handling to gracefully handle potential issues, such as network errors, API errors, and invalid data.\r\n* **Logging:** The use of the `logging` module provides detailed logs, aiding in debugging and monitoring.\r\n* **Dependency Injection:** While not explicitly implemented as a framework, the configuration of the SonarQube URL and token through environment variables allows for easy substitution of different SonarQube instances without modifying the code.\r\n\r\n## Code Quality Analysis\r\n\r\nDue to the lack of a SonarQube report, a comprehensive code quality analysis cannot be performed. However, based on the code structure and functionality, potential areas of concern include:\r\n\r\n* **Error Handling Granularity:** While error handling is present, the specific error messages could be improved to provide more actionable information to the user.\r\n* **Test Coverage:** The provided code does not include unit tests. Test coverage should be added to ensure the reliability and correctness of the code.\r\n* **Code Duplication:** There might be opportunities to reduce code duplication by extracting common logic into reusable functions or classes.\r\n\r\n## Weaknesses and Areas for Improvement\r\n\r\n* **Improve error message clarity:** Enhance error messages to provide more specific guidance to users on how to resolve issues.\r\n* **Add unit tests:** Implement unit tests for the server-side tools to ensure their correctness and reliability.\r\n* **Refactor common logic:** Identify and refactor duplicated code into reusable functions or classes.\r\n* **Implement input validation:** Add input validation to the server-side tools to prevent invalid data from being processed.\r\n* **Improve documentation:** Add more detailed documentation for the server-side tools, including examples and usage instructions.\r\n* **Implement a more robust configuration system:** Consider using a more robust configuration system, such as a configuration file or a dedicated settings class, instead of relying solely on environment variables.\r\n* **Add support for additional SonarQube API endpoints:** Extend the system to support additional SonarQube API endpoints, such as those for managing projects, rules, or quality profiles.\r\n* **Implement a more user-friendly client interface:** Consider developing a graphical user interface (GUI) or a more sophisticated command-line interface (CLI) for the client application.\r\n* **Address potential security vulnerabilities:** Review the code for potential security vulnerabilities, such as those related to input validation or authentication.\r\n\r\n## Further Areas of Investigation\r\n\r\n* **Performance Bottlenecks:** Investigate potential performance bottlenecks in the server-side tools, such as those related to API request handling or data processing.\r\n* **Scalability Considerations:** Evaluate the scalability of the system and identify potential areas for improvement, such as using a message queue or a distributed caching system.\r\n* **Integrations with External Systems:** Explore potential integrations with other development tools, such as CI/CD systems or issue trackers.\r\n* **Advanced Features:** Research and implement advanced features, such as real-time metric monitoring or automated code quality analysis.\r\n* **Code Smells and Low Test Coverage:** Conduct a thorough analysis of the codebase to identify and address code smells and areas with low test coverage.\r\n\r\n## Attribution\r\n\r\nGenerated with the support of [ArchAI](https://github.com/ArchAI-Labs/code_explainer), an automated documentation system.","English","en-US",{"_29":48,"_33":52,"_38":53},{"_31":49,"_33":50,"_35":51},"Un servidor que proporciona herramientas para recuperar métricas de proyectos y datos de calidad de SonarQube a través de un enfoque simplificado basado en mensajes, que permite a los usuarios acceder mediante programación a métricas, datos históricos e información a nivel de componentes de SonarQube.","Métricas de SonarQube de FastMCP","# Métricas de SonarQube de FastMCP\n\n![logo](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/logo.png)\n\n## Descripción general\n\nEste proyecto proporciona un conjunto de herramientas para recuperar información sobre proyectos de SonarQube mediante el marco FastMCP (Fast Model Context Protocol). Sirve como interfaz para SonarQube, permitiendo a los usuarios acceder programáticamente a métricas, datos históricos y métricas del árbol de componentes para proyectos específicos. Este acceso automatizado facilita la generación de informes, el análisis y la integración de los datos de SonarQube con otros sistemas.\n\nEl proyecto se distingue por ofrecer un enfoque simplificado y basado en mensajes para interactuar con la API de SonarQube, eliminando las complejidades de las llamadas directas a la API y la gestión de datos. Está diseñado para desarrolladores, ingenieros de DevOps y analistas que necesitan incorporar datos de SonarQube en sus flujos de trabajo o crear soluciones de informes personalizadas.\n\nEste repositorio alberga específicamente los componentes de cliente y servidor que facilitan la comunicación y la recuperación de datos. El servidor expone herramientas para obtener datos de SonarQube, mientras que el cliente proporciona una interfaz de línea de comandos para que los usuarios invoquen estas herramientas y muestren los resultados. Cada módulo interno contribuye a este objetivo al encapsular funcionalidades específicas, como la interacción con la API, el procesamiento de datos y la comunicación cliente-servidor.\n\nEl cliente incluido en el proyecto es solo para probar cómo funciona el código; recomendamos utilizar [Claude Desktop](https://claude.ai/download) o desarrollar su propio cliente personalizado.\n\n> ***RECUERDE, ESTE REPO ESTÁ EN PROGRESO, ALGUNAS CARACTERÍSTICAS PUEDEN NO SER PERFECTAS.***\n\n## Herramientas MCP compatibles\n\n* `get_status` : realiza una comprobación del estado de la instancia de SonarQube configurada.\n* `list_projects` : enumera todos los proyectos SonarQube accesibles, opcionalmente filtrados por nombre o clave.\n* `get_sonarqube_metrics` : recupera métricas especificadas (errores, vulnerabilidades, errores de código, cobertura, densidad de duplicación) para una clave de proyecto SonarQube determinada.\n* `get_sonarqube_metrics_history` : Recupera métricas históricas (errores, vulnerabilidades, errores de código, cobertura, densidad de duplicación) de un proyecto SonarQube mediante /api/measures/search\\_history. Se pueden aplicar filtros de fecha opcionales.\n* `get_sonarqube_component_tree_metrics` : recupera valores métricos para todos los componentes (por ejemplo, archivos o directorios) en un proyecto usando /api/measures/component\\_tree. Maneja automáticamente la paginación para recuperar todos los resultados.\n* `get_project_issues` : Obtiene los problemas de SonarQube de un proyecto determinado, con filtros opcionales por tipo, gravedad y estado de resolución. Devuelve un *límite* de resultados (predeterminado: 10).\n\n## Pila de tecnología\n\n* **Lenguaje:** Python\n* **Marcos:** FastMCP\n* **Bibliotecas:** httpx, pydantic, dotenv, asyncio, json, pathlib, mecanografía, base64\n* **Herramientas:** API de SonarQube\n\n## Estructura del directorio\n\n```\n├── client_test.py - Client application for testing and interacting with the server.\r\n├── server.py - Server application exposing tools to retrieve SonarQube metrics.\r\n├── client_tool.py - Client with a graphical interface to interact with the SonarQube server.\r\n├── client_langchain.py - Command-line client to interact with the FastMCP server and SonarQube tools via LangChain\r\n├── .env - Environment configuration file (stores SonarQube URL and token).\r\n└── README.md - Project documentation.\n```\n\n## Empezando\n\n### Prerrequisitos\n\n* Python 3.7+\n* Instancia de SonarQube con acceso a API\n* Un token de API de SonarQube con los permisos adecuados\n* FastMCP instalado ( `pip install fastmcp` )\n* httpx instalado ( `pip install httpx` )\n* Pydantic instalado ( `pip install pydantic` )\n* python-dotenv instalado ( `pip install python-dotenv` )\n\n### Pasos generales de construcción\n\n1. **Clonar el repositorio:** `git clone `\n\n2. **Navegue al directorio del proyecto:** `cd fastmcp-sonarqube-metrics`\n\n3. **Configurar variables de entorno:** Cree un archivo `.env` en el directorio raíz del proyecto con el siguiente contenido:\n\n ```\n SONARQUBE_URL=\r\n SONARQUBE_TOKEN=\r\n TRANSPORT=\r\n GEMINI_API_KEY=\r\n OPENAI_API_KEY=\n ```\n\n Reemplace `` con la URL de su instancia de SonarQube (por ejemplo, `http://localhost:9000` ) y `` con su token de API de SonarQube.\n\n4. **Ejecute el servidor:** `python server.py`\n\n5. **Ejecute el cliente:** `python client_test.py`*(opcional, solo para prueba)*\n\n6. **Conéctate con tu cliente:** sigue la [documentación oficial](https://modelcontextprotocol.io/quickstart/user#windows)\n\n### Uso del módulo\n\n#### Servidor ( `server.py` )\n\nEl módulo `server.py` define el servidor FastMCP que expone las herramientas para recuperar las métricas de SonarQube. Inicializa el servidor, carga las variables de entorno, define las herramientas disponibles y gestiona la comunicación con la API de SonarQube. Para usar el servidor, debe configurar las variables de entorno `SONARQUBE_URL` y `SONARQUBE_TOKEN` . El servidor se inicia ejecutando directamente el script `server.py` .\n\n#### Cliente ( `client_test.py` )\n\nEl módulo `client_test.py` define el cliente FastMCP que interactúa con el servidor. Solicita al usuario una clave de proyecto de SonarQube, se conecta al servidor, invoca las herramientas `get_sonarqube_metrics` y `get_sonarqube_component_tree_metrics` y muestra los resultados. Para usar el cliente, debe ejecutar el script `client_test.py` directamente y proporcionar una clave de proyecto de SonarQube válida cuando se le solicite.\n\n#### Herramienta\\_cliente ( `client_tool.py` )\n\nEl módulo `client_tool.py` implementa el cliente FastMCP con una interfaz gráfica basada en Tkinter para interactuar con el servidor SonarQube. Al iniciarse, configura los registradores para suprimir los mensajes innecesarios, carga las variables de entorno e inicia el backend de chat (ChatBackend) en segundo plano, que utiliza un LLM y las herramientas MCP expuestas por el servidor mediante stdio. El frontend (ChatGUI) gestiona la ventana de Tkinter, muestra el historial de mensajes en un área desplazable y permite al usuario enviar comandos al servidor, solicitando una clave de proyecto SonarQube válida cuando sea necesario. Para usar el cliente, simplemente ejecute el script `client_tool.py` e interactúe a través de la interfaz gráfica.\n\n#### Client\\_langchain ( `client_langchain.py` )\n\nEl módulo `client_langchain.py` proporciona un cliente de línea de comandos para interactuar con el servidor FastMCP y las herramientas de SonarQube a través de LangChain. Al iniciarse, carga las variables de entorno y configura el LLM seleccionado. Establece una conexión stdio con el servidor ( `server.py` ), inicializa la sesión de MCP y carga las herramientas disponibles (comprobación del estado, métricas actuales e históricas, listado de proyectos y recuperación de incidencias). Un indicador de sistema detallado describe cada herramienta y sus parámetros. En un bucle interactivo, lee la entrada del usuario desde la consola, actualiza el historial de mensajes, invoca el agente de React e imprime la respuesta formateada.\n\n### Ejemplo: Integración de la herramienta `get_sonarqube_metrics` en un proyecto externo\n\nPara usar la herramienta `get_sonarqube_metrics` en un proyecto externo, puede crear un cliente que se conecte al servidor FastMCP e invoque la herramienta. A continuación, se muestra un ejemplo básico:\n\n```python\nimport asyncio\r\nfrom fastmcp import Client\r\nfrom fastmcp.types import TextContent\r\n\r\nasync def get_metrics(project_key: str):\r\n server_path = \"server.py\" # Adjust if necessary\r\n client = Client(server_path)\r\n try:\r\n async with client:\r\n result = await client.call_tool(\r\n \"get_sonarqube_metrics\", {\"project_key\": project_key}\r\n )\r\n if result:\r\n content = result[0]\r\n if isinstance(content, TextContent):\r\n metrics = json.loads(content.text)\r\n print(metrics)\r\n except Exception as e:\r\n print(f\"Error: {e}\")\r\n\r\nif __name__ == \"__main__\":\r\n asyncio.run(get_metrics(\"your-project-key\")) # Replace with your project key\n```\n\nEste ejemplo muestra cómo crear un cliente, conectarse al servidor, invocar la herramienta `get_sonarqube_metrics` con una clave de proyecto y procesar los resultados. Deberá adaptar la variable `server_path` a la ubicación real del script `server.py` en su entorno.\n\n## Chat de ArchAI-SonarQube (GUI)\n\nUn cliente Tkinter liviano que se conecta a través de stdio al servidor FastMCP y expone una interfaz de chat en tiempo real para consultar métricas de SonarQube, explorar árboles de componentes y ejecutar controles de estado a través de un asistente controlado por LLM.\n\n![herramienta img](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/img_tool.png)\n\n## Uso con TRANSPORT=SSE\n\nPuede cambiar la capa de transporte del cliente a Eventos Enviados por el Servidor (SSE) configurando la variable de entorno `TRANSPORT` antes de iniciar la interfaz gráfica de usuario. Esto permite actualizaciones unidireccionales en tiempo real desde el servidor FastMCP. Al iniciar el servidor en modo SSE, se abre una conexión HTTP persistente en el puerto **8001.** Esto permite la conexión mediante interfaces compatibles como MCP Inspector.\\*\n\n1. **Iniciar el servidor en modo SSE**\n\n ```bash\n uv run mcp dev \"\" \n ```\n\n2. **Abrir MCP InspectorSe** proporcionará un enlace (por ejemplo, `http://127.0.0.1:6274` ) para iniciar MCP Inspector en su navegador.\n\n3. **Configurar SSE en MCP Inspector**\n\n * Seleccione **SSE** como tipo de transporte\n * Introduzca la URL: `http://localhost:8001/sse`\n\n4. **Iniciar la conexión**\n\n5. **Explorar las herramientas disponibles** En la sección **Herramientas** verás:\n\n * `get_status`\n * `get_sonarqube_metrics`\n * `get_sonarqube_metrics_history`\n * `get_sonarqube_component_tree_metrics`\n * `list_projects`\n * `get_project_issues`\n\n6. **Seleccionar e invocar una herramienta.** Por ejemplo, elija **get\\_project\\_issues** y proporcione:\n\n * `project_key` : la clave del proyecto SonarQube\n * `issue_type` (opcional): p. ej. `BUG` , `CODE_SMELL`\n * `severity` (opcional): p. ej. `MAJOR` , `CRITICAL`\n * `resolved` (opcional): `true` o `false`\n * `limit` (opcional): número máximo de problemas a devolver\n\n7. **Ejecutar y recuperar resultados** El servidor llamará a la API de SonarQube adecuada y devolverá una respuesta JSON formateada.\n\n## Uso con Claude Desktop\n\nPuede instalar este servidor directamente en Claude Desktop usando fastmcp:\n\n1. Asegúrese de que FastMCP esté instalado (pip install fastmcp o uv pip install fastmcp).\n2. Configure Claude for Desktop para cualquier servidor MCP que desee utilizar (en Windows usando VSCode): `code $env:AppData\\Claude\\claude_desktop_config.json`\n3. Añade tu servidor y luego guarda:\n\n```json\n{\r\n \"mcpServers\": {\r\n \"fastmcp-sonarqube-metrics\": {\r\n \"command\": \"uv\",\r\n \"args\": [\r\n \"--directory\",\r\n \"/ABSOLUTE/PATH/TO/PARENT/FOLDER/fastmcp-sonarqube-metrics\",\r\n \"run\",\r\n \"server.py\"\r\n ]\r\n }\r\n }\r\n}\n```\n\n4. Para iniciarlo ejecute:\n\n```bash\n uv --directory /ABSOLUTE/PATH/TO/PARENT/FOLDER/fastmcp-sonarqube-metrics run server.py\n```\n\n5. Reinicie Claude Desktop si estaba en ejecución. La herramienta *\"Métricas de FastMCP SonarQube\"* debería estar disponible.\n\n![claudio](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/img_claude_desktop.png)\n\n## Análisis funcional\n\n### 1. Principales responsabilidades del sistema\n\nLa principal responsabilidad del sistema es servir de puente entre el usuario y la API de SonarQube, ofreciendo una forma simplificada de obtener métricas de calidad del proyecto. Encapsula las complejidades de la API de SonarQube, ofreciendo un conjunto de herramientas que se pueden invocar e integrar fácilmente en flujos de trabajo automatizados. Los servicios principales incluyen la obtención de métricas, la recuperación de datos históricos y la exploración de métricas a nivel de componente dentro de un proyecto de SonarQube. El servicio fundamental es el servidor FastMCP, que gestiona las definiciones de herramientas y la comunicación cliente-servidor.\n\n### 2. Problemas que resuelve el sistema\n\nEl sistema resuelve el problema del acceso programático a los datos de SonarQube sin necesidad de que los usuarios interactúen directamente con la API de SonarQube. Atiende la necesidad de generar informes, analizar e integrar métricas de SonarQube con otros sistemas de forma automatizada. En concreto, simplifica tareas como:\n\n* Generar informes periódicos sobre métricas de calidad del código.\n* Monitoreo de tendencias en la calidad del código a lo largo del tiempo.\n* Identificar componentes problemáticos dentro de un proyecto.\n* Integración de datos de SonarQube con otras herramientas de desarrollo.\n\nLa arquitectura resuelve estos problemas al proporcionar un conjunto de herramientas bien definidas que abstraen las complejidades de la API de SonarQube y proporcionan una interfaz consistente para acceder a los datos.\n\n### 3. Interacción de módulos y componentes\n\nEl sistema consta de dos componentes principales: el cliente y el servidor. El cliente inicia las solicitudes al servidor, especificando la herramienta que se ejecutará y los parámetros de entrada. El servidor recibe la solicitud, interactúa con la API de SonarQube, procesa los datos y envía los resultados al cliente.\n\nLa interacción entre el cliente y el servidor se facilita mediante el framework FastMCP, que gestiona el paso de mensajes y la serialización. El servidor define las herramientas disponibles mediante el decorador `@mcp.tool()` , que registra las funciones como puntos finales invocables. El cliente invoca estas herramientas mediante el método `client.call_tool()` , que envía un mensaje al servidor con el nombre de la herramienta y los parámetros de entrada.\n\nEl servidor utiliza la biblioteca `httpx` para realizar solicitudes HTTP asíncronas a la API de SonarQube. Construye las URL de la API y los parámetros de solicitud según la herramienta que se ejecuta y los parámetros de entrada proporcionados por el cliente. A continuación, el servidor analiza las respuestas JSON de la API de SonarQube y extrae los valores de las métricas relevantes.\n\n### 4. Funcionalidades orientadas al usuario vs. funcionalidades orientadas al sistema\n\nLa funcionalidad del sistema orientada al usuario es la aplicación cliente ( `client_test.py` ), que proporciona una interfaz de línea de comandos para invocar las herramientas de recuperación de métricas de SonarQube. Los usuarios interactúan con el cliente proporcionando una clave de proyecto de SonarQube y, opcionalmente, otros parámetros como rangos de fechas o claves de métricas. El cliente muestra las métricas recuperadas en un formato legible.\n\nLas funcionalidades del sistema son las herramientas del servidor ( `get_sonarqube_metrics` , `get_sonarqube_metrics_history` , `get_sonarqube_component_tree_metrics` ) definidas en `server.py` . Estas herramientas gestionan la interacción con la API de SonarQube, el procesamiento y el formato de los datos. No son visibles directamente para los usuarios finales, pero son esenciales para proporcionar la funcionalidad principal del sistema.\n\nEl decorador `@mcp.tool()` aplica sistemáticamente comportamientos comunes en todas las funciones de la herramienta, garantizando que se registren en el servidor FastMCP y sean accesibles para los clientes. Además, el uso de `Annotated` y `Field` garantiza la coherencia en la definición y documentación de parámetros en todas las herramientas.\n\n## Patrones arquitectónicos y principios de diseño aplicados\n\n* **Arquitectura Cliente-Servidor:** El proyecto sigue una arquitectura cliente-servidor, donde el cliente solicita servicios al servidor.\n* **Paso de mensajes:** el marco FastMCP facilita la comunicación entre el cliente y el servidor mediante el paso de mensajes.\n* **Programación asincrónica:** El uso de `asyncio` y `httpx` permite operaciones asincrónicas, mejorando el rendimiento y la capacidad de respuesta de la aplicación.\n* **Configuración mediante variables de entorno:** la URL y el token de SonarQube se configuran mediante variables de entorno, lo que facilita la implementación y la administración de la aplicación en diferentes entornos.\n* **Diseño basado en herramientas:** el servidor expone la funcionalidad a través de herramientas bien definidas, lo que facilita agregar o modificar funciones.\n* **Manejo de errores:** el proyecto incluye un manejo de errores integral para manejar con elegancia posibles problemas, como errores de red, errores de API y datos no válidos.\n* **Registro:** el uso del módulo `logging` proporciona registros detallados, lo que ayuda en la depuración y la supervisión.\n* **Inyección de dependencia:** si bien no se implementa explícitamente como marco, la configuración de la URL y el token de SonarQube a través de variables de entorno permite una fácil sustitución de diferentes instancias de SonarQube sin modificar el código.\n\n## Análisis de la calidad del código\n\nDebido a la falta de un informe de SonarQube, no es posible realizar un análisis exhaustivo de la calidad del código. Sin embargo, según la estructura y la funcionalidad del código, las posibles áreas de preocupación incluyen:\n\n* **Granularidad en el manejo de errores:** si bien el manejo de errores está presente, los mensajes de error específicos podrían mejorarse para brindar información más útil al usuario.\n* **Cobertura de pruebas:** El código proporcionado no incluye pruebas unitarias. Se debe añadir cobertura de pruebas para garantizar la fiabilidad y la corrección del código.\n* **Duplicación de código:** puede haber oportunidades para reducir la duplicación de código extrayendo lógica común en funciones o clases reutilizables.\n\n## Debilidades y áreas de mejora\n\n* **Mejorar la claridad de los mensajes de error:** mejore los mensajes de error para brindar orientación más específica a los usuarios sobre cómo resolver problemas.\n* **Agregar pruebas unitarias:** implemente pruebas unitarias para las herramientas del lado del servidor para garantizar su corrección y confiabilidad.\n* **Refactorizar la lógica común:** identificar y refactorizar el código duplicado en funciones o clases reutilizables.\n* **Implementar la validación de entrada:** agregue la validación de entrada a las herramientas del lado del servidor para evitar que se procesen datos no válidos.\n* **Mejorar la documentación:** agregue documentación más detallada para las herramientas del lado del servidor, incluidos ejemplos e instrucciones de uso.\n* **Implemente un sistema de configuración más sólido:** considere utilizar un sistema de configuración más sólido, como un archivo de configuración o una clase de configuración dedicada, en lugar de confiar únicamente en variables de entorno.\n* **Agregar soporte para puntos finales de API de SonarQube adicionales:** amplíe el sistema para admitir puntos finales de API de SonarQube adicionales, como aquellos para administrar proyectos, reglas o perfiles de calidad.\n* **Implementar una interfaz de cliente más fácil de usar:** considere desarrollar una interfaz gráfica de usuario (GUI) o una interfaz de línea de comandos (CLI) más sofisticada para la aplicación cliente.\n* **Abordar posibles vulnerabilidades de seguridad:** revise el código para detectar posibles vulnerabilidades de seguridad, como aquellas relacionadas con la validación de entrada o la autenticación.\n\n## Otras áreas de investigación\n\n* **Cuellos de botella de rendimiento:** investigue posibles cuellos de botella de rendimiento en las herramientas del lado del servidor, como aquellos relacionados con el manejo de solicitudes de API o el procesamiento de datos.\n* **Consideraciones de escalabilidad:** evalúe la escalabilidad del sistema e identifique áreas potenciales de mejora, como el uso de una cola de mensajes o un sistema de almacenamiento en caché distribuido.\n* **Integraciones con sistemas externos:** explore posibles integraciones con otras herramientas de desarrollo, como sistemas CI/CD o rastreadores de problemas.\n* **Funciones avanzadas:** investigue e implemente funciones avanzadas, como monitoreo de métricas en tiempo real o análisis automatizado de la calidad del código.\n* **Olores de código y baja cobertura de pruebas:** realice un análisis exhaustivo de la base de código para identificar y abordar olores de código y áreas con baja cobertura de pruebas.\n\n## Atribución\n\nGenerado con el apoyo de [ArchAI](https://github.com/ArchAI-Labs/code_explainer) , un sistema de documentación automatizado.","Spanish","es-ES",{"_29":55,"_33":59,"_38":60},{"_31":56,"_33":57,"_35":58},"簡素化されたメッセージベースのアプローチを通じて SonarQube プロジェクトメトリックと品質データを取得するためのツールを提供するサーバー。これにより、ユーザーはプログラムを使用して SonarQube からメトリック、履歴データ、コンポーネントレベルの情報にアクセスできるようになります。","FastMCP SonarQube メトリクス","# FastMCP SonarQube メトリクス\n\n![ロゴ](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/logo.png)\n\n## 概要\n\nこのプロジェクトは、FastMCP（Fast Model Context Protocol）フレームワークを用いてSonarQubeプロジェクトに関する情報を取得するためのツールセットを提供します。これはSonarQubeへのインターフェースとして機能し、ユーザーは特定のプロジェクトのメトリクス、履歴データ、コンポーネントツリーメトリクスにプログラムからアクセスできるようになります。この自動アクセスにより、SonarQubeデータのレポート作成、分析、および他のシステムとの統合が可能になります。\n\nこのプロジェクトの特徴は、SonarQube APIとのやり取りに、簡素化されたメッセージベースのアプローチを提供することです。これにより、直接的なAPI呼び出しやデータ処理の複雑さが抽象化されます。SonarQubeデータをワークフローに組み込んだり、カスタムレポートソリューションを構築したりする必要がある開発者、DevOpsエンジニア、アナリスト向けに設計されています。\n\nこのリポジトリには、通信とデータ取得を容易にするクライアントコンポーネントとサーバーコンポーネントが具体的に格納されています。サーバーはSonarQubeからデータを取得するためのツールを公開し、クライアントはユーザーがこれらのツールを起動して結果を表示するためのコマンドラインインターフェースを提供します。各内部モジュールは、APIインタラクション、データ処理、クライアント・サーバー間通信といった特定の機能をカプセル化することで、この目標に貢献しています。\n\nプロジェクトに含まれているクライアントは、コードの動作をテストするためだけのものです。Claude [Desktop](https://claude.ai/download)を使用するか、独自のカスタムクライアントを開発することをお勧めします。\n\n> ***このリポジトリは現在開発中であり、一部の機能は完璧ではない可能性があることに留意してください。***\n\n## サポートされているMCPツール\n\n* `get_status` : 構成された SonarQube インスタンスのヘルスチェックを実行します。\n* `list_projects` : アクセス可能なすべての SonarQube プロジェクトを一覧表示します。オプションで名前またはキーでフィルタリングできます。\n* `get_sonarqube_metrics` : 指定された SonarQube プロジェクトキーの指定されたメトリック (バグ、脆弱性、コード臭、カバレッジ、重複密度) を取得します。\n* `get_sonarqube_metrics_history` : /api/measures/search\\_history を使用して、指定されたSonarQubeプロジェクトの履歴メトリクス（バグ、脆弱性、コードスメル、カバレッジ、重複密度）を取得します。オプションで日付フィルターを適用できます。\n* `get_sonarqube_component_tree_metrics` : /api/measures/component\\_tree を使用して、プロジェクト内のすべてのコンポーネント (ファイルやディレクトリなど) のメトリック値を取得します。すべての結果を取得するためにページ区切りを自動的に処理します。\n* `get_project_issues` : 指定されたプロジェクトのSonarQubeの問題を取得します。オプションで、種類、重大度、解決状況でフィルタリングできます。最大で*limit件*（デフォルト：10件）まで結果を返します。\n\n## テクノロジースタック\n\n* **言語:** Python\n* **フレームワーク:** FastMCP\n* **ライブラリ:** httpx、pydantic、dotenv、asyncio、json、pathlib、typing、base64\n* **ツール:** SonarQube API\n\n## ディレクトリ構造\n\n```\n├── client_test.py - Client application for testing and interacting with the server.\r\n├── server.py - Server application exposing tools to retrieve SonarQube metrics.\r\n├── client_tool.py - Client with a graphical interface to interact with the SonarQube server.\r\n├── client_langchain.py - Command-line client to interact with the FastMCP server and SonarQube tools via LangChain\r\n├── .env - Environment configuration file (stores SonarQube URL and token).\r\n└── README.md - Project documentation.\n```\n\n## はじめる\n\n### 前提条件\n\n* Python 3.7以上\n* APIアクセスを備えたSonarQubeインスタンス\n* 適切な権限を持つSonarQube APIトークン\n* FastMCP がインストールされている ( `pip install fastmcp` )\n* httpx がインストールされている ( `pip install httpx` )\n* pydantic がインストールされました ( `pip install pydantic` )\n* python-dotenv がインストールされている ( `pip install python-dotenv` )\n\n### 一般的なビルド手順\n\n1. **リポジトリをクローンします:** `git clone `\n\n2. **プロジェクトディレクトリに移動します:** `cd fastmcp-sonarqube-metrics`\n\n3. \\*\\*環境変数を設定します。\\*\\*プロジェクトのルートディレクトリに次の内容の`.env`ファイルを作成します。\n\n ```\n SONARQUBE_URL=\r\n SONARQUBE_TOKEN=\r\n TRANSPORT=\r\n GEMINI_API_KEY=\r\n OPENAI_API_KEY=\n ```\n\n `` SonarQube インスタンスの URL (例: `http://localhost:9000` ) に置き換え、 `` SonarQube API トークンに置き換えます。\n\n4. **サーバーを実行します:** `python server.py`\n\n5. **クライアントを実行します:** `python client_test.py`*(オプション、テストのみ)*\n\n6. **クライアントに接続します。**[公式ドキュメント](https://modelcontextprotocol.io/quickstart/user#windows)に従ってください。\n\n### モジュールの使用\n\n#### サーバー ( `server.py` )\n\n`server.py`モジュールは、SonarQube メトリクスを取得するためのツールを公開する FastMCP サーバーを定義します。このモジュールは、サーバーの初期化、環境変数の読み込み、利用可能なツールの定義、そして SonarQube API との通信を処理します。サーバーを使用するには、環境変数`SONARQUBE_URL`と`SONARQUBE_TOKEN`を設定する必要があります。サーバーは、 `server.py`スクリプトを直接実行することで起動します。\n\n#### クライアント ( `client_test.py` )\n\n`client_test.py`モジュールは、サーバーとやり取りする FastMCP クライアントを定義します。このモジュールは、ユーザーに SonarQube プロジェクトキーの入力を求め、サーバーに接続し、 `get_sonarqube_metrics`および`get_sonarqube_component_tree_metrics`ツールを呼び出して結果を表示します。クライアントを使用するには、 `client_test.py`スクリプトを直接実行し、プロンプトが表示されたら有効な SonarQube プロジェクトキーを入力する必要があります。\n\n#### クライアントツール ( `client_tool.py` )\n\n`client_tool.py`モジュールは、SonarQube サーバーと対話するための Tkinter ベースのグラフィカルインターフェースを備えた FastMCP クライアントを実装します。起動時に、ロガーを設定して不要なメッセージを抑制し、環境変数を読み込み、バックグラウンドでチャットバックエンド (ChatBackend) を起動します。チャットバックエンドは、LLM とサーバーが stdio 経由で公開する MCP ツールを使用します。フロントエンド (ChatGUI) は、Tkinter ウィンドウを管理し、スクロール可能な領域にメッセージ履歴を表示し、ユーザーがサーバーにコマンドを送信できるようにします。必要に応じて、有効な SonarQube プロジェクトキーの入力を求めます。クライアントを使用するには、 `client_tool.py`スクリプトを実行し、GUI を介して対話するだけです。\n\n#### クライアント言語チェーン ( `client_langchain.py` )\n\n`client_langchain.py`モジュールは、LangChain を介して FastMCP サーバーおよび SonarQube ツールと対話するためのコマンドラインクライアントを提供します。起動時に環境変数を読み込み、選択された LLM を設定します。サーバー ( `server.py` ) への標準入出力接続を確立し、MCP セッションを初期化し、利用可能なツール (ヘルスチェック、現在および過去のメトリクス、プロジェクト一覧、課題取得) を読み込みます。詳細なシステムプロンプトが各ツールとそのパラメータを説明します。対話型ループでは、コンソールからのユーザー入力を読み取り、メッセージ履歴を更新し、React エージェントを起動し、フォーマットされたレスポンスを出力します。\n\n### 例: `get_sonarqube_metrics`ツールを外部プロジェクトに統合する\n\n外部プロジェクトで`get_sonarqube_metrics`ツールを使用するには、FastMCP サーバーに接続してツールを呼び出すクライアントを作成します。基本的な例を以下に示します。\n\n```python\nimport asyncio\r\nfrom fastmcp import Client\r\nfrom fastmcp.types import TextContent\r\n\r\nasync def get_metrics(project_key: str):\r\n server_path = \"server.py\" # Adjust if necessary\r\n client = Client(server_path)\r\n try:\r\n async with client:\r\n result = await client.call_tool(\r\n \"get_sonarqube_metrics\", {\"project_key\": project_key}\r\n )\r\n if result:\r\n content = result[0]\r\n if isinstance(content, TextContent):\r\n metrics = json.loads(content.text)\r\n print(metrics)\r\n except Exception as e:\r\n print(f\"Error: {e}\")\r\n\r\nif __name__ == \"__main__\":\r\n asyncio.run(get_metrics(\"your-project-key\")) # Replace with your project key\n```\n\nこの例では、クライアントを作成し、サーバーに接続し、プロジェクトキーを指定して`get_sonarqube_metrics`ツールを起動し、結果を処理する方法を示します。server\\_path `server_path`は、お使いの環境における`server.py`スクリプトの実際の場所に合わせて変更する必要があります。\n\n## ArchAI-SonarQube チャット (GUI)\n\nstdio 経由で FastMCP サーバーに接続し、SonarQube メトリックのクエリ、コンポーネントツリーの参照、LLM 駆動アシスタントによるヘルスチェックの実行を行うためのリアルタイムチャットインターフェイスを公開する軽量の Tkinter クライアントです。\n\n![画像ツール](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/img_tool.png)\n\n## TRANSPORT=SSE での使用\n\nGUIを起動する前に`TRANSPORT`環境変数を設定することで、クライアントのトランスポート層をServer-Sent Events（SSE）に切り替えることができます。これにより、FastMCPサーバーからのリアルタイムの単方向更新が可能になります。サーバーがSSEモードで起動すると、ポート**8001**で永続的なHTTP接続が開かれます。これにより、MCP Inspectorなどの互換性のあるインターフェースを介して接続できるようになります。\\*\n\n1. **SSEモードでサーバーを起動する**\n\n ```bash\n uv run mcp dev \"\" \n ```\n\n2. **MCP Inspector を開きます**。ブラウザで MCP Inspector を起動するためのリンク (例: `http://127.0.0.1:6274` ) が提供されます。\n\n3. **MCP InspectorでSSEを構成する**\n\n * トランスポートタイプとして**SSE**を選択\n * URLを入力してください: `http://localhost:8001/sse`\n\n4. **接続を開始する**\n\n5. **利用可能なツールを参照する** **ツール**セクションには次のものが表示されます。\n\n * `get_status`\n * `get_sonarqube_metrics`\n * `get_sonarqube_metrics_history`\n * `get_sonarqube_component_tree_metrics`\n * `list_projects`\n * `get_project_issues`\n\n6. **ツールを選択して呼び出します**。たとえば、 **get\\_project\\_issues**を選択し、以下を入力します。\n\n * `project_key` : SonarQube プロジェクトキー\n * `issue_type` （オプション）: 例： `BUG` 、 `CODE_SMELL`\n * `severity` （オプション）: 例： `MAJOR` 、 `CRITICAL`\n * `resolved` （オプション）: `true`または`false`\n * `limit` (オプション): 返される問題の最大数\n\n7. \\*\\*実行して結果を取得します。\\*\\*サーバーは適切な SonarQube API を呼び出し、フォーマットされた JSON 応答を返します。\n\n## Claude Desktopでの使用\n\nfastmcp を使用してこのサーバーを Claude Desktop に直接インストールできます。\n\n1. FastMCP がインストールされていることを確認します (pip install fastmcp または uv pip install fastmcp)。\n2. 使用する MCP サーバーに合わせて Claude for Desktop を構成します (Windows では VSCode を使用)。 `code $env:AppData\\Claude\\claude_desktop_config.json`\n3. サーバーを追加して保存します。\n\n```json\n{\r\n \"mcpServers\": {\r\n \"fastmcp-sonarqube-metrics\": {\r\n \"command\": \"uv\",\r\n \"args\": [\r\n \"--directory\",\r\n \"/ABSOLUTE/PATH/TO/PARENT/FOLDER/fastmcp-sonarqube-metrics\",\r\n \"run\",\r\n \"server.py\"\r\n ]\r\n }\r\n }\r\n}\n```\n\n4. 起動するには以下を実行します:\n\n```bash\n uv --directory /ABSOLUTE/PATH/TO/PARENT/FOLDER/fastmcp-sonarqube-metrics run server.py\n```\n\n5. Claude Desktop が起動している場合は再起動してください。 \\*「FastMCP SonarQube Metrics」\\*ツールが利用可能になっているはずです。\n\n![クロード](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/img_claude_desktop.png)\n\n## 機能解析\n\n### 1. システムの主な責任\n\nこのシステムの主な役割は、ユーザーとSonarQube APIの橋渡し役として機能し、プロジェクトの品質メトリクスを簡略化して取得できるようにすることです。SonarQube APIの複雑な機能をカプセル化し、自動化されたワークフローに簡単に呼び出して統合できるツールセットを提供します。コアサービスには、メトリクスの取得、履歴データの取得、SonarQubeプロジェクト内のコンポーネントレベルのメトリクスの探索などが含まれます。基盤となるサービスはFastMCPサーバーであり、ツール定義とクライアント・サーバー間通信を管理します。\n\n### 2. システムが解決する問題\n\nこのシステムは、ユーザーがSonarQube APIを直接操作することなく、プログラムからSonarQubeデータにアクセスするという問題を解決します。SonarQubeメトリクスの自動レポート作成、分析、および他のシステムとの統合といったニーズに対応します。具体的には、以下のようなタスクを簡素化します。\n\n* コード品質メトリックに関する定期的なレポートを生成します。\n* コード品質の傾向を時間の経過とともに監視します。\n* プロジェクト内の問題のあるコンポーネントを特定します。\n* SonarQube データを他の開発ツールと統合します。\n\nこのアーキテクチャは、SonarQube API の複雑さを抽象化し、データにアクセスするための一貫したインターフェースを提供する、明確に定義された一連のツールを提供することで、これらの問題を解決します。\n\n### 3. モジュールとコンポーネントの相互作用\n\nこのシステムは、クライアントとサーバーという2つの主要コンポーネントで構成されています。クライアントは、実行するツールと入力パラメータを指定してサーバーにリクエストを送信します。サーバーはリクエストを受信し、SonarQube APIと連携してデータを処理し、結果をクライアントに返します。\n\nクライアントとサーバー間のやり取りは、メッセージの受け渡しとシリアル化を処理するFastMCPフレームワークによって促進されます。サーバーは、利用可能なツールを`@mcp.tool()`デコレータで定義し、関数を呼び出し可能なエンドポイントとして登録します。クライアントは`client.call_tool()`メソッドを使用してこれらのツールを呼び出します。このメソッドは、ツール名と入力パラメータを含むメッセージをサーバーに送信します。\n\nサーバーは`httpx`ライブラリを使用して、SonarQube APIへの非同期HTTPリクエストを送信します。実行中のツールとクライアントから提供された入力パラメータに基づいて、API URLとリクエストパラメータを構築します。その後、サーバーはSonarQube APIからのJSONレスポンスを解析し、関連するメトリック値を抽出します。\n\n### 4. ユーザー向け機能とシステム向け機能\n\nシステムのユーザー向け機能はクライアントアプリケーション（ `client_test.py` ）であり、SonarQubeのメトリクス取得ツールを呼び出すためのコマンドラインインターフェースを提供します。ユーザーは、SonarQubeプロジェクトキーと、必要に応じて日付範囲やメトリクスキーなどのパラメータを指定してクライアントと対話します。クライアントは取得したメトリクスを人間が読める形式で表示します。\n\nシステム関連の機能は、 `server.py`で定義されているサーバー側ツール（ `get_sonarqube_metrics` 、 `get_sonarqube_metrics_history` 、 `get_sonarqube_component_tree_metrics` ）です。これらのツールは、SonarQube APIとのやり取り、データ処理、フォーマット処理を行います。エンドユーザーには直接表示されませんが、システムのコア機能を提供するために不可欠です。\n\n`@mcp.tool()`デコレータは、すべてのツール関数に共通の動作を体系的に適用し、それらが FastMCP サーバーに登録され、クライアントからアクセスできるようにします。さらに、 `Annotated`と`Field`を使用することで、すべてのツール間で一貫したパラメータ定義とドキュメントが確保されます。\n\n## 適用されたアーキテクチャパターンと設計原則\n\n* \\*\\*クライアントサーバーアーキテクチャ:\\*\\*このプロジェクトは、クライアントがサーバーからサービスを要求するクライアントサーバーアーキテクチャに従います。\n* **メッセージパッシング:** FastMCP フレームワークは、メッセージパッシングを使用してクライアントとサーバー間の通信を容易にします。\n* **非同期プログラミング:** `asyncio`と`httpx`を使用すると非同期操作が可能になり、アプリケーションのパフォーマンスと応答性が向上します。\n* **環境変数による構成:** SonarQube の URL とトークンは環境変数を使用して構成されるため、さまざまな環境でのアプリケーションの展開と管理が容易になります。\n* \\*\\*ツールベースの設計:\\*\\*サーバーは明確に定義されたツールを通じて機能を公開するため、機能の追加や変更が容易になります。\n* \\*\\*エラー処理:\\*\\*このプロジェクトには、ネットワークエラー、API エラー、無効なデータなどの潜在的な問題を適切に処理するための包括的なエラー処理が含まれています。\n* **ログ記録:** `logging`モジュールを使用すると詳細なログが提供され、デバッグと監視に役立ちます。\n* \\*\\*依存性注入:\\*\\*フレームワークとして明示的に実装されていませんが、環境変数を介して SonarQube URL とトークンを構成すると、コードを変更せずに異なる SonarQube インスタンスを簡単に置き換えることができます。\n\n## コード品質分析\n\nSonarQubeレポートがないため、包括的なコード品質分析は実施できません。ただし、コードの構造と機能に基づくと、潜在的な懸念事項として以下が挙げられます。\n\n* \\*\\*エラー処理の細分性:\\*\\*エラー処理は存在しますが、特定のエラーメッセージを改善して、ユーザーにさらに実用的な情報を提供できます。\n* \\*\\*テストカバレッジ：\\*\\*提供されたコードにはユニットテストが含まれていません。コードの信頼性と正確性を確保するために、テストカバレッジを追加する必要があります。\n* \\*\\*コードの重複:\\*\\*共通ロジックを再利用可能な関数またはクラスに抽出することで、コードの重複を削減できる可能性があります。\n\n## 弱点と改善点\n\n* \\*\\*エラーメッセージの明確さを向上:\\*\\*エラーメッセージを強化して、問題を解決する方法についてユーザーにさらに具体的なガイダンスを提供します。\n* \\*\\*ユニットテストを追加する:\\*\\*サーバー側ツールのユニットテストを実装して、その正確性と信頼性を確認します。\n* \\*\\*共通ロジックのリファクタリング:\\*\\*重複したコードを特定し、再利用可能な関数またはクラスにリファクタリングします。\n* \\*\\*入力検証を実装する:\\*\\*無効なデータが処理されないように、サーバー側ツールに入力検証を追加します。\n* \\*\\*ドキュメントの改善:\\*\\*例や使用方法の説明など、サーバー側ツールのより詳細なドキュメントを追加します。\n* \\*\\*より堅牢な構成システムを実装する:\\*\\*環境変数のみに頼るのではなく、構成ファイルや専用の設定クラスなど、より堅牢な構成システムの使用を検討してください。\n* \\*\\*追加の SonarQube API エンドポイントのサポートの追加:\\*\\*プロジェクト、ルール、品質プロファイルの管理など、追加の SonarQube API エンドポイントをサポートするようにシステムを拡張します。\n* \\*\\*よりユーザーフレンドリーなクライアントインターフェイスを実装する:\\*\\*クライアントアプリケーション用にグラフィカルユーザーインターフェイス (GUI) またはより洗練されたコマンドラインインターフェイス (CLI) の開発を検討します。\n* \\*\\*潜在的なセキュリティ脆弱性に対処する:\\*\\*入力検証や認証に関連する潜在的なセキュリティ脆弱性など、コードを確認します。\n\n## さらなる調査分野\n\n* **パフォーマンスのボトルネック:** API リクエストの処理やデータ処理に関連するものなど、サーバー側ツールの潜在的なパフォーマンスのボトルネックを調査します。\n* \\*\\*スケーラビリティに関する考慮事項:\\*\\*システムのスケーラビリティを評価し、メッセージキューや分散キャッシュシステムの使用など、改善の可能性のある領域を特定します。\n* **外部システムとの統合:** CI/CD システムや問題追跡ツールなどの他の開発ツールとの潜在的な統合を検討します。\n* \\*\\*高度な機能:\\*\\*リアルタイムのメトリック監視や自動コード品質分析などの高度な機能を調査して実装します。\n* \\*\\*コードの臭いとテストカバレッジの低さ:\\*\\*コードベースを徹底的に分析し、コードの臭いとテストカバレッジの低い領域を特定して対処します。\n\n## 帰属\n\n自動ドキュメント化システムである[ArchAI](https://github.com/ArchAI-Labs/code_explainer)のサポートにより生成されました。","Japanese","ja-JP",{"_29":62,"_33":66,"_38":67},{"_31":63,"_33":64,"_35":65},"단순화된 메시지 기반 접근 방식을 통해 SonarQube 프로젝트 지표 및 품질 데이터를 검색하기 위한 도구를 제공하는 서버로, 사용자는 SonarQube에서 지표, 과거 데이터 및 구성 요소 수준 정보에 프로그래밍 방식으로 액세스할 수 있습니다.","FastMCP SonarQube 메트릭","# FastMCP SonarQube 메트릭\n\n![심벌 마크](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/logo.png)\n\n## 개요\n\n이 프로젝트는 FastMCP(Fast Model Context Protocol) 프레임워크를 사용하여 SonarQube 프로젝트에 대한 정보를 검색하는 도구 세트를 제공합니다. SonarQube 인터페이스 역할을 하여 사용자가 특정 프로젝트의 메트릭, 과거 데이터 및 구성 요소 트리 메트릭에 프로그래밍 방식으로 접근할 수 있도록 합니다. 이러한 자동화된 접근을 통해 SonarQube 데이터의 보고, 분석 및 다른 시스템과의 통합이 가능합니다.\n\n이 프로젝트는 SonarQube API와의 상호 작용에 간소화된 메시지 기반 접근 방식을 제공하여 직접 API 호출 및 데이터 처리의 복잡성을 추상화한다는 점에서 차별화됩니다. SonarQube 데이터를 워크플로에 통합하거나 맞춤형 보고 솔루션을 구축해야 하는 개발자, DevOps 엔지니어 및 분석가를 위해 설계되었습니다.\n\n이 저장소는 통신 및 데이터 검색을 용이하게 하는 클라이언트 및 서버 구성 요소를 특별히 보관합니다. 서버는 SonarQube에서 데이터를 가져오는 도구를 제공하고, 클라이언트는 사용자가 이러한 도구를 호출하고 결과를 표시할 수 있는 명령줄 인터페이스를 제공합니다. 각 내부 모듈은 API 상호 작용, 데이터 처리, 클라이언트-서버 통신과 같은 특정 기능을 캡슐화하여 이러한 목표 달성에 기여합니다.\n\n이 프로젝트에 포함된 클라이언트는 코드가 어떻게 작동하는지 테스트하기 위한 것일 뿐입니다. [Claude Desktop을](https://claude.ai/download) 사용하거나 사용자 정의 클라이언트를 직접 개발하는 것이 좋습니다.\n\n> ***이 저장소는 현재 작업 중이므로 일부 기능이 완벽하지 않을 수 있습니다.***\n\n## 지원되는 MCP 도구\n\n* `get_status` : 구성된 SonarQube 인스턴스에 대한 상태 점검을 수행합니다.\n* `list_projects` : 접근 가능한 모든 SonarQube 프로젝트를 나열하며, 이름이나 키로 필터링할 수도 있습니다.\n* `get_sonarqube_metrics` : 주어진 SonarQube 프로젝트 키에 대한 지정된 메트릭(버그, 취약점, 코드 냄새, 적용 범위, 중복 밀도)을 검색합니다.\n* `get_sonarqube_metrics_history` : /api/measures/search\\_history를 사용하여 특정 SonarQube 프로젝트의 과거 지표(버그, 취약점, 코드 스멜, 커버리지, 중복 밀도)를 검색합니다. 날짜 필터를 선택적으로 적용할 수 있습니다.\n* `get_sonarqube_component_tree_metrics` : /api/measures/component\\_tree를 사용하여 프로젝트의 모든 구성 요소(예: 파일 또는 디렉토리)에 대한 메트릭 값을 검색합니다. 모든 결과를 검색하기 위해 자동으로 페이지 매김을 처리합니다.\n* `get_project_issues` : 지정된 프로젝트의 SonarQube 이슈를 가져옵니다. 유형, 심각도 및 해결 상태별로 필터링하여 *최대* 10개까지 결과를 반환합니다.\n\n## 기술 스택\n\n* **언어:** 파이썬\n* **프레임워크:** FastMCP\n* **라이브러리:** httpx, pydantic, dotenv, asyncio, json, pathlib, typing, base64\n* **도구:** SonarQube API\n\n## 디렉토리 구조\n\n지엑스피1\n\n## 시작하기\n\n### 필수 조건\n\n* 파이썬 3.7 이상\n* API 액세스가 가능한 SonarQube 인스턴스\n* 적절한 권한이 있는 SonarQube API 토큰\n* FastMCP 설치됨( `pip install fastmcp` )\n* httpx 설치됨( `pip install httpx` )\n* pydantic 설치됨 ( `pip install pydantic` )\n* python-dotenv 설치됨( `pip install python-dotenv` )\n\n### 일반 빌드 단계\n\n1. **저장소를 복제합니다:** `git clone `\n\n2. **프로젝트 디렉토리로 이동합니다:** `cd fastmcp-sonarqube-metrics`\n\n3. **환경 변수 설정:** 프로젝트 루트 디렉토리에 다음 내용이 포함된 `.env` 파일을 만듭니다.\n\n ```\n SONARQUBE_URL=\r\n SONARQUBE_TOKEN=\r\n TRANSPORT=\r\n GEMINI_API_KEY=\r\n OPENAI_API_KEY=\n ```\n\n `` SonarQube 인스턴스의 URL(예: `http://localhost:9000` )로 바꾸고 `` SonarQube API 토큰으로 바꾸세요.\n\n4. **서버를 실행합니다:** `python server.py`\n\n5. **클라이언트를 실행합니다:** `python client_test.py`*(선택적으로 테스트에만 해당)*\n\n6. **클라이언트에 연결하려면** [공식 문서를](https://modelcontextprotocol.io/quickstart/user#windows) 따르세요.\n\n### 모듈 사용\n\n#### 서버( `server.py` )\n\n`server.py` 모듈은 SonarQube 메트릭을 검색하는 도구를 제공하는 FastMCP 서버를 정의합니다. 서버를 초기화하고, 환경 변수를 로드하고, 사용 가능한 도구를 정의하고, SonarQube API와의 통신을 처리합니다. 서버를 사용하려면 `SONARQUBE_URL` 및 `SONARQUBE_TOKEN` 환경 변수를 설정해야 합니다. 서버는 `server.py` 스크립트를 직접 실행하여 시작됩니다.\n\n#### 클라이언트( `client_test.py` )\n\n`client_test.py` 모듈은 서버와 상호 작용하는 FastMCP 클라이언트를 정의합니다. 이 모듈은 사용자에게 SonarQube 프로젝트 키를 입력하라는 메시지를 표시하고, 서버에 연결하여 `get_sonarqube_metrics` 및 `get_sonarqube_component_tree_metrics` 도구를 호출하고 결과를 표시합니다. 클라이언트를 사용하려면 `client_test.py` 스크립트를 직접 실행하고 메시지가 표시되면 유효한 SonarQube 프로젝트 키를 입력해야 합니다.\n\n#### 클라이언트 도구( `client_tool.py` )\n\n`client_tool.py` 모듈은 Tkinter 기반 그래픽 인터페이스를 통해 SonarQube 서버와 상호 작용하는 FastMCP 클라이언트를 구현합니다. 시작 시, 불필요한 메시지를 억제하도록 로거를 구성하고, 환경 변수를 로드하며, 서버에서 stdio를 통해 제공하는 LLM 및 MCP 도구를 사용하는 채팅 백엔드(ChatBackend)를 백그라운드에서 실행합니다. 프런트엔드(ChatGUI)는 Tkinter 창을 관리하고, 스크롤 가능한 영역에 메시지 기록을 표시하며, 사용자가 서버에 명령을 전송할 수 있도록 허용합니다. 필요한 경우 유효한 SonarQube 프로젝트 키를 입력하라는 메시지가 표시됩니다. 클라이언트를 사용하려면 `client_tool.py` 스크립트를 실행하고 GUI를 통해 상호 작용하기만 하면 됩니다.\n\n#### 클라이언트\\_랭체인( `client_langchain.py` )\n\n`client_langchain.py` 모듈은 LangChain을 통해 FastMCP 서버 및 SonarQube 도구와 상호 작용하는 명령줄 클라이언트를 제공합니다. 시작 시 환경 변수를 로드하고 선택한 LLM을 구성합니다. 서버( `server.py` )에 stdio 연결을 설정하고, MCP 세션을 초기화하고, 사용 가능한 도구(상태 확인, 현재 및 과거 메트릭, 프로젝트 목록, 이슈 검색)를 로드합니다. 자세한 시스템 프롬프트는 각 도구와 해당 매개변수를 설명합니다. 대화형 루프에서 콘솔에서 사용자 입력을 읽고, 메시지 기록을 업데이트하고, React 에이전트를 호출하고, 형식화된 응답을 출력합니다.\n\n### 예: 외부 프로젝트에 `get_sonarqube_metrics` 도구 통합\n\n외부 프로젝트에서 `get_sonarqube_metrics` 도구를 사용하려면 FastMCP 서버에 연결하여 도구를 호출하는 클라이언트를 생성해야 합니다. 다음은 기본적인 예입니다.\n\n```python\nimport asyncio\r\nfrom fastmcp import Client\r\nfrom fastmcp.types import TextContent\r\n\r\nasync def get_metrics(project_key: str):\r\n server_path = \"server.py\" # Adjust if necessary\r\n client = Client(server_path)\r\n try:\r\n async with client:\r\n result = await client.call_tool(\r\n \"get_sonarqube_metrics\", {\"project_key\": project_key}\r\n )\r\n if result:\r\n content = result[0]\r\n if isinstance(content, TextContent):\r\n metrics = json.loads(content.text)\r\n print(metrics)\r\n except Exception as e:\r\n print(f\"Error: {e}\")\r\n\r\nif __name__ == \"__main__\":\r\n asyncio.run(get_metrics(\"your-project-key\")) # Replace with your project key\n```\n\n이 예제는 클라이언트를 생성하고, 서버에 연결하고, 프로젝트 키를 사용하여 `get_sonarqube_metrics` 도구를 호출하고, 결과를 처리하는 방법을 보여줍니다. `server_path` 변수를 사용자 환경에서 `server.py` 스크립트의 실제 위치에 맞게 수정해야 합니다.\n\n## ArchAI-SonarQube 채팅(GUI)\n\nstdio를 통해 FastMCP 서버에 연결하고 SonarQube 메트릭을 쿼리하고, 구성 요소 트리를 탐색하고, LLM 기반 어시스턴트를 통해 상태 검사를 실행하기 위한 실시간 채팅 인터페이스를 제공하는 가벼운 Tkinter 클라이언트입니다.\n\n![이미지\\_도구](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/img_tool.png)\n\n## TRANSPORT=SSE와 함께 사용\n\nGUI를 시작하기 전에 `TRANSPORT` 환경 변수를 설정하여 클라이언트의 전송 계층을 SSE(Server-Sent Events)로 전환할 수 있습니다. 이를 통해 FastMCP 서버에서 단방향 실시간 업데이트를 수행할 수 있습니다. 서버가 SSE 모드로 시작되면 포트 **8001** 에서 지속적인 HTTP 연결이 열립니다. 이를 통해 MCP Inspector와 같은 호환 인터페이스를 통해 연결할 수 있습니다.\\*\n\n1. **SSE 모드로 서버를 시작합니다**\n\n ```bash\n uv run mcp dev \"\" \n ```\n\n2. **MCP Inspector 열기** 브라우저에서 MCP Inspector를 시작할 수 있는 링크(예: `http://127.0.0.1:6274` )가 제공됩니다.\n\n3. **MCP Inspector에서 SSE 구성**\n\n * 전송 유형으로 **SSE를** 선택하세요\n * URL을 입력하세요: `http://localhost:8001/sse`\n\n4. **연결을 시작합니다**\n\n5. **사용 가능한 도구 찾아보기** **도구** 섹션에서 다음 사항을 확인할 수 있습니다.\n\n * `get_status`\n * `get_sonarqube_metrics`\n * `get_sonarqube_metrics_history`\n * `get_sonarqube_component_tree_metrics`\n * `list_projects`\n * `get_project_issues`\n\n6. **도구를 선택하고 호출합니다.** 예를 들어 **get\\_project\\_issues를** 선택하고 다음을 제공합니다.\n\n * `project_key` : SonarQube 프로젝트 키\n * `issue_type` (선택 사항): 예: `BUG` , `CODE_SMELL`\n * `severity` (선택 사항): 예: `MAJOR` , `CRITICAL`\n * `resolved` (선택 사항): `true` 또는 `false`\n * `limit` (선택 사항): 반환할 최대 문제 수\n\n7. **실행 및 결과 검색** 서버는 적절한 SonarQube API를 호출하고 형식화된 JSON 응답을 반환합니다.\n\n## Claude Desktop과 함께 사용\n\nfastmcp를 사용하여 이 서버를 Claude Desktop에 직접 설치할 수 있습니다.\n\n1. FastMCP가 설치되어 있는지 확인하세요(pip install fastmcp 또는 uv pip install fastmcp).\n2. 사용하려는 MCP 서버에 대해 Claude for Desktop을 구성합니다(VSCode를 사용하는 Windows): `code $env:AppData\\Claude\\claude_desktop_config.json`\n3. 서버를 추가한 후 저장하세요.\n\n```json\n{\r\n \"mcpServers\": {\r\n \"fastmcp-sonarqube-metrics\": {\r\n \"command\": \"uv\",\r\n \"args\": [\r\n \"--directory\",\r\n \"/ABSOLUTE/PATH/TO/PARENT/FOLDER/fastmcp-sonarqube-metrics\",\r\n \"run\",\r\n \"server.py\"\r\n ]\r\n }\r\n }\r\n}\n```\n\n4. 다음을 실행하여 시작합니다.\n\n```bash\n uv --directory /ABSOLUTE/PATH/TO/PARENT/FOLDER/fastmcp-sonarqube-metrics run server.py\n```\n\n5. Claude Desktop이 실행 중이었다면 다시 시작하세요. 이제 *\"FastMCP SonarQube Metrics\"* 도구를 사용할 수 있습니다.\n\n![클로드](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/img_claude_desktop.png)\n\n## 기능 분석\n\n### 1. 시스템의 주요 책임\n\n이 시스템의 주요 역할은 사용자와 SonarQube API를 연결하는 다리 역할을 하여 프로젝트 품질 지표를 간편하게 검색할 수 있도록 하는 것입니다. SonarQube API의 복잡성을 포괄하여 자동화된 워크플로에 쉽게 호출하고 통합할 수 있는 도구 세트를 제공합니다. 핵심 서비스로는 지표 가져오기, 과거 데이터 검색, 그리고 SonarQube 프로젝트 내 구성 요소 수준 지표 탐색이 있습니다. 기본 서비스는 도구 정의 및 클라이언트-서버 통신을 관리하는 FastMCP 서버입니다.\n\n### 2. 시스템이 해결하는 문제\n\n이 시스템은 사용자가 SonarQube API와 직접 상호 작용하지 않고도 SonarQube 데이터에 프로그래밍 방식으로 접근하는 문제를 해결합니다. SonarQube 지표의 자동화된 보고, 분석 및 다른 시스템과의 통합에 대한 요구를 충족합니다. 특히 다음과 같은 작업을 간소화합니다.\n\n* 코드 품질 지표에 대한 정기 보고서를 생성합니다.\n* 시간 경과에 따른 코드 품질의 추세를 모니터링합니다.\n* 프로젝트 내에서 문제가 있는 구성요소를 식별합니다.\n* SonarQube 데이터를 다른 개발 도구와 통합합니다.\n\n이 아키텍처는 SonarQube API의 복잡성을 추상화하고 데이터 액세스를 위한 일관된 인터페이스를 제공하는 명확하게 정의된 도구 세트를 제공함으로써 이러한 문제를 해결합니다.\n\n### 3. 모듈과 구성 요소의 상호 작용\n\n시스템은 클라이언트와 서버라는 두 가지 주요 구성 요소로 구성됩니다. 클라이언트는 실행할 도구와 입력 매개변수를 지정하여 서버에 요청을 보냅니다. 서버는 요청을 수신하고 SonarQube API와 상호 작용하여 데이터를 처리한 후 결과를 클라이언트로 다시 전송합니다.\n\n클라이언트와 서버 간의 상호작용은 메시지 전달 및 직렬화를 처리하는 FastMCP 프레임워크를 통해 이루어집니다. 서버는 `@mcp.tool()` 데코레이터를 사용하여 사용 가능한 도구를 정의하고, 이 데코레이터는 함수를 호출 가능한 엔드포인트로 등록합니다. 클라이언트는 `client.call_tool()` 메서드를 사용하여 이러한 도구를 호출하고, 이 메서드는 도구 이름과 입력 매개변수를 서버로 전송합니다.\n\n서버는 `httpx` 라이브러리를 사용하여 SonarQube API에 비동기 HTTP 요청을 보냅니다. 실행 중인 도구와 클라이언트가 제공한 입력 매개변수를 기반으로 API URL과 요청 매개변수를 구성합니다. 그런 다음 SonarQube API에서 JSON 응답을 구문 분석하고 관련 메트릭 값을 추출합니다.\n\n### 4. 사용자 중심 기능 vs. 시스템 중심 기능\n\n시스템의 사용자 대면 기능은 클라이언트 애플리케이션( `client_test.py` )으로, SonarQube 메트릭 검색 도구를 호출하는 명령줄 인터페이스를 제공합니다. 사용자는 SonarQube 프로젝트 키와 선택적으로 날짜 범위 또는 메트릭 키와 같은 다른 매개변수를 제공하여 클라이언트와 상호 작용합니다. 그러면 클라이언트는 검색된 메트릭을 사람이 읽을 수 있는 형식으로 표시합니다.\n\n시스템 관련 기능은 `server.py` 에 정의된 서버 측 도구( `get_sonarqube_metrics` , `get_sonarqube_metrics_history` , `get_sonarqube_component_tree_metrics` )입니다. 이 도구들은 SonarQube API와의 상호작용, 데이터 처리 및 포맷팅을 담당합니다. 최종 사용자에게 직접 표시되지는 않지만 시스템의 핵심 기능을 제공하는 데 필수적입니다.\n\n`@mcp.tool()` 데코레이터는 모든 도구 함수에 공통적인 동작을 체계적으로 적용하여 FastMCP 서버에 등록되고 클라이언트에서 접근할 수 있도록 보장합니다. 또한, `Annotated` 와 `Field` 사용하면 모든 도구에서 일관된 매개변수 정의 및 문서화가 보장됩니다.\n\n## 적용된 아키텍처 패턴 및 디자인 원칙\n\n* **클라이언트-서버 아키텍처:** 이 프로젝트는 클라이언트가 서버에 서비스를 요청하는 클라이언트-서버 아키텍처를 따릅니다.\n* **메시지 전달:** FastMCP 프레임워크는 메시지 전달을 사용하여 클라이언트와 서버 간의 통신을 용이하게 합니다.\n* **비동기 프로그래밍:** `asyncio` 와 `httpx` 사용하면 비동기 작업이 가능해져 애플리케이션의 성능과 응답성이 향상됩니다.\n* **환경 변수를 통한 구성:** SonarQube URL과 토큰은 환경 변수를 사용하여 구성되므로 다양한 환경에서 애플리케이션을 보다 쉽게 배포하고 관리할 수 있습니다.\n* **도구 기반 설계:** 서버는 명확하게 정의된 도구를 통해 기능을 노출하므로 기능을 쉽게 추가하거나 수정할 수 있습니다.\n* **오류 처리:** 이 프로젝트에는 네트워크 오류, API 오류, 잘못된 데이터 등 잠재적인 문제를 원활하게 처리하기 위한 포괄적인 오류 처리 기능이 포함되어 있습니다.\n* **로깅:** `logging` 모듈을 사용하면 자세한 로그를 제공하여 디버깅과 모니터링에 도움이 됩니다.\n* **종속성 주입:** 프레임워크로 명시적으로 구현되지는 않았지만 환경 변수를 통해 SonarQube URL과 토큰을 구성하면 코드를 수정하지 않고도 다양한 SonarQube 인스턴스를 쉽게 대체할 수 있습니다.\n\n## 코드 품질 분석\n\nSonarQube 보고서가 없기 때문에 포괄적인 코드 품질 분석을 수행할 수 없습니다. 그러나 코드 구조와 기능을 고려할 때, 다음과 같은 잠재적인 문제가 발생할 수 있습니다.\n\n* **오류 처리 세부성:** 오류 처리가 존재하지만, 사용자에게 더 유용한 정보를 제공하기 위해 특정 오류 메시지를 개선할 수 있습니다.\n* **테스트 커버리지:** 제공된 코드에는 단위 테스트가 포함되어 있지 않습니다. 코드의 신뢰성과 정확성을 보장하기 위해 테스트 커버리지를 추가해야 합니다.\n* **코드 중복:** 공통 논리를 재사용 가능한 함수나 클래스로 추출하여 코드 중복을 줄일 수 있는 방법이 있을 수 있습니다.\n\n## 약점과 개선 영역\n\n* **오류 메시지의 명확성 개선:** 오류 메시지를 개선하여 사용자에게 문제 해결 방법에 대한 구체적인 지침을 제공합니다.\n* **단위 테스트 추가:** 서버 측 도구에 대한 단위 테스트를 구현하여 정확성과 안정성을 보장합니다.\n* **공통 논리를 리팩토링합니다.** 중복된 코드를 식별하여 재사용 가능한 함수나 클래스로 리팩토링합니다.\n* **입력 유효성 검사 구현:** 서버 측 도구에 입력 유효성 검사를 추가하여 잘못된 데이터가 처리되는 것을 방지합니다.\n* **설명서 개선:** 예제와 사용 지침을 포함하여 서버 측 도구에 대한 보다 자세한 설명서를 추가합니다.\n* **더욱 강력한 구성 시스템 구현:** 환경 변수에만 의존하는 대신, 구성 파일이나 전용 설정 클래스와 같은 더욱 강력한 구성 시스템을 사용하는 것을 고려하세요.\n* **추가 SonarQube API 엔드포인트에 대한 지원 추가:** 프로젝트, 규칙 또는 품질 프로필 관리를 위한 엔드포인트와 같은 추가 SonarQube API 엔드포인트를 지원하도록 시스템을 확장합니다.\n* **더욱 사용자 친화적인 클라이언트 인터페이스 구현:** 클라이언트 애플리케이션을 위한 그래픽 사용자 인터페이스(GUI)나 보다 정교한 명령줄 인터페이스(CLI)를 개발하는 것을 고려하세요.\n* **잠재적인 보안 취약점을 해결합니다.** 입력 검증이나 인증과 관련된 취약점 등 잠재적인 보안 취약점이 있는지 코드를 검토합니다.\n\n## 추가 조사 영역\n\n* **성능 병목 현상:** API 요청 처리나 데이터 처리와 관련된 것과 같이 서버 측 도구에서 잠재적인 성능 병목 현상을 조사합니다.\n* **확장성 고려 사항:** 시스템의 확장성을 평가하고 메시지 큐나 분산 캐싱 시스템 사용과 같이 개선이 가능한 영역을 파악합니다.\n* **외부 시스템과의 통합:** CI/CD 시스템이나 이슈 추적기 등 다른 개발 도구와의 잠재적 통합을 살펴보세요.\n* **고급 기능:** 실시간 메트릭 모니터링이나 자동화된 코드 품질 분석과 같은 고급 기능을 연구하고 구현합니다.\n* **코드 냄새와 낮은 테스트 범위:** 코드베이스에 대한 철저한 분석을 수행하여 코드 냄새와 테스트 범위가 낮은 영역을 식별하고 해결합니다.\n\n## 속성\n\n자동화된 문서화 시스템인 [ArchAI](https://github.com/ArchAI-Labs/code_explainer) 의 지원을 받아 생성되었습니다.","Korean","ko-KR",{"_29":69,"_33":73,"_38":74},{"_31":70,"_33":71,"_35":72},"Сервер, предоставляющий инструменты для извлечения метрик проекта SonarQube и данных о качестве с помощью упрощенного подхода на основе сообщений, что позволяет пользователям программно получать доступ к метрикам, историческим данным и информации на уровне компонентов из SonarQube.","Метрики FastMCP SonarQube","# Метрики FastMCP SonarQube\n\n![логотип](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/logo.png)\n\n## Обзор\n\nЭтот проект предоставляет набор инструментов для извлечения информации о проектах SonarQube с использованием фреймворка FastMCP (Fast Model Context Protocol). Он служит интерфейсом для SonarQube, позволяя пользователям программно получать доступ к метрикам, историческим данным и метрикам дерева компонентов для указанных проектов. Этот автоматизированный доступ позволяет создавать отчеты, анализировать и интегрировать данные SonarQube с другими системами.\n\nПроект отличается тем, что предлагает упрощенный подход на основе сообщений для взаимодействия с API SonarQube, абстрагируясь от сложностей прямых вызовов API и обработки данных. Он предназначен для разработчиков, инженеров DevOps и аналитиков, которым необходимо включить данные SonarQube в свои рабочие процессы или создать индивидуальные решения для создания отчетов.\n\nЭтот репозиторий специально содержит клиентские и серверные компоненты, которые облегчают коммуникацию и извлечение данных. Сервер предоставляет инструменты для извлечения данных из SonarQube, в то время как клиент предоставляет интерфейс командной строки для пользователей, чтобы вызывать эти инструменты и отображать результаты. Каждый внутренний модуль вносит свой вклад в достижение этой цели, инкапсулируя определенные функции, такие как взаимодействие API, обработка данных и коммуникация клиент-сервер.\n\nКлиент, включенный в проект, предназначен только для тестирования работы кода; мы рекомендуем использовать [Claude Desktop](https://claude.ai/download) или разработать собственный клиент.\n\n> ***ПОМНИТЕ, ЭТОТ РЕПО НАХОДИТСЯ В РАБОТЕ, НЕКОТОРЫЕ ФУНКЦИИ МОГУТ БЫТЬ НЕ ИДЕАЛЬНЫМИ.***\n\n## Поддерживаемые инструменты MCP\n\n* `get_status` : выполняет проверку работоспособности настроенного экземпляра SonarQube.\n* `list_projects` : список всех доступных проектов SonarQube, опционально отфильтрованных по имени или ключу.\n* `get_sonarqube_metrics` : извлекает указанные метрики (ошибки, уязвимости, запахи кода, покрытие, плотность дублирования) для заданного ключа проекта SonarQube.\n* `get_sonarqube_metrics_history` : Извлекает исторические метрики (ошибки, уязвимости, запахи кода, покрытие, плотность дублирования) для данного проекта SonarQube с помощью /api/measures/search\\_history. Могут применяться дополнительные фильтры даты.\n* `get_sonarqube_component_tree_metrics` : извлекает значения метрик для всех компонентов (например, файлов или каталогов) в проекте с помощью /api/measures/component\\_tree. Автоматически обрабатывает пагинацию для извлечения всех результатов.\n* `get_project_issues` : Извлечь проблемы SonarQube для указанного проекта, опционально отфильтрованные по типу, серьезности и статусу разрешения. Возвращает до *предела* результатов (по умолчанию: 10).\n\n## Технологический стек\n\n* **Язык:** Питон\n* **Фреймворки:** FastMCP\n* **Библиотеки:** httpx, pydantic, dotenv, asyncio, json, pathlib, typing, base64\n* **Инструменты:** API SonarQube\n\n## Структура каталога\n\n```\n├── client_test.py - Client application for testing and interacting with the server.\r\n├── server.py - Server application exposing tools to retrieve SonarQube metrics.\r\n├── client_tool.py - Client with a graphical interface to interact with the SonarQube server.\r\n├── client_langchain.py - Command-line client to interact with the FastMCP server and SonarQube tools via LangChain\r\n├── .env - Environment configuration file (stores SonarQube URL and token).\r\n└── README.md - Project documentation.\n```\n\n## Начиная\n\n### Предпосылки\n\n* Питон 3.7+\n* Экземпляр SonarQube с доступом через API\n* Токен API SonarQube с соответствующими разрешениями\n* FastMCP установлен ( `pip install fastmcp` )\n* httpx установлен ( `pip install httpx` )\n* установлен pydantic ( `pip install pydantic` )\n* установлен python-dotenv ( `pip install python-dotenv` )\n\n### Общие этапы сборки\n\n1. **Клонируйте репозиторий:** `git clone `\n\n2. **Перейдите в каталог проекта:** `cd fastmcp-sonarqube-metrics`\n\n3. **Настройте переменные среды:** создайте файл `.env` в корневом каталоге проекта со следующим содержимым:\n\n ```\n SONARQUBE_URL=\r\n SONARQUBE_TOKEN=\r\n TRANSPORT=\r\n GEMINI_API_KEY=\r\n OPENAI_API_KEY=\n ```\n\n Замените `` на URL-адрес вашего экземпляра SonarQube (например, `http://localhost:9000` ), а `` на ваш токен API SonarQube.\n\n4. **Запускаем сервер:** `python server.py`\n\n5. **Запустите клиент:** `python client_test.py`*(Необязательно, только для теста)*\n\n6. **Подключитесь к своему клиенту:** следуйте [официальной документации](https://modelcontextprotocol.io/quickstart/user#windows)\n\n### Использование модуля\n\n#### Сервер ( `server.py` )\n\nМодуль `server.py` определяет сервер FastMCP, который предоставляет инструменты для получения метрик SonarQube. Он инициализирует сервер, загружает переменные среды, определяет доступные инструменты и управляет связью с API SonarQube. Чтобы использовать сервер, вам необходимо задать переменные среды `SONARQUBE_URL` и `SONARQUBE_TOKEN` . Сервер запускается путем прямого запуска скрипта `server.py` .\n\n#### Клиент ( `client_test.py` )\n\nМодуль `client_test.py` определяет клиент FastMCP, который взаимодействует с сервером. Он запрашивает у пользователя ключ проекта SonarQube, подключается к серверу, вызывает инструменты `get_sonarqube_metrics` и `get_sonarqube_component_tree_metrics` и отображает результаты. Чтобы использовать клиент, вам необходимо напрямую запустить скрипт `client_test.py` и указать действительный ключ проекта SonarQube при запросе.\n\n#### Клиентский\\_инструмент ( `client_tool.py` )\n\nМодуль `client_tool.py` реализует клиент FastMCP с графическим интерфейсом на основе Tkinter для взаимодействия с сервером SonarQube. При запуске он настраивает регистраторы для подавления несущественных сообщений, загружает переменные среды и запускает бэкэнд чата (ChatBackend) в фоновом режиме, который использует LLM и инструменты MCP, предоставляемые сервером через stdio. Фронтенд (ChatGUI) управляет окном Tkinter, отображает историю сообщений в прокручиваемой области и позволяет пользователю отправлять команды на сервер, запрашивая действительный ключ проекта SonarQube при необходимости. Чтобы использовать клиент, просто запустите скрипт `client_tool.py` и взаимодействуйте через GUI.\n\n#### Client\\_langchain ( `client_langchain.py` )\n\nМодуль `client_langchain.py` предоставляет клиент командной строки для взаимодействия с сервером FastMCP и инструментами SonarQube через LangChain. При запуске он загружает переменные среды и настраивает выбранный LLM. Он устанавливает stdio-соединение с сервером ( `server.py` ), инициализирует сеанс MCP и загружает доступные инструменты (проверка работоспособности, текущие и исторические метрики, список проектов, поиск проблем). Подробная системная подсказка описывает каждый инструмент и его параметры. В интерактивном цикле он считывает пользовательский ввод с консоли, обновляет историю сообщений, вызывает агент React и печатает отформатированный ответ.\n\n### Пример: Интеграция инструмента `get_sonarqube_metrics` во внешний проект\n\nЧтобы использовать инструмент `get_sonarqube_metrics` во внешнем проекте, вы можете создать клиент, который подключается к серверу FastMCP и вызывает инструмент. Вот простой пример:\n\n```python\nimport asyncio\r\nfrom fastmcp import Client\r\nfrom fastmcp.types import TextContent\r\n\r\nasync def get_metrics(project_key: str):\r\n server_path = \"server.py\" # Adjust if necessary\r\n client = Client(server_path)\r\n try:\r\n async with client:\r\n result = await client.call_tool(\r\n \"get_sonarqube_metrics\", {\"project_key\": project_key}\r\n )\r\n if result:\r\n content = result[0]\r\n if isinstance(content, TextContent):\r\n metrics = json.loads(content.text)\r\n print(metrics)\r\n except Exception as e:\r\n print(f\"Error: {e}\")\r\n\r\nif __name__ == \"__main__\":\r\n asyncio.run(get_metrics(\"your-project-key\")) # Replace with your project key\n```\n\nВ этом примере показано, как создать клиента, подключиться к серверу, вызвать инструмент `get_sonarqube_metrics` с ключом проекта и обработать результаты. Вам нужно будет адаптировать переменную `server_path` к фактическому местоположению скрипта `server.py` в вашей среде.\n\n## Чат ArchAI-SonarQube (графический интерфейс)\n\nЛегкий клиент Tkinter, который подключается через stdio к серверу FastMCP и предоставляет интерфейс чата в реальном времени для запроса метрик SonarQube, просмотра деревьев компонентов и запуска проверок работоспособности с помощью помощника на основе LLM.\n\n![img\\_tool](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/img_tool.png)\n\n## Использование с TRANSPORT=SSE\n\nВы можете переключить транспортный уровень клиента на Server-Sent Events (SSE), установив переменную среды `TRANSPORT` перед запуском GUI. Это позволяет получать однонаправленные обновления в реальном времени с сервера FastMCP. Когда сервер запускается в режиме SSE, на порту **8001** открывается постоянное HTTP-соединение. Это позволяет подключаться через совместимые интерфейсы, такие как MCP Inspector.\\*\n\n1. **Запустите сервер в режиме SSE**\n\n ```bash\n uv run mcp dev \"\" \n ```\n\n2. **Открыть MCP Inspector** . Для запуска MCP Inspector в вашем браузере будет предоставлена ссылка (например, `http://127.0.0.1:6274` ).\n\n3. **Настройка SSE в MCP Inspector**\n\n * Выберите **SSE** в качестве типа транспорта.\n * Введите URL-адрес: `http://localhost:8001/sse`\n\n4. **Инициировать соединение**\n\n5. **Просмотрите доступные инструменты.** В разделе **«Инструменты»** вы увидите:\n\n * `get_status`\n * `get_sonarqube_metrics`\n * `get_sonarqube_metrics_history`\n * `get_sonarqube_component_tree_metrics`\n * `list_projects`\n * `get_project_issues`\n\n6. **Выберите и вызовите инструмент.** Например, выберите **get\\_project\\_issues** и укажите:\n\n * `project_key` : ключ проекта SonarQube\n * `issue_type` (необязательно): например, `BUG` , `CODE_SMELL`\n * `severity` (необязательно): например, `MAJOR` , `CRITICAL`\n * `resolved` (необязательно): `true` или `false`\n * `limit` (необязательно): максимальное количество возвращаемых вопросов\n\n7. **Выполнение и получение результатов** Сервер вызовет соответствующий API SonarQube и вернет отформатированный ответ JSON.\n\n## Использование с Claude Desktop\n\nВы можете установить этот сервер непосредственно в Claude Desktop с помощью fastmcp:\n\n1. Убедитесь, что FastMCP установлен (pip install fastmcp или uv pip install fastmcp).\n2. Настройте Claude for Desktop для любых серверов MCP, которые вы хотите использовать (в Windows с помощью VSCode): `code $env:AppData\\Claude\\claude_desktop_config.json`\n3. Добавьте свой сервер и сохраните:\n\n```json\n{\r\n \"mcpServers\": {\r\n \"fastmcp-sonarqube-metrics\": {\r\n \"command\": \"uv\",\r\n \"args\": [\r\n \"--directory\",\r\n \"/ABSOLUTE/PATH/TO/PARENT/FOLDER/fastmcp-sonarqube-metrics\",\r\n \"run\",\r\n \"server.py\"\r\n ]\r\n }\r\n }\r\n}\n```\n\n4. Чтобы запустить его, выполните:\n\n```bash\n uv --directory /ABSOLUTE/PATH/TO/PARENT/FOLDER/fastmcp-sonarqube-metrics run server.py\n```\n\n5. Перезапустите Claude Desktop, если он был запущен. Инструмент *\"FastMCP SonarQube Metrics\"* теперь должен быть доступен.\n\n![Клод](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/img_claude_desktop.png)\n\n## Функциональный анализ\n\n### 1. Основные обязанности системы\n\nОсновная обязанность системы — выступать в качестве моста между пользователем и API SonarQube, предоставляя упрощенный способ получения метрик качества проекта. Он инкапсулирует сложности API SonarQube, предлагая набор инструментов, которые можно легко вызывать и интегрировать в автоматизированные рабочие процессы. Основные службы включают в себя выборку метрик, получение исторических данных и исследование метрик на уровне компонентов в проекте SonarQube. Основополагающей службой является сервер FastMCP, который управляет определениями инструментов и клиент-серверной связью.\n\n### 2. Проблемы, которые решает система\n\nСистема решает проблему программного доступа к данным SonarQube, не требуя от пользователей прямого взаимодействия с API SonarQube. Она решает потребность в автоматизированной отчетности, анализе и интеграции метрик SonarQube с другими системами. В частности, она упрощает такие задачи, как:\n\n* Формирование регулярных отчетов по показателям качества кода.\n* Мониторинг тенденций качества кода с течением времени.\n* Выявление проблемных компонентов в проекте.\n* Интеграция данных SonarQube с другими инструментами разработки.\n\nАрхитектура решает эти проблемы, предоставляя набор четко определенных инструментов, которые абстрагируются от сложностей API SonarQube и обеспечивают единый интерфейс для доступа к данным.\n\n### 3. Взаимодействие модулей и компонентов\n\nСистема состоит из двух основных компонентов: клиента и сервера. Клиент инициирует запросы к серверу, указывая инструмент для выполнения и любые входные параметры. Сервер получает запрос, взаимодействует с API SonarQube, обрабатывает данные и отправляет результаты обратно клиенту.\n\nВзаимодействие между клиентом и сервером облегчается фреймворком FastMCP, который обрабатывает передачу сообщений и сериализацию. Сервер определяет доступные инструменты с помощью декоратора `@mcp.tool()` , который регистрирует функции как вызываемые конечные точки. Клиент вызывает эти инструменты с помощью метода `client.call_tool()` , который отправляет сообщение на сервер с именем инструмента и входными параметрами.\n\nСервер использует библиотеку `httpx` для выполнения асинхронных HTTP-запросов к API SonarQube. Он создает URL-адреса API и параметры запроса на основе исполняемого инструмента и входных параметров, предоставленных клиентом. Затем сервер анализирует ответы JSON от API SonarQube и извлекает соответствующие значения метрик.\n\n### 4. Функциональность, ориентированная на пользователя и на систему\n\nФункциональность системы, ориентированная на пользователя, — это клиентское приложение ( `client_test.py` ), которое предоставляет интерфейс командной строки для вызова инструментов извлечения метрик SonarQube. Пользователи взаимодействуют с клиентом, предоставляя ключ проекта SonarQube и, опционально, другие параметры, такие как диапазоны дат или ключи метрик. Затем клиент отображает извлеченные метрики в удобном для восприятия человеком формате.\n\nСистемные функции — это серверные инструменты ( `get_sonarqube_metrics` , `get_sonarqube_metrics_history` , `get_sonarqube_component_tree_metrics` ), определенные в `server.py` . Эти инструменты управляют взаимодействием с API SonarQube, обработкой данных и форматированием. Они не видны напрямую конечным пользователям, но необходимы для обеспечения основных функций системы.\n\nДекоратор `@mcp.tool()` систематически применяет общие поведения во всех функциях инструмента, гарантируя, что они зарегистрированы на сервере FastMCP и доступны для клиентов. Кроме того, использование `Annotated` и `Field` обеспечивает единообразное определение параметров и документирование во всех инструментах.\n\n## Архитектурные модели и принципы дизайна, применяемые\n\n* **Архитектура клиент-сервер:** проект следует архитектуре клиент-сервер, где клиент запрашивает услуги у сервера.\n* **Передача сообщений:** фреймворк FastMCP упрощает взаимодействие между клиентом и сервером с помощью передачи сообщений.\n* **Асинхронное программирование:** использование `asyncio` и `httpx` позволяет выполнять асинхронные операции, повышая производительность и скорость реагирования приложения.\n* **Конфигурация через переменные среды:** URL-адрес и токен SonarQube настраиваются с помощью переменных среды, что упрощает развертывание и управление приложением в различных средах.\n* **Проектирование на основе инструментов:** сервер реализует функциональность с помощью четко определенных инструментов, что упрощает добавление или изменение функций.\n* **Обработка ошибок:** проект включает в себя комплексную обработку ошибок для корректного устранения потенциальных проблем, таких как сетевые ошибки, ошибки API и недействительные данные.\n* **Ведение журнала:** использование модуля `logging` обеспечивает ведение подробных журналов, облегчающих отладку и мониторинг.\n* **Внедрение зависимостей:** хотя это явно не реализовано в виде фреймворка, конфигурация URL-адреса и токена SonarQube через переменные среды позволяет легко заменять различные экземпляры SonarQube без изменения кода.\n\n## Анализ качества кода\n\nИз-за отсутствия отчета SonarQube невозможно провести комплексный анализ качества кода. Однако, исходя из структуры и функциональности кода, к потенциальным областям беспокойства относятся:\n\n* **Детализация обработки ошибок:** хотя обработка ошибок присутствует, конкретные сообщения об ошибках можно было бы улучшить, чтобы предоставить пользователю более полезную информацию.\n* **Тестовое покрытие:** Предоставленный код не включает модульные тесты. Тестовое покрытие должно быть добавлено для обеспечения надежности и корректности кода.\n* **Дублирование кода:** существуют возможности сократить дублирование кода путем извлечения общей логики в повторно используемые функции или классы.\n\n## Слабые стороны и области для улучшения\n\n* **Повышение ясности сообщений об ошибках:** улучшение сообщений об ошибках для предоставления пользователям более конкретных рекомендаций по решению проблем.\n* **Добавьте модульные тесты:** реализуйте модульные тесты для серверных инструментов, чтобы убедиться в их корректности и надежности.\n* **Реорганизуйте общую логику:** определите и реорганизуйте дублирующийся код в повторно используемые функции или классы.\n* **Реализуйте проверку входных данных:** добавьте проверку входных данных в серверные инструменты, чтобы предотвратить обработку недействительных данных.\n* **Улучшить документацию:** добавить более подробную документацию для серверных инструментов, включая примеры и инструкции по использованию.\n* **Реализуйте более надежную систему конфигурации:** рассмотрите возможность использования более надежной системы конфигурации, например файла конфигурации или специального класса настроек, вместо того, чтобы полагаться исключительно на переменные среды.\n* **Добавьте поддержку дополнительных конечных точек API SonarQube:** расширьте систему для поддержки дополнительных конечных точек API SonarQube, например, для управления проектами, правилами или профилями качества.\n* **Реализуйте более удобный клиентский интерфейс:** рассмотрите возможность разработки графического пользовательского интерфейса (GUI) или более сложного интерфейса командной строки (CLI) для клиентского приложения.\n* **Устраните потенциальные уязвимости безопасности:** проверьте код на наличие потенциальных уязвимостей безопасности, например, связанных с проверкой входных данных или аутентификацией.\n\n## Дальнейшие направления исследований\n\n* **Узкие места производительности:** исследуйте потенциальные узкие места производительности в серверных инструментах, например, связанных с обработкой запросов API или обработкой данных.\n* **Вопросы масштабируемости:** оцените масштабируемость системы и определите потенциальные области для улучшения, например, использование очереди сообщений или распределенной системы кэширования.\n* **Интеграция с внешними системами:** изучите потенциальные возможности интеграции с другими инструментами разработки, такими как системы CI/CD или системы отслеживания ошибок.\n* **Расширенные функции:** исследуйте и внедряйте расширенные функции, такие как мониторинг показателей в реальном времени или автоматизированный анализ качества кода.\n* **Негативные коды и низкое тестовое покрытие:** проведите тщательный анализ кодовой базы, чтобы выявить и устранить негативные коды и области с низким тестовым покрытием.\n\n## Атрибуция\n\nСоздано при поддержке [ArchAI](https://github.com/ArchAI-Labs/code_explainer) , автоматизированной системы документирования.","Russian","ru-RU",{"_29":76,"_33":80,"_38":81},{"_31":77,"_33":78,"_35":79},"该服务器通过基于消息的简化方法提供检索 SonarQube 项目指标和质量数据的工具，允许用户以编程方式从 SonarQube 访问指标、历史数据和组件级信息。","FastMCP SonarQube 指标","# FastMCP SonarQube 指标\n\n![标识](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/logo.png)\n\n## 概述\n\n该项目提供了一套使用 FastMCP（快速模型上下文协议）框架检索 SonarQube 项目信息的工具。它作为 SonarQube 的接口，允许用户以编程方式访问指定项目的指标、历史数据和组件树指标。这种自动化访问功能支持 SonarQube 数据的报告、分析以及与其他系统的集成。\n\n该项目的独特之处在于，它提供了一种简化的、基于消息的方法来与 SonarQube API 交互，从而抽象出了直接 API 调用和数据处理的复杂性。它专为需要将 SonarQube 数据整合到工作流程或构建自定义报告解决方案的开发人员、DevOps 工程师和分析师而设计。\n\n该存储库专门包含用于通信和数据检索的客户端和服务器组件。服务器公开了从 SonarQube 获取数据的工具，而客户端则提供了命令行界面，供用户调用这些工具并显示结果。每个内部模块都通过封装特定的功能（例如 API 交互、数据处理和客户端-服务器通信）来实现此目标。\n\n项目中包含的客户端仅用于测试代码的工作方式；我们建议使用[Claude Desktop](https://claude.ai/download)或开发您自己的自定义客户端。\n\n> ***请记住，此 REPO 仍在开发中，某些功能可能并不完美。***\n\n## 支持的 MCP 工具\n\n* `get_status` ：对配置的 SonarQube 实例执行健康检查。\n* `list_projects` ：列出所有可访问的 SonarQube 项目，可选择按名称或键进行过滤。\n* `get_sonarqube_metrics` ：检索给定 SonarQube 项目键的指定指标（错误、漏洞、代码异味、覆盖率、重复密度）。\n* `get_sonarqube_metrics_history` ：使用 /api/measures/search\\_history 检索指定 SonarQube 项目的历史指标（错误、漏洞、代码异味、覆盖率、重复密度）。可应用可选的日期筛选条件。\n* `get_sonarqube_component_tree_metrics` ：使用 /api/measures/component\\_tree 检索项目中所有组件（例如文件或目录）的度量值，自动处理分页以检索所有结果。\n* `get_project_issues` ：获取指定项目的 SonarQube 问题，可选择按类型、严重程度和解决状态进行筛选。最多返回*限制*结果（默认值：10）。\n\n## 技术堆栈\n\n* **语言：** Python\n* **框架：** FastMCP\n* **库：** httpx、pydantic、dotenv、asyncio、json、pathlib、typing、base64\n* **工具：** SonarQube API\n\n## 目录结构\n\n```\n├── client_test.py - Client application for testing and interacting with the server.\r\n├── server.py - Server application exposing tools to retrieve SonarQube metrics.\r\n├── client_tool.py - Client with a graphical interface to interact with the SonarQube server.\r\n├── client_langchain.py - Command-line client to interact with the FastMCP server and SonarQube tools via LangChain\r\n├── .env - Environment configuration file (stores SonarQube URL and token).\r\n└── README.md - Project documentation.\n```\n\n## 入门\n\n### 先决条件\n\n* Python 3.7+\n* 具有 API 访问权限的 SonarQube 实例\n* 具有适当权限的 SonarQube API 令牌\n* FastMCP 安装（ `pip install fastmcp` ）\n* 已安装 httpx（ `pip install httpx` ）\n* 已安装 pydantic（ `pip install pydantic` ）\n* 已安装 python-dotenv（ `pip install python-dotenv` ）\n\n### 常规构建步骤\n\n1. **克隆存储库：** `git clone `\n\n2. **导航到项目目录：** `cd fastmcp-sonarqube-metrics`\n\n3. \\*\\*设置环境变量：\\*\\*在项目根目录下创建一个`.env`文件，内容如下：\n\n ```\n SONARQUBE_URL=\r\n SONARQUBE_TOKEN=\r\n TRANSPORT=\r\n GEMINI_API_KEY=\r\n OPENAI_API_KEY=\n ```\n\n 将``替换为您的 SonarQube 实例的 URL（例如， `http://localhost:9000` ），并将``替换为您的 SonarQube API 令牌。\n\n4. **运行服务器：** `python server.py`\n\n5. **运行客户端：** `python client_test.py`*（可选，仅用于测试）*\n\n6. \\*\\*连接到您的客户端：\\*\\*按照[官方文档](https://modelcontextprotocol.io/quickstart/user#windows)\n\n### 模块使用\n\n#### 服务器（ `server.py` ）\n\n`server.py`模块定义了 FastMCP 服务器，该服务器公开了用于检索 SonarQube 指标的工具。它初始化服务器、加载环境变量、定义可用工具并处理与 SonarQube API 的通信。要使用该服务器，您需要设置`SONARQUBE_URL`和`SONARQUBE_TOKEN`环境变量。服务器可以通过直接运行`server.py`脚本来启动。\n\n#### 客户端（ `client_test.py` ）\n\n`client_test.py`模块定义了与服务器交互的 FastMCP 客户端。它会提示用户输入 SonarQube 项目密钥，连接到服务器，调用`get_sonarqube_metrics`和`get_sonarqube_component_tree_metrics`工具，并显示结果。要使用该客户端，您需要直接运行`client_test.py`脚本，并在出现提示时提供有效的 SonarQube 项目密钥。\n\n#### 客户端工具（ `client_tool.py` ）\n\n`client_tool.py`模块实现了 FastMCP 客户端，该客户端使用基于 Tkinter 的图形界面与 SonarQube 服务器交互。启动时，它会配置记录器以抑制非必要消息，加载环境变量，并在后台启动聊天后端 (ChatBackend)，该后端使用 LLM 和服务器通过 stdio 公开的 MCP 工具。前端 (ChatGUI) 管理 Tkinter 窗口，在可滚动区域中显示消息历史记录，并允许用户向服务器发送命令——并在需要时提示输入有效的 SonarQube 项目密钥。要使用客户端，只需运行`client_tool.py`脚本并通过 GUI 进行交互即可。\n\n#### 客户端语言链（ `client_langchain.py` ）\n\n`client_langchain.py`模块提供了一个命令行客户端，用于通过 LangChain 与 FastMCP 服务器和 SonarQube 工具交互。启动时，它会加载环境变量并配置所选的 LLM。它会与服务器 ( `server.py` ) 建立 stdio 连接，初始化 MCP 会话，并加载可用的工具（健康检查、当前和历史指标、项目列表、问题检索）。详细的系统提示符会描述每个工具及其参数。在交互式循环中，它会从控制台读取用户输入，更新消息历史记录，调用 React 代理并打印格式化的响应。\n\n### 示例：在外部项目中集成`get_sonarqube_metrics`工具\n\n要在外部项目中使用`get_sonarqube_metrics`工具，您可以创建一个连接到 FastMCP 服务器并调用该工具的客户端。这是一个基本示例：\n\n```python\nimport asyncio\r\nfrom fastmcp import Client\r\nfrom fastmcp.types import TextContent\r\n\r\nasync def get_metrics(project_key: str):\r\n server_path = \"server.py\" # Adjust if necessary\r\n client = Client(server_path)\r\n try:\r\n async with client:\r\n result = await client.call_tool(\r\n \"get_sonarqube_metrics\", {\"project_key\": project_key}\r\n )\r\n if result:\r\n content = result[0]\r\n if isinstance(content, TextContent):\r\n metrics = json.loads(content.text)\r\n print(metrics)\r\n except Exception as e:\r\n print(f\"Error: {e}\")\r\n\r\nif __name__ == \"__main__\":\r\n asyncio.run(get_metrics(\"your-project-key\")) # Replace with your project key\n```\n\n此示例演示如何创建客户端、连接到服务器、使用项目密钥调用`get_sonarqube_metrics`工具并处理结果。您需要根据环境中`server.py`脚本的实际位置调整`server_path`变量。\n\n## ArchAI-SonarQube 聊天（GUI）\n\n轻量级的 Tkinter 客户端通过 stdio 连接到 FastMCP 服务器，并公开实时聊天界面，用于查询 SonarQube 指标、浏览组件树和通过 LLM 驱动的助手运行健康检查。\n\n![img\\_tool](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/img_tool.png)\n\n## 与 TRANSPORT=SSE 一起使用\n\n您可以在启动 GUI 之前设置`TRANSPORT`环境变量，将客户端的传输层切换到服务器发送事件 (SSE)。这样就可以从 FastMCP 服务器进行实时单向更新。当服务器以 SSE 模式启动时，会在端口**8001**上打开一个持久 HTTP 连接。这样您就可以通过兼容的接口（例如 MCP Inspector\\*）进行连接。\n\n1. **以 SSE 模式启动服务器**\n\n ```bash\n uv run mcp dev \"\" \n ```\n\n2. **打开 MCP Inspector**将提供一个链接（例如`http://127.0.0.1:6274` ）以在您的浏览器中启动 MCP Inspector。\n\n3. **在 MCP Inspector 中配置 SSE**\n\n * 选择**SSE**作为传输类型\n * 输入网址： `http://localhost:8001/sse`\n\n4. **发起连接**\n\n5. **浏览可用的工具**在**工具**部分您将看到：\n\n * `get_status`\n * `get_sonarqube_metrics`\n * `get_sonarqube_metrics_history`\n * `get_sonarqube_component_tree_metrics`\n * `list_projects`\n * `get_project_issues`\n\n6. **选择并调用一个工具**例如，选择**get\\_project\\_issues**并提供：\n\n * `project_key` ：SonarQube 项目密钥\n * `issue_type` （可选）：例如`BUG` 、 `CODE_SMELL`\n * `severity` （可选）：例如`MAJOR` 、 `CRITICAL`\n * `resolved` （可选）： `true`或`false`\n * `limit` （可选）：返回的最大问题数\n\n7. **执行并检索结果**服务器将调用适当的 SonarQube API 并返回格式化的 JSON 响应。\n\n## 与 Claude Desktop 一起使用\n\n您可以使用 fastmcp 将此服务器直接安装到 Claude Desktop 中：\n\n1. 确保已安装 FastMCP（pip install fastmcp 或 uv pip install fastmcp）。\n2. 为您想要使用的任何 MCP 服务器配置 Claude for Desktop（在 Windows 中使用 VSCode）： `code $env:AppData\\Claude\\claude_desktop_config.json`\n3. 添加您的服务器然后保存：\n\n```json\n{\r\n \"mcpServers\": {\r\n \"fastmcp-sonarqube-metrics\": {\r\n \"command\": \"uv\",\r\n \"args\": [\r\n \"--directory\",\r\n \"/ABSOLUTE/PATH/TO/PARENT/FOLDER/fastmcp-sonarqube-metrics\",\r\n \"run\",\r\n \"server.py\"\r\n ]\r\n }\r\n }\r\n}\n```\n\n4. 通过运行来启动它：\n\n```bash\n uv --directory /ABSOLUTE/PATH/TO/PARENT/FOLDER/fastmcp-sonarqube-metrics run server.py\n```\n\n5. 如果 Claude Desktop 正在运行，请重新启动它。 \\*“FastMCP SonarQube Metrics”\\*工具现在应该可用了。\n\n![克劳德](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/img_claude_desktop.png)\n\n## 功能分析\n\n### 1.系统主要职责\n\n该系统的主要职责是充当用户与 SonarQube API 之间的桥梁，提供一种简化的项目质量指标检索方式。它封装了 SonarQube API 的复杂性，提供了一套易于调用并集成到自动化工作流程中的工具。核心服务包括获取指标、检索历史数据以及探索 SonarQube 项目中的组件级指标。基础服务是 FastMCP 服务器，用于管理工具定义和客户端-服务器通信。\n\n### 2. 系统解决的问题\n\n该系统解决了以编程方式访问 SonarQube 数据的问题，无需用户直接与 SonarQube API 交互。它满足了自动报告、分析以及 SonarQube 指标与其他系统集成的需求。具体来说，它简化了以下任务：\n\n* 生成有关代码质量指标的定期报告。\n* 监控代码质量随时间的变化趋势。\n* 识别项目中有问题的组件。\n* 将 SonarQube 数据与其他开发工具集成。\n\n该架构通过提供一组定义明确的工具来解决这些问题，这些工具抽象出了 SonarQube API 的复杂性并提供了用于访问数据的一致接口。\n\n### 3.模块和组件的交互\n\n该系统由两个主要组件组成：客户端和服务器。客户端向服务器发起请求，指定要执行的工具和任何输入参数。服务器接收请求，与 SonarQube API 交互，处理数据，并将结果发送回客户端。\n\n客户端和服务器之间的交互由 FastMCP 框架实现，该框架负责处理消息传递和序列化。服务器使用`@mcp.tool()`装饰器定义可用的工具，并将这些函数注册为可调用端点。客户端使用`client.call_tool()`方法调用这些工具，该方法会向服务器发送一条包含工具名称和输入参数的消息。\n\n服务器使用`httpx`库向 SonarQube API 发出异步 HTTP 请求。它根据正在执行的工具和客户端提供的输入参数构建 API URL 和请求参数。然后，服务器解析来自 SonarQube API 的 JSON 响应并提取相关的指标值。\n\n### 4. 面向用户的功能 vs. 面向系统的功能\n\n该系统面向用户的功能是客户端应用程序 ( `client_test.py` )，它提供了一个用于调用 SonarQube 指标检索工具的命令行界面。用户通过提供 SonarQube 项目键以及可选的其他参数（例如日期范围或指标键）与客户端进行交互。然后，客户端会以用户可读的格式显示检索到的指标。\n\n面向系统的功能是`server.py`中定义的服务器端工具（ `get_sonarqube_metrics` 、 `get_sonarqube_metrics_history` 、 `get_sonarqube_component_tree_metrics` ）。这些工具负责与 SonarQube API 的交互、数据处理和格式化。它们对最终用户不直接可见，但对于提供系统的核心功能至关重要。\n\n`@mcp.tool()`装饰器系统地将通用行为应用于所有工具函数，确保它们已在 FastMCP 服务器上注册并可供客户端访问。此外， `Annotated`和`Field`的使用确保了所有工具的参数定义和文档的一致性。\n\n## 应用的架构模式和设计原则\n\n* \\*\\*客户端-服务器架构：\\*\\*该项目遵循客户端-服务器架构，客户端向服务器请求服务。\n* **消息传递：** FastMCP 框架使用消息传递促进客户端和服务器之间的通信。\n* \\*\\*异步编程：\\*\\*使用`asyncio`和`httpx`可以实现异步操作，提高应用程序的性能和响应能力。\n* **通过环境变量进行配置：** SonarQube URL 和令牌使用环境变量进行配置，从而更容易在不同的环境中部署和管理应用程序。\n* \\*\\*基于工具的设计：\\*\\*服务器通过明确定义的工具公开功能，从而可以轻松添加或修改功能。\n* \\*\\*错误处理：\\*\\*该项目包括全面的错误处理，以便妥善处理潜在问题，例如网络错误、API 错误和无效数据。\n* \\*\\*日志记录：\\*\\*使用`logging`模块提供详细的日志，有助于调试和监控。\n* \\*\\*依赖注入：\\*\\*虽然没有明确地作为框架实现，但通过环境变量配置 SonarQube URL 和令牌可以轻松替换不同的 SonarQube 实例，而无需修改代码。\n\n## 代码质量分析\n\n由于缺少 SonarQube 报告，无法进行全面的代码质量分析。但是，根据代码结构和功能，潜在的值得关注的领域包括：\n\n* \\*\\*错误处理粒度：\\*\\*虽然存在错误处理，但可以改进具体的错误消息，以便向用户提供更多可操作的信息。\n* \\*\\*测试覆盖率：\\*\\*提供的代码不包含单元测试。需要添加测试覆盖率以确保代码的可靠性和正确性。\n* \\*\\*代码重复：\\*\\*通过将通用逻辑提取到可重用的函数或类中，可能有机会减少代码重复。\n\n## 弱点和需要改进的地方\n\n* \\*\\*提高错误消息的清晰度：\\*\\*增强错误消息，为用户提供更具体的解决问题的指导。\n* \\*\\*添加单元测试：\\*\\*对服务器端工具进行单元测试，确保其正确性和可靠性。\n* \\*\\*重构通用逻辑：\\*\\*识别重复的代码并将其重构为可重用的函数或类。\n* \\*\\*实现输入验证：\\*\\*向服务器端工具添加输入验证，以防止处理无效数据。\n* \\*\\*改进文档：\\*\\*为服务器端工具添加更详细的文档，包括示例和使用说明。\n* \\*\\*实施更强大的配置系统：\\*\\*考虑使用更强大的配置系统，例如配置文件或专用设置类，而不是仅仅依赖环境变量。\n* \\*\\*添加对其他 SonarQube API 端点的支持：\\*\\*扩展系统以支持其他 SonarQube API 端点，例如用于管理项目、规则或质量配置文件的端点。\n* \\*\\*实现更加用户友好的客户端界面：\\*\\*考虑为客户端应用程序开发图形用户界面 (GUI) 或更复杂的命令行界面 (CLI)。\n* \\*\\*解决潜在的安全漏洞：\\*\\*检查代码中是否存在潜在的安全漏洞，例如与输入验证或身份验证相关的漏洞。\n\n## 进一步调查的领域\n\n* \\*\\*性能瓶颈：\\*\\*调查服务器端工具中的潜在性能瓶颈，例如与 API 请求处理或数据处理相关的瓶颈。\n* \\*\\*可扩展性考虑：\\*\\*评估系统的可扩展性并确定潜在的改进领域，例如使用消息队列或分布式缓存系统。\n* \\*\\*与外部系统的集成：\\*\\*探索与其他开发工具（例如 CI/CD 系统或问题跟踪器）的潜在集成。\n* \\*\\*高级功能：\\*\\*研究并实现高级功能，例如实时指标监控或自动代码质量分析。\n* \\*\\*代码异味和低测试覆盖率：\\*\\*对代码库进行彻底分析，以识别和解决代码异味和测试覆盖率低的区域。\n\n## 归因\n\n在自动化文档系统[ArchAI](https://github.com/ArchAI-Labs/code_explainer)的支持下生成。","Chinese","zh-CN","githubUser","locale",{"_85":86,"_87":88,"_13":102,"_109":42,"_110":42,"_111":112,"_116":117,"_140":-5,"_16":141,"_142":143,"_144":145,"_33":43,"_163":130,"_164":-5,"_165":-5,"_166":-5,"_167":-5,"_168":169,"_174":-5,"_152":126,"_175":176,"_180":-5,"_131":181,"_182":183},"addedAt","2025-05-07T01:05:53.876876843Z","argumentsJsonSchema",{"_89":90,"_99":100,"_94":101},"properties",{"_91":92,"_96":97},"SONARQUBE_URL",{"_31":93,"_94":95},"The URL of your SonarQube instance (e.g., http://localhost:9000)","type","string","SONARQUBE_TOKEN",{"_31":98,"_94":95},"Your SonarQube API token with appropriate permissions","required",[91,96],"object",[103,104,105,106,107,108],"category:monitoring","category:developer-tools","environment:network","hosting:remote-capable","language:python","license_grade:a","descriptionMarkdown","descriptionPlainText","githubProject",{"_35":113,"_114":115},"# FastMCP SonarQube Metrics\r\n\r\n![logo](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/logo.png)\r\n\r\n## Overview\r\n\r\nThis project provides a set of tools for retrieving information about SonarQube projects using the FastMCP (Fast Model Context Protocol) framework. It serves as an interface to SonarQube, allowing users to programmatically access metrics, historical data, and component tree metrics for specified projects. This automated access enables reporting, analysis, and integration of SonarQube data with other systems.\r\n\r\nThe project distinguishes itself by offering a simplified, message-based approach to interacting with the SonarQube API, abstracting away the complexities of direct API calls and data handling. It's designed for developers, DevOps engineers, and analysts who need to incorporate SonarQube data into their workflows or build custom reporting solutions.\r\n\r\nThis repository specifically houses the client and server components that facilitate communication and data retrieval. The server exposes tools to fetch data from SonarQube, while the client provides a command-line interface for users to invoke these tools and display the results. Each internal module contributes to this goal by encapsulating specific functionalities, such as API interaction, data processing, and client-server communication.\r\n\r\nThe client included in the project is only for testing how the code works; we recommend using [Claude Desktop](https://claude.ai/download) or developing your own custom client.\r\n\r\n> ***REMEMBER, THIS REPO IS WORK IN PROGRESS, SOME FEATURES MAY NOT BE PERFECT.***\r\n\r\n## Supported MCP Tools\r\n\r\n* `get_status`: Performs a health check on the configured SonarQube instance.\r\n* `list_projects`: Lists all accessible SonarQube projects, optionally filtered by name or key.\r\n* `get_sonarqube_metrics`: Retrieves specified metrics (bugs, vulnerabilities, code smells, coverage, duplication density) for a given SonarQube project key.\r\n* `get_sonarqube_metrics_history`: Retrieves historical metrics (bugs, vulnerabilities, code smells, coverage, duplication density) for a given SonarQube project using /api/measures/search_history. Optional date filters can be applied.\r\n* `get_sonarqube_component_tree_metrics`: Retrieves metric values for all components (e.g., files or directories) in a project using /api/measures/component_tree Automatically handles pagination to retrieve all results.\r\n* `get_project_issues`: Fetch SonarQube issues for a given project, optionally filtered by type, severity, and resolution status. Returns up to *limit* results (default: 10).\r\n\r\n## Technology Stack\r\n\r\n* **Language:** Python\r\n* **Frameworks:** FastMCP\r\n* **Libraries:** httpx, pydantic, dotenv, asyncio, json, pathlib, typing, base64\r\n* **Tools:** SonarQube API\r\n\r\n## Directory Structure\r\n\r\n```\r\n├── client_test.py - Client application for testing and interacting with the server.\r\n├── server.py - Server application exposing tools to retrieve SonarQube metrics.\r\n├── client_tool.py - Client with a graphical interface to interact with the SonarQube server.\r\n├── client_langchain.py - Command-line client to interact with the FastMCP server and SonarQube tools via LangChain\r\n├── .env - Environment configuration file (stores SonarQube URL and token).\r\n└── README.md - Project documentation.\r\n```\r\n\r\n## Getting Started\r\n\r\n### Prerequisites\r\n\r\n* Python 3.7+\r\n* SonarQube instance with API access\r\n* A SonarQube API token with appropriate permissions\r\n* FastMCP installed (`pip install fastmcp`)\r\n* httpx installed (`pip install httpx`)\r\n* pydantic installed (`pip install pydantic`)\r\n* python-dotenv installed (`pip install python-dotenv`)\r\n\r\n### General Build Steps\r\n\r\n1. **Clone the repository:** `git clone `\r\n2. **Navigate to the project directory:** `cd fastmcp-sonarqube-metrics`\r\n3. **Set up environment variables:** Create a `.env` file in the project root directory with the following content:\r\n\r\n ```\r\n SONARQUBE_URL=\r\n SONARQUBE_TOKEN=\r\n TRANSPORT=\r\n GEMINI_API_KEY=\r\n GEMINI_MODEL= (Optional)\r\n ```\r\n\r\n The schema is the same for *OpenAI* and *Groq*, if you want to use *AzureOpenAI*:\r\n\r\n ```\r\n SONARQUBE_URL=\r\n SONARQUBE_TOKEN=\r\n TRANSPORT=\r\n AZURE_OPENAI_API_KEY=\r\n AZURE_OPENAI_ENDPOINT=\r\n AZURE_DEPLOYMENT=\r\n AZURE_API_VERSION=\r\n ```\r\n\r\n Replace `` with the URL of your SonarQube instance (e.g., `http://localhost:9000`) and `` with your SonarQube API token.\r\n4. **Run the server:** `python server.py`\r\n5. **Run the client:** `python client_test.py` *(Optionally, only for test)*\r\n6. **Connect to your client:** follow the [official documentation](https://modelcontextprotocol.io/quickstart/user#windows)\r\n\r\n### Module Usage\r\n\r\n#### Server (`server.py`)\r\n\r\nThe `server.py` module defines the FastMCP server that exposes tools for retrieving SonarQube metrics. It initializes the server, loads environment variables, defines the available tools, and handles communication with the SonarQube API. To use the server, you need to set the `SONARQUBE_URL` and `SONARQUBE_TOKEN` environment variables. The server is started by running the `server.py` script directly.\r\n\r\n#### Client (`client_test.py`)\r\n\r\nThe `client_test.py` module defines the FastMCP client that interacts with the server. It prompts the user for a SonarQube project key, connects to the server, invokes the `get_sonarqube_metrics` and `get_sonarqube_component_tree_metrics` tools, and displays the results. To use the client, you need to run the `client_test.py` script directly and provide a valid SonarQube project key when prompted and set the transport type in the .env file to *stdio*.\r\n\r\n#### Client_tool (`client_tool.py`)\r\nThe `client_tool.py` module implements the FastMCP client with a Tkinter-based graphical interface to interact with the SonarQube server. On startup, it configures loggers to suppress non-essential messages, loads environment variables, and launches the chat backend (ChatBackend) in the background, which uses an LLM and the MCP tools exposed by the server via stdio. The frontend (ChatGUI) manages the Tkinter window, displays the message history in a scrollable area, and allows the user to send commands to the server—prompting for a valid SonarQube project key when needed. To use the client, simply run the `client_tool.py` script and interact through the GUI.\r\n\r\n#### Client_langchain (`client_langchain.py`)\r\nThe `client_langchain.py` module provides a command-line client to interact with the FastMCP server and SonarQube tools via LangChain. On startup, it loads environment variables, and configures the chosen LLM. It establishes a stdio connection to the server (`server.py`), initializes the MCP session, and loads available tools (health check, current and historical metrics, project listing, issue retrieval). A detailed system prompt describes each tool and its parameters. In an interactive loop, it reads user input from the console, updates the message history, invokes the React agent, and prints the formatted response.\r\n\r\n### Example: Integrating the `get_sonarqube_metrics` tool in an external project\r\n\r\nTo use the `get_sonarqube_metrics` tool in an external project, you can create a client that connects to the FastMCP server and invokes the tool. Here's a basic example:\r\n\r\n```python\r\nimport asyncio\r\nfrom fastmcp import Client\r\nfrom fastmcp.types import TextContent\r\n\r\nasync def get_metrics(project_key: str):\r\n server_path = \"server.py\" # Adjust if necessary\r\n client = Client(server_path)\r\n try:\r\n async with client:\r\n result = await client.call_tool(\r\n \"get_sonarqube_metrics\", {\"project_key\": project_key}\r\n )\r\n if result:\r\n content = result[0]\r\n if isinstance(content, TextContent):\r\n metrics = json.loads(content.text)\r\n print(metrics)\r\n except Exception as e:\r\n print(f\"Error: {e}\")\r\n\r\nif __name__ == \"__main__\":\r\n asyncio.run(get_metrics(\"your-project-key\")) # Replace with your project key\r\n```\r\n\r\nThis example demonstrates how to create a client, connect to the server, invoke the `get_sonarqube_metrics` tool with a project key, and process the results. You would need to adapt the `server_path` variable to the actual location of the `server.py` script in your environment.\r\n\r\n\r\n\r\n## ArchAI-SonarQube Chat (GUI)\r\n\r\nA lightweight Tkinter client that connects over stdio to the FastMCP server and exposes a real-time chat interface for querying SonarQube metrics, browsing component trees and running health checks via an LLM-driven assistant.\r\n\r\n
\r\n\r\n![img_tool](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/img_tool.png)\r\n\r\n
\r\n\r\n## Usage with TRANSPORT=SSE\r\nYou can switch the client’s transport layer to Server-Sent Events (SSE) by setting the `TRANSPORT` environment variable before launching the GUI. This enables real-time, uni-directional updates from the FastMCP server.\r\nWhen the server is started in SSE mode, a persistent HTTP connection is opened on port **8001**. This allows you to connect via compatible interfaces such as MCP Inspector.*\r\n\r\n1. **Start the server in SSE mode** \r\n ```bash\r\n uv run mcp dev \"\" \r\n ```\r\n2. **Open MCP Inspector**\r\n A link (e.g. `http://127.0.0.1:6274`) will be provided to launch MCP Inspector in your browser.\r\n3. **Configure SSE in MCP Inspector**\r\n\r\n * Select **SSE** as the transport type\r\n * Enter the URL: `http://localhost:8001/sse`\r\n\r\n4. **Initiate the connection**\r\n\r\n5. **Browse available tools**\r\n In the **Tools** section you will see:\r\n\r\n * `get_status`\r\n * `get_sonarqube_metrics`\r\n * `get_sonarqube_metrics_history`\r\n * `get_sonarqube_component_tree_metrics`\r\n * `list_projects`\r\n * `get_project_issues`\r\n\r\n6. **Select and invoke a tool**\r\n For example, choose **get\\_project\\_issues** and provide:\r\n\r\n * `project_key`: the SonarQube project key\r\n * `issue_type` (optional): e.g. `BUG`, `CODE_SMELL`\r\n * `severity` (optional): e.g. `MAJOR`, `CRITICAL`\r\n * `resolved` (optional): `true` or `false`\r\n * `limit` (optional): maximum number of issues to return\r\n\r\n7. **Execute and retrieve results**\r\n The server will call the appropriate SonarQube API and return a formatted JSON response.\r\n\r\n## Usage with Claude Desktop\r\n\r\nYou can install this server directly into Claude Desktop using fastmcp:\r\n\r\n1. Make sure FastMCP is installed (pip install fastmcp or uv pip install fastmcp).\r\n2. Configure Claude for Desktop for whichever MCP servers you want to use (in Windows using VSCode): `code $env:AppData\\Claude\\claude_desktop_config.json`\r\n3. Add your server and then save:\r\n\r\n```json\r\n{\r\n \"mcpServers\": {\r\n \"fastmcp-sonarqube-metrics\": {\r\n \"command\": \"uv\",\r\n \"args\": [\r\n \"--directory\",\r\n \"/ABSOLUTE/PATH/TO/PARENT/FOLDER/fastmcp-sonarqube-metrics\",\r\n \"run\",\r\n \"server.py\"\r\n ]\r\n }\r\n }\r\n}\r\n```\r\n\r\n4. To launch it by running:\r\n\r\n```bash\r\n uv --directory /ABSOLUTE/PATH/TO/PARENT/FOLDER/fastmcp-sonarqube-metrics run server.py\r\n```\r\n\r\n5. Restart Claude Desktop if it was running. The *\"FastMCP SonarQube Metrics\"* tool should now be available.\r\n\r\n
\r\n\r\n![claude](https://github.com/ArchAI-Labs/fastmcp-sonarqube-metrics/blob/main/img/img_claude_desktop.png)\r\n\r\n
\r\n\r\n## Functional Analysis\r\n\r\n### 1. Main Responsibilities of the System\r\n\r\nThe system's primary responsibility is to act as a bridge between a user and the SonarQube API, providing a simplified way to retrieve project quality metrics. It encapsulates the complexities of the SonarQube API, offering a set of tools that can be easily invoked and integrated into automated workflows. The core services include fetching metrics, retrieving historical data, and exploring component-level metrics within a SonarQube project. The foundational service is the FastMCP server, which manages the tool definitions and client-server communication.\r\n\r\n### 2. Problems the System Solves\r\n\r\nThe system solves the problem of programmatically accessing SonarQube data without requiring users to directly interact with the SonarQube API. It addresses the need for automated reporting, analysis, and integration of SonarQube metrics with other systems. Specifically, it simplifies tasks such as:\r\n\r\n* Generating regular reports on code quality metrics.\r\n* Monitoring trends in code quality over time.\r\n* Identifying problematic components within a project.\r\n* Integrating SonarQube data with other development tools.\r\n\r\nThe architecture solves these problems by providing a set of well-defined tools that abstract away the complexities of the SonarQube API and provide a consistent interface for accessing data.\r\n\r\n### 3. Interaction of Modules and Components\r\n\r\nThe system consists of two main components: the client and the server. The client initiates requests to the server, specifying the tool to be executed and any input parameters. The server receives the request, interacts with the SonarQube API, processes the data, and sends the results back to the client.\r\n\r\nThe interaction between the client and server is facilitated by the FastMCP framework, which handles message passing and serialization. The server defines the available tools using the `@mcp.tool()` decorator, which registers the functions as callable endpoints. The client invokes these tools using the `client.call_tool()` method, which sends a message to the server with the tool name and input parameters.\r\n\r\nThe server uses the `httpx` library to make asynchronous HTTP requests to the SonarQube API. It constructs the API URLs and request parameters based on the tool being executed and the input parameters provided by the client. The server then parses the JSON responses from the SonarQube API and extracts the relevant metric values.\r\n\r\n### 4. User-Facing vs. System-Facing Functionalities\r\n\r\nThe user-facing functionality of the system is the client application (`client_test.py`), which provides a command-line interface for invoking the SonarQube metric retrieval tools. Users interact with the client by providing a SonarQube project key and, optionally, other parameters such as date ranges or metric keys. The client then displays the retrieved metrics in a human-readable format.\r\n\r\nThe system-facing functionalities are the server-side tools (`get_sonarqube_metrics`, `get_sonarqube_metrics_history`, `get_sonarqube_component_tree_metrics`) defined in `server.py`. These tools handle the interaction with the SonarQube API, data processing, and formatting. They are not directly visible to end-users but are essential for providing the core functionality of the system.\r\n\r\nThe `@mcp.tool()` decorator systematically applies common behaviors across all tool functions, ensuring they are registered with the FastMCP server and accessible to clients. Additionally, the use of `Annotated` and `Field` ensures consistent parameter definition and documentation across all tools.\r\n\r\n## Architectural Patterns and Design Principles Applied\r\n\r\n* **Client-Server Architecture:** The project follows a client-server architecture, where the client requests services from the server.\r\n* **Message Passing:** The FastMCP framework facilitates communication between the client and server using message passing.\r\n* **Asynchronous Programming:** The use of `asyncio` and `httpx` enables asynchronous operations, improving the performance and responsiveness of the application.\r\n* **Configuration via Environment Variables:** The SonarQube URL and token are configured using environment variables, making it easier to deploy and manage the application in different environments.\r\n* **Tool-Based Design:** The server exposes functionality through well-defined tools, making it easy to add or modify features.\r\n* **Error Handling:** The project includes comprehensive error handling to gracefully handle potential issues, such as network errors, API errors, and invalid data.\r\n* **Logging:** The use of the `logging` module provides detailed logs, aiding in debugging and monitoring.\r\n* **Dependency Injection:** While not explicitly implemented as a framework, the configuration of the SonarQube URL and token through environment variables allows for easy substitution of different SonarQube instances without modifying the code.\r\n\r\n## Code Quality Analysis\r\n\r\nDue to the lack of a SonarQube report, a comprehensive code quality analysis cannot be performed. However, based on the code structure and functionality, potential areas of concern include:\r\n\r\n* **Error Handling Granularity:** While error handling is present, the specific error messages could be improved to provide more actionable information to the user.\r\n* **Test Coverage:** The provided code does not include unit tests. Test coverage should be added to ensure the reliability and correctness of the code.\r\n* **Code Duplication:** There might be opportunities to reduce code duplication by extracting common logic into reusable functions or classes.\r\n\r\n## Weaknesses and Areas for Improvement\r\n\r\n* **Improve error message clarity:** Enhance error messages to provide more specific guidance to users on how to resolve issues.\r\n* **Add unit tests:** Implement unit tests for the server-side tools to ensure their correctness and reliability.\r\n* **Refactor common logic:** Identify and refactor duplicated code into reusable functions or classes.\r\n* **Implement input validation:** Add input validation to the server-side tools to prevent invalid data from being processed.\r\n* **Improve documentation:** Add more detailed documentation for the server-side tools, including examples and usage instructions.\r\n* **Implement a more robust configuration system:** Consider using a more robust configuration system, such as a configuration file or a dedicated settings class, instead of relying solely on environment variables.\r\n* **Add support for additional SonarQube API endpoints:** Extend the system to support additional SonarQube API endpoints, such as those for managing projects, rules, or quality profiles.\r\n* **Implement a more user-friendly client interface:** Consider developing a graphical user interface (GUI) or a more sophisticated command-line interface (CLI) for the client application.\r\n* **Address potential security vulnerabilities:** Review the code for potential security vulnerabilities, such as those related to input validation or authentication.\r\n\r\n## Further Areas of Investigation\r\n\r\n* **Performance Bottlenecks:** Investigate potential performance bottlenecks in the server-side tools, such as those related to API request handling or data processing.\r\n* **Scalability Considerations:** Evaluate the scalability of the system and identify potential areas for improvement, such as using a message queue or a distributed caching system.\r\n* **Integrations with External Systems:** Explore potential integrations with other development tools, such as CI/CD systems or issue trackers.\r\n* **Advanced Features:** Research and implement advanced features, such as real-time metric monitoring or automated code quality analysis.\r\n* **Code Smells and Low Test Coverage:** Conduct a thorough analysis of the codebase to identify and address code smells and areas with low test coverage.\r\n\r\n## Attribution\r\n\r\nGenerated with the support of [ArchAI](https://github.com/ArchAI-Labs/code_explainer), an automated documentation system.","url","https://github.com/archai-labs/fastmcp-sonarqube-metrics","githubRepository",{"_118":119,"_120":121,"_122":123,"_124":125,"_33":126,"_127":128,"_133":134,"_135":136,"_138":139},"defaultBranch","main","fullName","ArchAI-Labs/fastmcp-sonarqube-metrics","githubTreeId",122467,"language","Python","fastmcp-sonarqube-metrics","owner",{"_129":130,"_131":132},"login","ArchAI-Labs","uid","YXkXcNJSp7","recentStargazers",1,"spdxLicense",{"_33":137},"Apache 2.0","stargazers",4,"glamaJson",6387,"inspectable",false,"integrations",[146,156],{"_147":148,"_31":154,"_131":155},"brand",{"_149":150,"_33":151,"_152":153},"logoSvgPath","M24 0v24H0V0h24ZM10.933 15.89H6.84v5.52h4.198v-.93H7.955v-1.503h2.77v-.93h-2.77v-1.224h2.978v-.934Zm2.146 0h-1.084v5.52h1.035v-3.6l2.226 3.6h1.118v-5.52h-1.036v3.686l-2.259-3.687Zm5.117 0h-1.208l1.973 5.52h1.19l1.976-5.52h-1.182l-1.352 4.085-1.397-4.086ZM5.4 19.68H3.72v1.68H5.4v-1.68Z",".ENV","slug","dotenv","Integrates with .ENV for configuration management, allowing the server to securely store and access SonarQube credentials (URL and token) through environment variables.","fkuw1pk7bz",{"_147":157,"_31":161,"_131":162},{"_149":158,"_33":159,"_152":160},"M15.685.386l-.465.766c3.477 2.112 6.305 5.27 7.966 8.89L24 9.67C22.266 5.887 19.313 2.59 15.685.386zM8.462.91l-.305 1.075c6.89 1.976 12.384 7.64 13.997 14.421l1.085-.258C21.535 8.977 15.735 2.997 8.462.909zM0 2.667v1.342c10.963 0 19.883 8.795 19.883 19.605h1.342c0-11.55-9.522-20.947-21.225-20.947z","SonarQube","sonarqube","Provides tools for retrieving metrics, historical data, and component tree metrics from SonarQube projects. Enables querying project status, listing projects, fetching code quality metrics (bugs, vulnerabilities, code smells, coverage, duplication density), and retrieving project issues with filtering options.","wjh257e89k","namespace","npmPackage","prompts","redditPostForeignId","resources","scores",{"_170":171,"_172":-5,"_173":-5},"license",100,"quality","security","simpleIcon","supportedPlatforms",[177,178,179],"WINDOWS","LINUX","MACOS","tools","go6xb5dq39","updatedAt","2025-05-28T19:04:04.820820771Z","meta",[186,189,191,198,201,203,206,209,212,215,218,220,223,226,228,230,232,234,236],{"_187":188},"title","FastMCP SonarQube Metrics | Glama",{"_190":42,"_33":31},"content",{"_192":193,"_194":195,"_196":197},"href","https://glama.ai/mcp/servers/@ArchAI-Labs/fastmcp-sonarqube-metrics","rel","canonical","tagName","link",{"_190":43,"_199":200},"property","og:title",{"_190":42,"_199":202},"og:description",{"_190":204,"_199":205},"https://glama.ai/logo.png","og:logo",{"_190":207,"_199":208},"https://glama.ai/mcp/servers/@ArchAI-Labs/fastmcp-sonarqube-metrics/og-image","og:image",{"_190":210,"_199":211},"630","og:image:height",{"_190":213,"_199":214},"1200","og:image:width",{"_190":216,"_199":217},"website","og:type",{"_190":193,"_199":219},"og:url",{"_190":221,"_199":222},"Glama – MCP Hosting Platform","og:site_name",{"_190":224,"_33":225},"summary_large_image","twitter:card",{"_190":221,"_33":227},"twitter:title",{"_190":42,"_33":229},"twitter:description",{"_190":207,"_33":231},"twitter:image",{"_190":210,"_33":233},"twitter:image:height",{"_190":213,"_33":235},"twitter:image:width",{"_237":238},"script:ld+json",{"_239":240,"_241":242},"@context","http://schema.org","@graph",[243],{"_239":244,"_245":246,"_247":248},"https://schema.org","@type","BreadcrumbList","itemListElement",[249,255,259,263],{"_245":250,"_251":252,"_33":253,"_254":134},"ListItem","item","https://glama.ai/","Glama","position",{"_245":250,"_251":256,"_33":257,"_254":258},"https://glama.ai/mcp","MCP",2,{"_245":250,"_251":260,"_33":261,"_254":262},"https://glama.ai/mcp/servers","Servers",3,{"_245":250,"_251":193,"_33":43,"_254":139},"visitorIsMaintainer","routes/_public/mcp/servers/~namespace/~slug/_pages/reviews/_route",{"_82":-5,"_29":267,"_184":285,"_320":-5},{"_85":86,"_87":268,"_13":273,"_109":42,"_110":42,"_111":274,"_116":275,"_140":-5,"_16":141,"_142":143,"_144":278,"_33":43,"_163":130,"_164":-5,"_165":-5,"_166":-5,"_167":-5,"_168":283,"_174":-5,"_152":126,"_175":284,"_180":-5,"_131":181,"_182":183},{"_89":269,"_99":272,"_94":101},{"_91":270,"_96":271},{"_31":93,"_94":95},{"_31":98,"_94":95},[91,96],[103,104,105,106,107,108],{"_35":113,"_114":115},{"_118":119,"_120":121,"_122":123,"_124":125,"_33":126,"_127":276,"_133":134,"_135":277,"_138":139},{"_129":130,"_131":132},{"_33":137},[279,281],{"_147":280,"_31":154,"_131":155},{"_149":150,"_33":151,"_152":153},{"_147":282,"_31":161,"_131":162},{"_149":158,"_33":159,"_152":160},{"_170":171,"_172":-5,"_173":-5},[177,178,179],[286,288,290,292,294,295,296,297,298,299,300,301,302,303,304,305,306,307,308],{"_187":287},"Reviews | FastMCP SonarQube Metrics | Glama",{"_190":289,"_33":31},"Read community reviews and feedback for FastMCP SonarQube Metrics. Discover user experiences, ratings, strengths, and potential limitations of this MCP implementation from actual users.",{"_192":291,"_194":195,"_196":197},"https://glama.ai/mcp/servers/@ArchAI-Labs/fastmcp-sonarqube-metrics/reviews",{"_190":293,"_199":200},"Reviews | FastMCP SonarQube Metrics",{"_190":289,"_199":202},{"_190":204,"_199":205},{"_190":207,"_199":208},{"_190":210,"_199":211},{"_190":213,"_199":214},{"_190":216,"_199":217},{"_190":291,"_199":219},{"_190":221,"_199":222},{"_190":224,"_33":225},{"_190":221,"_33":227},{"_190":289,"_33":229},{"_190":207,"_33":231},{"_190":210,"_33":233},{"_190":213,"_33":235},{"_237":309},{"_239":240,"_241":310},[311],{"_239":244,"_245":246,"_247":312},[313,314,315,316,317],{"_245":250,"_251":252,"_33":253,"_254":134},{"_245":250,"_251":256,"_33":257,"_254":258},{"_245":250,"_251":260,"_33":261,"_254":262},{"_245":250,"_251":193,"_33":43,"_254":139},{"_245":250,"_251":291,"_33":318,"_254":319},"Reviews",5,"review","actionData","errors"]

Rate & Review

MCP directory API