FastMCP SonarQube Metrics
by ArchAI-Labs
This project provides a set of tools for retrieving information about SonarQube projects using the FastMCP framework. It serves as an interface to SonarQube, allowing users to programmatically access metrics, historical data, and component tree metrics for specified projects.
Last updated: N/A
What is FastMCP SonarQube Metrics?
FastMCP SonarQube Metrics is a toolset designed to retrieve SonarQube project information using the Fast Model Context Protocol (FastMCP) framework. It abstracts the complexities of the SonarQube API, providing a simplified, message-based approach to accessing metrics, historical data, and component tree metrics.
How to use FastMCP SonarQube Metrics?
To use FastMCP SonarQube Metrics, you need a SonarQube instance with API access and a valid API token. Clone the repository, configure the .env file with your SonarQube URL and token, install the necessary dependencies (FastMCP, httpx, pydantic, python-dotenv), run the server (server.py), and then use a FastMCP client (like Claude Desktop or a custom client) to invoke the available tools.
Key features of FastMCP SonarQube Metrics
Retrieves SonarQube project metrics (bugs, vulnerabilities, code smells, coverage, duplication density).
Retrieves historical metrics for trend analysis.
Retrieves metric values for all components in a project.
Provides a simplified, message-based interface to the SonarQube API.
Use cases of FastMCP SonarQube Metrics
Automated reporting of code quality metrics.
Monitoring trends in code quality over time.
Identifying problematic components within a project.
Integrating SonarQube data with other development tools.
FAQ from FastMCP SonarQube Metrics
What is FastMCP?
What is FastMCP?
FastMCP (Fast Model Context Protocol) is a framework for building client-server applications that communicate using message passing.
What prerequisites are required to use this project?
What prerequisites are required to use this project?
Python 3.7+, a SonarQube instance with API access, a SonarQube API token, FastMCP, httpx, pydantic, and python-dotenv.
How do I configure the SonarQube URL and token?
How do I configure the SonarQube URL and token?
Create a .env file in the project root directory and set the SONARQUBE_URL and SONARQUBE_TOKEN environment variables.
How do I run the server?
How do I run the server?
Run the server.py script directly: python server.py.
What client should I use?
What client should I use?
While a test client is included, it is recommended to use Claude Desktop or develop your own custom client for production use.