SonarQube

Máy chủ MCP SonarQube

Máy chủ MCP SonarQube là một máy chủ Giao thức Ngữ cảnh Mô hình (MCP) cho phép tích hợp liền mạch với SonarQube Server hoặc Cloud để đảm bảo chất lượng mã và bảo mật. Nó cũng hỗ trợ phân tích các đoạn mã trực tiếp trong ngữ cảnh của tác nhân.

Thiết lập nhanh

🚀 Tạo cấu hình của bạn

Cách nhanh nhất để bắt đầu là Trình tạo cấu hình máy chủ MCP SonarQube – một công cụ tương tác tạo ra cấu hình sẵn sàng sử dụng cho ứng dụng khách tác nhân AI ưa thích của bạn.

Thiết lập thủ công

Nếu bạn muốn tự cấu hình, phương pháp đơn giản nhất là sử dụng hình ảnh container của chúng tôi tại sonarsource/sonarqube-mcp. Sử dụng sonarsource/sonarqube-mcp để cập nhật tự động (với --pull=always), hoặc ghim vào một thẻ phiên bản (ví dụ: sonarsource/sonarqube-mcp:1.19.0.2785) để triển khai có thể tái tạo. Đọc bên dưới nếu bạn muốn xây dựng cục bộ.

Lưu ý: Mặc dù các ví dụ bên dưới sử dụng docker, bất kỳ thời gian chạy container tương thích OCI nào cũng hoạt động (ví dụ: Podman, nerdctl). Chỉ cần thay thế docker bằng công cụ bạn ưa thích.

{
  "mcpServers": {
    "sonarqube": {
      "command": "docker",
      "args": ["run", "--init", "--pull=always", "-i", "--rm", "-e", "SONARQUBE_TOKEN", "-e", "SONARQUBE_ORG", "sonarsource/sonarqube-mcp"],
      "env": {
        "SONARQUBE_TOKEN": "<YOUR_TOKEN>",
        "SONARQUBE_ORG": "<YOUR_ORG>"
      }
    }
  }
}

{
  "mcpServers": {
    "sonarqube": {
      "command": "docker",
      "args": ["run", "--init", "--pull=always", "-i", "--rm", "-e", "SONARQUBE_TOKEN", "-e", "SONARQUBE_URL", "sonarsource/sonarqube-mcp"],
      "env": {
        "SONARQUBE_TOKEN": "<YOUR_USER_TOKEN>",
        "SONARQUBE_URL": "<YOUR_SERVER_URL>"
      }
    }
  }
}

claude mcp add sonarqube \
  --env SONARQUBE_TOKEN=$SONAR_TOKEN \
  --env SONARQUBE_ORG=$SONAR_ORG \
  -- docker run --init --pull=always -i --rm -e SONARQUBE_TOKEN -e SONARQUBE_ORG sonarsource/sonarqube-mcp

claude mcp add sonarqube \
  --env SONARQUBE_TOKEN=$SONAR_USER_TOKEN \
  --env SONARQUBE_URL=$SONAR_URL \
  -- docker run --init --pull=always -i --rm -e SONARQUBE_TOKEN -e SONARQUBE_URL sonarsource/sonarqube-mcp

[mcp_servers.sonarqube]
command = "docker"
args = ["run", "--init", "--pull=always", "--rm", "-i", "-e", "SONARQUBE_TOKEN", "-e", "SONARQUBE_ORG", "sonarsource/sonarqube-mcp"]
env = { "SONARQUBE_TOKEN" = "<YOUR_USER_TOKEN>", "SONARQUBE_ORG" = "<YOUR_ORG>" }

[mcp_servers.sonarqube]
command = "docker"
args = ["run", "--init", "--pull=always", "--rm", "-i", "-e", "SONARQUBE_TOKEN", "-e", "SONARQUBE_URL", "sonarsource/sonarqube-mcp"]
env = { "SONARQUBE_TOKEN" = "<YOUR_TOKEN>", "SONARQUBE_URL" = "<YOUR_SERVER_URL>" }

gemini extensions install https://github.com/SonarSource/sonarqube-agent-plugins

/mcp add

Server Name: sonarqube
Server Type: Local (Press 1)
Command: docker
Arguments: run, --init, --pull=always, --rm, -i, -e, SONARQUBE_TOKEN, -e, SONARQUBE_ORG, sonarsource/sonarqube-mcp
Environment Variables: SONARQUBE_TOKEN=<YOUR_TOKEN>,SONARQUBE_ORG=<YOUR_ORG>
Tools: *

Server Name: sonarqube
Server Type: Local (Press 1)
Command: docker
Arguments: run, --init, --pull=always, --rm, -i, -e, SONARQUBE_TOKEN, -e, SONARQUBE_URL, sonarsource/sonarqube-mcp
Environment Variables: SONARQUBE_TOKEN=<YOUR_USER_TOKEN>,SONARQUBE_URL=<YOUR_SERVER_URL>
Tools: *

{
  "mcpServers": {
    "sonarqube": {
      "type": "local",
      "command": "docker",
      "args": [
        "run",
        "--init",
        "--pull=always",
        "--rm",
        "-i",
        "-e",
        "SONARQUBE_TOKEN",
        "-e",
        "SONARQUBE_ORG",
        "sonarsource/sonarqube-mcp"
      ],
      "env": {
        "SONARQUBE_TOKEN": "COPILOT_MCP_SONARQUBE_TOKEN",
        "SONARQUBE_ORG": "COPILOT_MCP_SONARQUBE_ORG"
      },
      "tools": ["*"]
    }
  }
}

{
  "mcpServers": {
    "sonarqube": {
      "type": "local",
      "command": "docker",
      "args": [
        "run",
        "--init",
        "--pull=always",
        "--rm",
        "-i",
        "-e",
        "SONARQUBE_TOKEN",
        "-e",
        "SONARQUBE_URL",
        "sonarsource/sonarqube-mcp"
      ],
      "env": {
        "SONARQUBE_TOKEN": "COPILOT_MCP_SONARQUBE_USER_TOKEN",
        "SONARQUBE_URL": "COPILOT_MCP_SONARQUBE_URL"
      },
      "tools": ["*"]
    }
  }
}

{
  "mcpServers": {
    "sonarqube": {
      "command": "docker",
      "args": [
        "run",
        "--init",
        "--pull=always",
        "-i",
        "--rm",
        "-e", 
        "SONARQUBE_TOKEN",
        "-e",
        "SONARQUBE_ORG",
        "sonarsource/sonarqube-mcp"
      ],
      "env": {
        "SONARQUBE_TOKEN": "<YOUR_TOKEN>",
        "SONARQUBE_ORG": "<YOUR_ORG>"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

{
  "mcpServers": {
    "sonarqube": {
      "command": "docker",
      "args": [
        "run",
        "--init",
        "--pull=always",
        "-i",
        "--rm",
        "-e", 
        "SONARQUBE_TOKEN",
        "-e",
        "SONARQUBE_URL",
        "sonarsource/sonarqube-mcp"
      ],
      "env": {
        "SONARQUBE_TOKEN": "<YOUR_USER_TOKEN>",
        "SONARQUBE_URL": "<YOUR_SERVER_URL>"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

{
  "sonarqube_token": "YOUR_SONARQUBE_TOKEN",
  "sonarqube_org": "SONARQUBE_ORGANIZATION_KEY",
  "docker_path": "DOCKER_PATH"
}

{
  "sonarqube_token": "YOUR_SONARQUBE_USER_TOKEN",
  "sonarqube_url": "YOUR_SONARQUBE_SERVER_URL",
  "docker_path": "DOCKER_PATH"
}

💡 Mẹo: Chúng tôi khuyên bạn nên kéo hình ảnh mới nhất thường xuyên hoặc trước khi báo cáo sự cố để đảm bảo bạn có các tính năng và bản sửa lỗi mới nhất.

Cài đặt thủ công

Bạn có thể cài đặt thủ công máy chủ MCP SonarQube bằng cách sao chép đoạn mã sau vào tệp cấu hình máy chủ MCP:

• Để kết nối với SonarQube Cloud:

{
  "sonarqube": {
    "command": "docker",
    "args": [
      "run",
      "--init",
      "--pull=always",
      "-i",
      "--rm",
      "-e",
      "SONARQUBE_TOKEN",
      "-e",
      "SONARQUBE_ORG",
      "sonarsource/sonarqube-mcp"
    ],
    "env": {
      "SONARQUBE_TOKEN": "<token>",
      "SONARQUBE_ORG": "<org>"
    }
  }
}

• Để kết nối với SonarQube Server:

{
  "sonarqube": {
    "command": "docker",
    "args": [
      "run",
      "--init",
      "--pull=always",
      "-i",
      "--rm",
      "-e",
      "SONARQUBE_TOKEN",
      "-e",
      "SONARQUBE_URL",
      "sonarsource/sonarqube-mcp"
    ],
    "env": {
      "SONARQUBE_TOKEN": "<token>",
      "SONARQUBE_URL": "<url>"
    }
  }
}

Tích hợp với SonarQube cho IDE

Máy chủ MCP SonarQube có thể tích hợp với SonarQube cho IDE để nâng cao hơn nữa quy trình phát triển của bạn, cung cấp phân tích mã và thông tin chi tiết tốt hơn trực tiếp trong IDE của bạn.

{
  "sonarqube": {
    "command": "docker",
    "args": [
      "run",
      "--init",
      "--pull=always",
      "-i",
      "--rm",
      "-e",
      "SONARQUBE_TOKEN",
      "-e",
      "SONARQUBE_ORG",
      "-e",
      "SONARQUBE_IDE_PORT",
      "sonarsource/sonarqube-mcp"
    ],
    "env": {
      "SONARQUBE_TOKEN": "<token>",
      "SONARQUBE_ORG": "<org>",
      "SONARQUBE_IDE_PORT": "<64120-64130>"
    }
  }
}

Cấu hình

Tùy thuộc vào môi trường của bạn, bạn nên cung cấp các biến môi trường cụ thể.

Cơ bản

Bạn nên thêm biến sau khi chạy Máy chủ MCP:

Gắn kết không gian làm việc (Giảm độ phình ngữ cảnh)

Theo mặc định, công cụ phân tích analyze_code_snippet yêu cầu tác nhân truyền toàn bộ nội dung tệp dưới dạng đối số fileContent. Đối với các tệp lớn hoặc khi phân tích nhiều tệp trong một phiên, điều này làm tăng đáng kể việc sử dụng cửa sổ ngữ cảnh và chi phí. Giải pháp: gắn kết thư mục dự án của bạn vào container tại /app/mcp-workspace. Khi phát hiện mount này, máy chủ sẽ đọc tệp trực tiếp từ đĩa bằng đối số filePath tương đối với dự án — nội dung tệp không bao giờ đi qua ngữ cảnh của agent.

{
  "args": [
    "run", "-i", "--rm", "--init", "--pull=always",
    "-e", "SONARQUBE_TOKEN",
    "-e", "SONARQUBE_ORG",
    "-v", "/path/to/your/project:/app/mcp-workspace",
    "sonarsource/sonarqube-mcp"
  ]
}

Khi mount đang hoạt động:

• run_advanced_code_analysis sẽ khả dụng nếu tổ chức của bạn được cấp quyền sử dụng
• analyze_code_snippet: filePath là bắt buộc và fileContent không được sử dụng — máy chủ giải quyết tệp theo cùng cách

Kích hoạt công cụ có chọn lọc

Theo mặc định, chỉ các bộ công cụ quan trọng được kích hoạt để giảm chi phí ngữ cảnh. Bạn có thể kích hoạt thêm các bộ công cụ khác khi cần.

docker run --init --pull=always -i --rm \
  -e SONARQUBE_TOKEN="<token>" \
  -e SONARQUBE_ORG="<org>" \
  -e SONARQUBE_TOOLSETS="analysis,issues,quality-gates" \
  sonarsource/sonarqube-mcp

docker run --init --pull=always -i --rm \
  -e SONARQUBE_TOKEN="<token>" \
  -e SONARQUBE_ORG="<org>" \
  -e SONARQUBE_READ_ONLY="true" \
  sonarsource/sonarqube-mcp

SonarQube Cloud

Để kích hoạt đầy đủ chức năng, các biến môi trường sau phải được đặt trước khi khởi động máy chủ:

Ví dụ:

• SonarQube Cloud: Chỉ cần SONARQUBE_TOKEN và SONARQUBE_ORG
• SonarQube Cloud US: Đặt SONARQUBE_TOKEN, SONARQUBE_ORG và SONARQUBE_URL=https://sonarqube.us

SonarQube Server

Yêu cầu về phiên bản: Cần có SonarQube Server 2025.1 (SQS) hoặc 25.1 (SonarQube Community Build) trở lên. Khi khởi động, máy chủ MCP đọc phiên bản của instance đang kết nối và thoát với lỗi nếu phiên bản quá cũ (ví dụ: các bản phát hành Server 9.x/10.x cũ và Community Build 24.x không được hỗ trợ). SonarQube Cloud không phải chịu kiểm tra này.

⚠️ Kết nối đến SonarQube Server yêu cầu token loại USER và sẽ không hoạt động đúng nếu sử dụng project token hoặc global token.

💡 Mẹo cấu hình (chế độ stdio): Sự hiện diện của SONARQUBE_ORG xác định bạn đang kết nối đến SonarQube Cloud hay Server. Nếu SONARQUBE_ORG được thiết lập, SonarQube Cloud được sử dụng; nếu không, SonarQube Server được sử dụng.

Chế độ vận chuyển (Transport Modes)

Đặc tả MCP định nghĩa hai cơ chế vận chuyển: Stdio và Streamable HTTP. Máy chủ MCP SonarQube hỗ trợ cả hai:

Lưu ý: Streamable HTTP là mạng vận chuyển MCP hiện tại. Vận chuyển HTTP chỉ-SSE cũ hơn từ các phiên bản MCP trước đã bị không dùng nữa và không được hỗ trợ.

1. Stdio (Mặc định - Khuyến nghị cho Phát triển Cục bộ)

Chế độ khuyến nghị cho phát triển cục bộ và thiết lập một người dùng, được sử dụng bởi hầu hết các máy khách MCP.

Ví dụ - Docker với SonarQube Cloud:

{
  "mcpServers": {
    "sonarqube": {
      "command": "docker",
      "args": ["run", "--init", "--pull=always", "-i", "--rm", "-e", "SONARQUBE_TOKEN", "-e", "SONARQUBE_ORG", "sonarsource/sonarqube-mcp"],
      "env": {
        "SONARQUBE_TOKEN": "<your-token>",
        "SONARQUBE_ORG": "<your-org>"
      }
    }
  }
}

2. HTTP (Streamable HTTP)

Vận chuyển Streamable HTTP không mã hóa. Sử dụng HTTPS thay thế cho các triển khai nhiều người dùng.

⚠️ Không khuyến nghị: Sử dụng Stdio cho phát triển cục bộ hoặc HTTPS (Streamable HTTP) cho các triển khai sản xuất nhiều người dùng.

Lưu ý: Trong chế độ Streamable HTTP (HTTP hoặc HTTPS), máy chủ không trạng thái — mỗi yêu cầu của máy khách phải bao gồm tiêu đề Authorization: Bearer <token> mang token SonarQube của chính người dùng. Đối với SonarQube Cloud, tổ chức được giải quyết như sau:

• Nếu SONARQUBE_ORG được đặt khi khởi động máy chủ, tất cả các yêu cầu được định tuyến đến tổ chức đó. Máy khách không được gửi tiêu đề SONARQUBE_ORG — làm như vậy sẽ dẫn đến lỗi.
• Nếu SONARQUBE_ORG không được đặt khi khởi động máy chủ, mỗi máy khách phải cung cấp tiêu đề SONARQUBE_ORG trên mọi yêu cầu. Máy khách cũng có thể thu hẹp các công cụ hiển thị theo từng yêu cầu bằng cách cung cấp tiêu đề SONARQUBE_TOOLSETS và/hoặc SONARQUBE_READ_ONLY; các tiêu đề này áp dụng lọc bổ sung trên cấu hình cấp máy chủ — chúng chỉ có thể giảm phạm vi, không bao giờ mở rộng. Không có trạng thái phiên nào được duy trì giữa các yêu cầu.

Không dùng nữa: Tiêu đề yêu cầu SONARQUBE_TOKEN vẫn được chấp nhận để tương thích ngược nhưng sẽ bị xóa trong phiên bản tương lai. Di chuyển sang Authorization: Bearer <token>.

3. HTTPS (Streamable HTTP qua TLS) (Khuyến nghị cho Triển khai Sản xuất Nhiều người dùng)

Vận chuyển Streamable HTTP an toàn với mã hóa TLS. Yêu cầu chứng chỉ SSL.

✅ Khuyến nghị cho Sản xuất: Sử dụng HTTPS khi triển khai máy chủ MCP cho nhiều người dùng qua Streamable HTTP. Máy chủ ràng buộc với 127.0.0.1 (localhost) theo mặc định vì lý do bảo mật.

Cấu hình Chứng chỉ SSL (Tùy chọn):

Ví dụ - Docker với SonarQube Cloud:

Lưu ý: Khi chạy trong container, đặt SONARQUBE_HTTP_HOST=0.0.0.0 để container lắng nghe trên tất cả các giao diện và ánh xạ cổng của runtime hoạt động, và đặt SONARQUBE_MCP_IN_CONTAINER=true để báo cho máy chủ biết nó đang ở trong container. Hình ảnh Docker chính thức tự động đặt giá trị sau; tự đặt khi sử dụng các OCI runtime khác (Podman, Kubernetes, Nomad, v.v.). Cờ cổng phía máy chủ kiểm soát ai có thể truy cập máy chủ từ bên ngoài container. SONARQUBE_HTTP_HOST=0.0.0.0 chỉ kiểm soát nơi máy chủ lắng nghe bên trong container — CORS trình duyệt vẫn cho phép nguồn gốc localhost theo mặc định.

Đối với máy chủ chạy cục bộ trên máy của bạn (chỉ truy cập từ localhost):

docker run --init --pull=always -p 127.0.0.1:8443:8443 \
  -v $(pwd)/keystore.p12:/etc/ssl/mcp/keystore.p12:ro \
  -e SONARQUBE_TRANSPORT=https \
  -e SONARQUBE_HTTP_HOST=0.0.0.0 \
  -e SONARQUBE_HTTP_PORT=8443 \
  -e SONARQUBE_TOKEN="<init-token>" \
  -e SONARQUBE_ORG="<your-org>" \
  sonarsource/sonarqube-mcp

Đối với máy chủ truy cập từ mạng (triển khai từ xa):

docker run --init --pull=always -p 8443:8443 \
  -v $(pwd)/keystore.p12:/etc/ssl/mcp/keystore.p12:ro \
  -e SONARQUBE_TRANSPORT=https \
  -e SONARQUBE_HTTP_HOST=0.0.0.0 \
  -e SONARQUBE_HTTP_PORT=8443 \
  -e SONARQUBE_TOKEN="<init-token>" \
  -e SONARQUBE_ORG="<your-org>" \
  sonarsource/sonarqube-mcp

Cấu hình Máy khách (SonarQube Cloud):

{
  "mcpServers": {
    "sonarqube-https": {
      "url": "https://your-server:8443/mcp",
      "headers": {
        "Authorization": "Bearer <your-token>",
        "SONARQUBE_ORG": "<your-org>",
        "SONARQUBE_TOOLSETS": "issues,quality-gates",
        "SONARQUBE_READ_ONLY": "true"
      }
    }
  }
}

Cấu hình Máy khách (SonarQube Server):

{
  "mcpServers": {
    "sonarqube-https": {
      "url": "https://your-server:8443/mcp",
      "headers": {
        "Authorization": "Bearer <your-token>",
        "SONARQUBE_TOOLSETS": "issues,quality-gates",
        "SONARQUBE_READ_ONLY": "true"
      }
    }
  }
}

Lưu ý: SONARQUBE_TOOLSETS và SONARQUBE_READ_ONLY là các tiêu đề tùy chọn theo từng yêu cầu thu hẹp bộ công cụ cấp máy chủ cho yêu cầu cụ thể đó. Chúng chỉ có thể giảm phạm vi — chúng không thể bật bộ công cụ hoặc gỡ bỏ các hạn chế vượt quá những gì máy chủ được khởi chạy.

Lưu ý: Đối với phát triển cục bộ, hãy sử dụng vận chuyển Stdio thay thế (mặc định). HTTPS Streamable HTTP dành cho các triển khai sản xuất nhiều người dùng với chứng chỉ SSL phù hợp.

Điểm cuối Dịch vụ

Khi chạy ở chế độ Streamable HTTP (http hoặc https), máy chủ hiển thị một vài điểm cuối dịch vụ không xác thực ngoài điểm cuối MCP tại /mcp. Các điểm cuối này dành cho sử dụng dịch vụ-đến-dịch vụ (giám sát, điều phối, kiểm tra tương thích máy khách) và không yêu cầu tiêu đề Authorization.

Các điểm cuối này không khả dụng khi chạy với vận chuyển Stdio.

Chứng chỉ Tùy chỉnh

Nếu SonarQube Server của bạn sử dụng chứng chỉ tự ký hoặc chứng chỉ từ Cơ quan cấp chứng chỉ (CA) riêng, bạn có thể thêm chứng chỉ tùy chỉnh vào container và chúng sẽ được cài đặt tự động.

docker run --init --pull=always -i --rm \
  -v /path/to/your/certificates/:/usr/local/share/ca-certificates/:ro \
  -e SONARQUBE_TOKEN="<token>" \
  -e SONARQUBE_URL="<url>" \
  sonarsource/sonarqube-mcp

{
  "sonarqube": {
    "command": "docker",
    "args": [
      "run",
      "--init",
      "--pull=always",
      "-i",
      "--rm",
      "-v",
      "/path/to/your/certificates/:/usr/local/share/ca-certificates/:ro",
      "-e",
      "SONARQUBE_TOKEN",
      "-e",
      "SONARQUBE_URL",
      "sonarsource/sonarqube-mcp"
    ],
    "env": {
      "SONARQUBE_TOKEN": "<token>",
      "SONARQUBE_URL": "<url>"
    }
  }
}

Proxy

Máy chủ MCP SonarQube hỗ trợ proxy HTTP và SOCKS5 thông qua các thuộc tính hệ thống proxy Java tiêu chuẩn.

Chứng chỉ máy khách (Mutual TLS)

Nếu máy chủ SonarQube của bạn yêu cầu máy khách phải xuất trình chứng chỉ trong quá trình bắt tay TLS (mutual TLS), bạn có thể cung cấp kho khóa PKCS12 bằng cách gắn nó vào container và truyền vị trí của nó qua JAVA_OPTS.

docker run --init --pull=always -i --rm \
  -v /path/to/client.p12:/etc/ssl/mcp/client.p12:ro \
  -e JAVA_OPTS="-Djavax.net.ssl.keyStore=/etc/ssl/mcp/client.p12 -Djavax.net.ssl.keyStoreType=PKCS12 -Djavax.net.ssl.keyStorePassword=<passphrase>" \
  -e SONARQUBE_TOKEN="<token>" \
  -e SONARQUBE_URL="<url>" \
  sonarsource/sonarqube-mcp

{
  "sonarqube": {
    "command": "docker",
    "args": [
      "run", "--init", "--pull=always", "-i", "--rm",
      "-v", "/path/to/client.p12:/etc/ssl/mcp/client.p12:ro",
      "-e", "JAVA_OPTS",
      "-e", "SONARQUBE_TOKEN",
      "-e", "SONARQUBE_URL",
      "sonarsource/sonarqube-mcp"
    ],
    "env": {
      "JAVA_OPTS": "-Djavax.net.ssl.keyStore=/etc/ssl/mcp/client.p12 -Djavax.net.ssl.keyStoreType=PKCS12 -Djavax.net.ssl.keyStorePassword=<passphrase>",
      "SONARQUBE_TOKEN": "<token>",
      "SONARQUBE_URL": "<url>"
    }
  }
}

java \
  -Djavax.net.ssl.keyStore=/path/to/client.p12 \
  -Djavax.net.ssl.keyStoreType=PKCS12 \
  -Djavax.net.ssl.keyStorePassword=<passphrase> \
  -jar <path_to_sonarqube_mcp_server_jar>

{
  "sonarqube": {
    "command": "java",
    "args": [
      "-Djavax.net.ssl.keyStore=/path/to/client.p12",
      "-Djavax.net.ssl.keyStoreType=PKCS12",
      "-Djavax.net.ssl.keyStorePassword=<passphrase>",
      "-jar",
      "<path_to_sonarqube_mcp_server_jar>"
    ],
    "env": {
      "SONARQUBE_TOKEN": "<token>",
      "SONARQUBE_URL": "<url>"
    }
  }
}

Công cụ

Phân tích

• analyze_code_snippet - Phân tích nội dung tệp bằng trình phân tích SonarQube để xác định các vấn đề về chất lượng mã và bảo mật. Luôn phân tích toàn bộ nội dung tệp để đảm bảo độ chính xác. Tùy chọn lọc kết quả theo một đoạn mã cụ thể.

  Không dùng nữa: analyze_code_snippet sẽ bị xóa trong bản phát hành tương lai. Kết nối SonarQube for IDE để sử dụng analyze_file_list, hoặc bật phân tích Vortex cho tổ chức của bạn để sử dụng run_advanced_code_analysis (xem bên dưới).

  Cách sử dụng:

  • Với workspace được gắn (khuyến nghị): truyền filePath (tương đối theo dự án) — máy chủ đọc tệp trực tiếp, giữ nội dung tệp ngoài cửa sổ ngữ cảnh của agent
  • Không gắn workspace: truyền fileContent đầy đủ để phân tích toàn bộ tệp (báo cáo tất cả các vấn đề)
  • Thêm codeSnippet tùy chọn để lọc kết quả - chỉ các vấn đề trong đoạn mã sẽ được báo cáo (vị trí đoạn mã được tự động phát hiện)

  Tham số:

  • projectKey - Khóa dự án SonarQube - Chuỗi bắt buộc (Bị bỏ qua khi SONARQUBE_PROJECT_KEY được xác định)
  • filePath - Đường dẫn tương đối theo dự án của tệp cần phân tích (ví dụ: src/main/java/MyClass.java). Được sử dụng khi workspace được gắn tại /app/mcp-workspace - Chuỗi
  • fileContent - Toàn bộ nội dung tệp dưới dạng chuỗi. Bắt buộc khi workspace không được gắn - Chuỗi
  • codeSnippet - Đoạn mã để lọc vấn đề (phải khớp với nội dung trong fileContent) - Chuỗi
  • language - Ngôn ngữ của mã (ví dụ: 'java', 'python', 'js', 'ts', 'tsx', 'jsx') - Chuỗi
  • scope - Phạm vi của tệp: MAIN hoặc TEST (mặc định: MAIN) - Chuỗi

  Ngôn ngữ được hỗ trợ: Java, Kotlin, Python, Ruby, Go, JavaScript (js, jsx), TypeScript (ts, tsx), JSP, PHP, XML, HTML, CSS, CloudFormation, Kubernetes, Terraform, Azure Resource Manager, Ansible, Docker, Phát hiện bí mật

Khi tích hợp với SonarQube for IDE được bật: (hai công cụ này được gắn thẻ trong cả bộ công cụ analysis và ide)

• analyze_file_list - Phân tích các tệp trong thư mục làm việc hiện tại bằng SonarQube for IDE. Công cụ này kết nối đến một phiên bản SonarQube for IDE đang chạy để thực hiện phân tích chất lượng mã trên danh sách các tệp.

  • file_absolute_paths - Danh sách đường dẫn tệp tuyệt đối để phân tích - Mảng chuỗi bắt buộc

• toggle_automatic_analysis - Bật hoặc tắt phân tích tự động của SonarQube for IDE. Khi được bật, SonarQube for IDE sẽ tự động phân tích các tệp khi chúng được sửa đổi trong thư mục làm việc. Khi bị tắt, phân tích tự động sẽ bị vô hiệu hóa.

  • enabled - Bật hoặc tắt phân tích tự động - Boolean bắt buộc

Trên SonarQube Server, stdio liệt kê các công cụ ngữ cảnh Vortex và run_advanced_code_analysis khi cả hai hub CAG và A3S đều được cấp phép.

Khi phân tích Vortex được bật:

Yêu cầu workspace được gắn tại /app/mcp-workspace

• run_advanced_code_analysis - Chạy phân tích Vortex trên một tệp duy nhất. Tổ chức được suy ra từ cấu hình MCP (SonarQube Server sử dụng trình giữ chỗ UUID nil).
  • projectKey - Khóa của dự án - Chuỗi bắt buộc (Bị bỏ qua khi SONARQUBE_PROJECT_KEY được xác định)
  • branch - Tên nhánh được sử dụng để truy xuất ngữ cảnh phân tích mới nhất - Chuỗi bắt buộc
  • filePath - Đường dẫn tương đối theo dự án của tệp cần phân tích (ví dụ: src/main/java/MyClass.java). - Chuỗi bắt buộc
  • fileScope - Xác định phạm vi mà tệp bắt nguồn: 'MAIN' hoặc 'TEST' (mặc định: MAIN) - Chuỗi

Độ phủ

• search_files_by_coverage - Tìm kiếm các tệp trong một dự án được sắp xếp theo độ phủ (tăng dần - độ phủ kém nhất trước). Công cụ này giúp xác định các tệp cần cải thiện độ phủ kiểm thử.

  • projectKey - Khóa dự án để tìm kiếm - Chuỗi bắt buộc (Bị bỏ qua khi SONARQUBE_PROJECT_KEY được xác định)
  • branch - Tên nhánh tùy chọn cho phân tích dựa trên nhánh. Sử dụng list_branches để khám phá các tên hợp lệ - Chuỗi
  • pullRequest - Khóa/ID yêu cầu kéo tùy chọn. Sử dụng list_pull_requests để khám phá các khóa hợp lệ - Chuỗi
  • maxCoverage - Ngưỡng độ phủ tối đa (0-100). Chỉ trả về các tệp có độ phủ <= giá trị này - Số
  • pageIndex - Chỉ số trang (1-based, mặc định: 1) - Số
  • pageSize - Kích thước trang (mặc định: 100, tối đa: 500) - Số

• get_file_coverage_details - Lấy thông tin độ phủ theo từng dòng cho một tệp cụ thể, bao gồm chính xác các dòng không được phủ và các dòng có nhánh được phủ một phần. Công cụ này giúp xác định chính xác nơi cần thêm độ phủ kiểm thử. Sử dụng sau khi xác định các tệp có độ phủ thấp qua search_files_by_coverage.

  • key - Khóa tệp (ví dụ: my_project:src/foo/Bar.java) - Chuỗi bắt buộc
  • branch - Tên nhánh tùy chọn cho phân tích dựa trên nhánh. Sử dụng list_branches để khám phá các tên hợp lệ - Chuỗi
  • pullRequest - Khóa/ID yêu cầu kéo tùy chọn. Sử dụng list_pull_requests để khám phá các khóa hợp lệ - Chuỗi
  • from - Dòng đầu tiên để phân tích (1-based, mặc định: 1) - Số
  • to - Dòng cuối cùng để phân tích (bao gồm). Nếu không được chỉ định, tất cả các dòng sẽ được trả về - Số

Rủi ro phụ thuộc

Lưu ý: Rủi ro phụ thuộc chỉ khả dụng khi kết nối với SonarQube Server 2025.4 Enterprise trở lên với SonarQube Advanced Security được bật.

• search_dependency_risks - Tìm kiếm các vấn đề phân tích thành phần phần mềm (rủi ro phụ thuộc) của một dự án SonarQube, kết hợp với các bản phát hành xuất hiện trong dự án, ứng dụng hoặc danh mục đầu tư được phân tích.
  • projectKey - Khóa dự án - Chuỗi bắt buộc (Bị bỏ qua khi SONARQUBE_PROJECT_KEY được xác định)
  • branch - Tên nhánh tùy chọn cho phân tích dựa trên nhánh. Sử dụng list_branches để khám phá các tên hợp lệ - Chuỗi
  • pullRequest - Khóa/ID yêu cầu kéo tùy chọn. Sử dụng list_pull_requests để khám phá các khóa hợp lệ - Chuỗi
  • pageIndex - Chỉ số trang tùy chọn (1-based, mặc định: 1) - Số nguyên
  • pageSize - Kích thước trang tùy chọn. Phải lớn hơn 0 và nhỏ hơn hoặc bằng 500 (mặc định: 100) - Số nguyên

Doanh nghiệp

Lưu ý: Doanh nghiệp chỉ khả dụng khi kết nối với SonarQube Cloud.

• list_enterprises - Liệt kê các doanh nghiệp khả dụng trong SonarQube Cloud mà bạn có quyền truy cập. Sử dụng công cụ này để khám phá ID doanh nghiệp có thể được sử dụng với các công cụ khác.
  • enterpriseKey - Khóa doanh nghiệp tùy chọn để lọc kết quả - Chuỗi

Vấn đề

• change_sonar_issue_status - Thay đổi trạng thái của một vấn đề SonarQube thành "accept", "falsepositive" hoặc "reopen" một vấn đề.

  • key - Khóa vấn đề - Chuỗi bắt buộc
  • status - Trạng thái mới của vấn đề - Enum bắt buộc {"accept", "falsepositive", "reopen"}
  • comment - Bình luận tùy chọn giải thích thay đổi trạng thái - Chuỗi

• search_sonar_issues_in_projects - Tìm kiếm các vấn đề SonarQube trong các dự án của tổ chức tôi.

  • projectKeys - Danh sách khóa dự án SonarQube tùy chọn - Mảng chuỗi
  • branch - Tên nhánh tùy chọn cho phân tích dựa trên nhánh. Sử dụng list_branches để khám phá các tên hợp lệ - Chuỗi
  • pullRequest - Khóa/ID yêu cầu kéo tùy chọn. Sử dụng list_pull_requests để khám phá các khóa hợp lệ - Chuỗi
  • severities - Danh sách mức độ nghiêm trọng tùy chọn để lọc. Các giá trị có thể: INFO, LOW, MEDIUM, HIGH, BLOCKER - Mảng chuỗi
  • impactSoftwareQualities - Danh sách chất lượng phần mềm tùy chọn để lọc. Các giá trị có thể: MAINTAINABILITY, RELIABILITY, SECURITY - Mảng chuỗi
  • issueStatuses - Danh sách trạng thái vấn đề tùy chọn để lọc. Các giá trị có thể: OPEN, CONFIRMED, FALSE_POSITIVE, ACCEPTED, FIXED, IN_SANDBOX - Mảng chuỗi
  • tags - Danh sách thẻ vấn đề tùy chọn để lọc. Các thẻ ở dạng chữ thường - Mảng chuỗi
  • inNewCodePeriod - Chỉ trả về các vấn đề trong giai đoạn mã mới. Yêu cầu chính xác một mục trong projectKeys và files - Boolean
  • issueKey - Khóa vấn đề tùy chọn để tìm nạp một vấn đề cụ thể - Chuỗi
  • pageIndex - Chỉ số trang tùy chọn (1-based, mặc định: 1) - Số nguyên
  • pageSize - Kích thước trang tùy chọn. Phải lớn hơn 0 và nhỏ hơn hoặc bằng 500 (mặc định: 100) - Số nguyên

Điểm nóng bảo mật

• search_security_hotspots - Tìm kiếm các Điểm nóng bảo mật trong một dự án SonarQube.

  • projectKey - Khóa dự án hoặc ứng dụng - Chuỗi bắt buộc (Bị bỏ qua khi SONARQUBE_PROJECT_KEY được xác định)
  • hotspotKeys - Danh sách phân tách bằng dấu phẩy các khóa Điểm nóng bảo mật cụ thể để truy xuất - Mảng chuỗi
  • branch - Tên nhánh tùy chọn cho phân tích dựa trên nhánh. Sử dụng list_branches để khám phá các tên hợp lệ - Chuỗi
  • pullRequest - Khóa/ID yêu cầu kéo tùy chọn. Sử dụng list_pull_requests để khám phá các khóa hợp lệ - Chuỗi
  • files - Danh sách đường dẫn tệp tùy chọn để lọc - Mảng chuỗi
  • status - Bộ lọc trạng thái tùy chọn: TO_REVIEW, REVIEWED - Chuỗi
  • resolution - Bộ lọc giải pháp tùy chọn: FIXED, SAFE, ACKNOWLEDGED - Chuỗi
  • sinceLeakPeriod - Lọc các điểm nóng được tạo kể từ giai đoạn rò rỉ (mã mới) - Boolean
  • onlyMine - Chỉ hiển thị các điểm nóng được gán cho tôi - Boolean
  • pageIndex - Chỉ số trang tùy chọn (1-based, mặc định: 1) - Số nguyên
  • pageSize - Kích thước trang tùy chọn. Phải lớn hơn 0 và nhỏ hơn hoặc bằng 500 (mặc định: 100) - Số nguyên

• show_security_hotspot - Lấy thông tin chi tiết về một Điểm nóng bảo mật cụ thể, bao gồm chi tiết quy tắc, ngữ cảnh mã, luồng và bình luận.

  • hotspotKey - Khóa Điểm nóng bảo mật - Chuỗi bắt buộc

• change_security_hotspot_status - Xem xét một Security Hotspot bằng cách thay đổi trạng thái của nó. Khi đánh dấu là REVIEWED, bạn phải chỉ định một resolution (FIXED, SAFE, hoặc ACKNOWLEDGED).

  • hotspotKey - Khóa Security Hotspot - Bắt buộc, Chuỗi
  • status - Trạng thái mới - Bắt buộc, Enum {"TO_REVIEW", "REVIEWED"}
  • resolution - Resolution khi trạng thái là REVIEWED - Enum {"FIXED", "SAFE", "ACKNOWLEDGED"}
  • comment - Nhận xét xem xét tùy chọn - Chuỗi

Ngôn ngữ

• list_languages - Liệt kê tất cả ngôn ngữ lập trình được hỗ trợ trong phiên bản SonarQube này.
  • q - Mẫu tùy chọn để khớp với khóa/tên ngôn ngữ - Chuỗi

Đo lường

• get_component_measures - Lấy các đo lường SonarQube cho một thành phần (dự án, thư mục, tệp).
  • projectKey - Khóa dự án - Bắt buộc, Chuỗi khi SONARQUBE_PROJECT_KEY không được cấu hình
  • branch - Tên nhánh tùy chọn cho phân tích dựa trên nhánh. Sử dụng list_branches để khám phá các tên hợp lệ - Chuỗi
  • metricKeys - Các khóa chỉ số tùy chọn để truy xuất (ví dụ: ncloc, complexity, violations, coverage) - Mảng chuỗi
  • pullRequest - Khóa/ID pull request tùy chọn. Sử dụng list_pull_requests để khám phá các khóa hợp lệ - Chuỗi

Chỉ số

• search_metrics - Tìm kiếm các chỉ số SonarQube.
  • pageIndex - Chỉ mục trang tùy chọn bắt đầu từ 1 (mặc định: 1) - Số nguyên
  • pageSize - Kích thước trang tùy chọn. Phải lớn hơn 0 và nhỏ hơn hoặc bằng 500 (mặc định: 100) - Số nguyên

Danh mục đầu tư

• list_portfolios - Liệt kê các danh mục đầu tư doanh nghiệp có sẵn trong SonarQube với các tùy chọn lọc và phân trang.

  Đối với SonarQube Server:

  • q - Truy vấn tìm kiếm tùy chọn để lọc danh mục đầu tư theo tên hoặc khóa - Chuỗi
  • favorite - Nếu đúng, chỉ trả về các danh mục đầu tư yêu thích - Boolean
  • pageIndex - Số trang tùy chọn bắt đầu từ 1 (mặc định: 1) - Số nguyên
  • pageSize - Kích thước trang tùy chọn, tối đa 500 (mặc định: 100) - Số nguyên

  Đối với SonarQube Cloud:

  • enterpriseId - Enterprise uuid. Có thể bỏ qua chỉ khi tham số 'favorite' được cung cấp với giá trị true - Chuỗi
  • q - Truy vấn tìm kiếm tùy chọn để lọc danh mục đầu tư theo tên - Chuỗi
  • favorite - Bắt buộc phải là true nếu tham số 'enterpriseId' bị bỏ qua. Nếu true, chỉ trả về các danh mục đầu tư được người dùng đã đăng nhập yêu thích. Không thể là true khi 'draft' là true - Boolean
  • draft - Nếu true, chỉ trả về các bản nháp do người dùng đã đăng nhập tạo. Không thể là true khi 'favorite' là true - Boolean
  • pageIndex - Chỉ mục trang tùy chọn để tìm nạp (mặc định: 1) - Số nguyên
  • pageSize - Kích thước trang tùy chọn để tìm nạp (mặc định: 50) - Số nguyên

Dự án

• search_my_sonarqube_projects - Tìm các dự án SonarQube. Phản hồi được phân trang.

  • pageIndex - Chỉ mục trang tùy chọn bắt đầu từ 1 (mặc định: 1) - Số nguyên
  • pageSize - Kích thước trang tùy chọn. Phải lớn hơn 0 và nhỏ hơn hoặc bằng 500 (mặc định: 500) - Số nguyên
  • q - Truy vấn tìm kiếm tùy chọn để lọc dự án theo tên (khớp một phần) hoặc khóa (khớp chính xác) - Chuỗi

• list_branches - Liệt kê các nhánh đã phân tích cho một dự án.

  • SonarQube Cloud: trả về các nhánh dài hạn (LONG) và ngắn hạn (SHORT) với các trường type và mergeBranch. Bộ lọc branchTypes tùy chọn: ALL (mặc định), LONG, hoặc SHORT.
  • SonarQube Server: trả về tất cả các nhánh đã phân tích (tên, cổng chất lượng, ngày phân tích). Không có bộ lọc type, mergeBranch, hoặc branchTypes.
  • Sử dụng tên nhánh được trả về làm tham số branch trên các công cụ khác. Đối với phân tích pull request, hãy sử dụng list_pull_requests thay thế.
  • projectKey - Khóa dự án (ví dụ: my_project) - Bắt buộc, Chuỗi (Bị bỏ qua khi SONARQUBE_PROJECT_KEY được xác định)
  • branchTypes - (Chỉ dành cho SonarQube Cloud) Bộ lọc tùy chọn: ALL (mặc định), LONG, hoặc SHORT - Enum {"ALL", "LONG", "SHORT"}

• list_pull_requests - Liệt kê tất cả các pull request cho một dự án. Sử dụng công cụ này để khám phá các pull request cho phân tích được trang trí PR (coverage, issues, quality gate). Trả về khóa/ID pull request có thể được sử dụng với các công cụ khác. Đối với phân tích dựa trên nhánh không có pull request, hãy sử dụng list_branches thay thế.

  • projectKey - Khóa dự án (ví dụ: my_project) - Bắt buộc, Chuỗi (Bị bỏ qua khi SONARQUBE_PROJECT_KEY được xác định)

Cổng chất lượng

• get_project_quality_gate_status - Lấy trạng thái Cổng chất lượng cho dự án SonarQube.

  • analysisId - ID phân tích tùy chọn - Chuỗi
  • branch - Tên nhánh tùy chọn cho phân tích dựa trên nhánh. Sử dụng list_branches để khám phá các tên hợp lệ - Chuỗi
  • projectId - ID dự án tùy chọn - Chuỗi
  • projectKey - Khóa dự án tùy chọn - Chuỗi
  • pullRequest - Khóa/ID pull request tùy chọn. Sử dụng list_pull_requests để khám phá các khóa hợp lệ - Chuỗi

• list_quality_gates - Liệt kê tất cả các cổng chất lượng trong SonarQube của tôi.

Quy tắc

• show_rule - Hiển thị thông tin chi tiết về một quy tắc SonarQube.
  • key - Khóa quy tắc - Bắt buộc, Chuỗi

Trùng lặp

• search_duplicated_files - Tìm kiếm các tệp có trùng lặp mã trong một dự án SonarQube. Theo mặc định, tự động tìm nạp tất cả các tệp trùng lặp trên tất cả các trang (tối đa 10.000 tệp). Chỉ trả về các tệp có trùng lặp.

  • projectKey - Khóa dự án - Bắt buộc, Chuỗi (Bị bỏ qua khi SONARQUBE_PROJECT_KEY được xác định)
  • branch - Tên nhánh tùy chọn cho phân tích dựa trên nhánh. Sử dụng list_branches để khám phá các tên hợp lệ - Chuỗi
  • pullRequest - Khóa/ID pull request tùy chọn. Sử dụng list_pull_requests để khám phá các khóa hợp lệ - Chuỗi
  • pageSize - Số lượng kết quả tùy chọn trên mỗi trang để phân trang thủ công (tối đa: 500). Nếu không được chỉ định, tự động tìm nạp tất cả các tệp trùng lặp - Số nguyên
  • pageIndex - Số trang tùy chọn để phân trang thủ công (bắt đầu từ 1). Nếu không được chỉ định, tự động tìm nạp tất cả các tệp trùng lặp - Số nguyên

• get_duplications - Lấy trùng lặp cho một tệp. Yêu cầu quyền Browse trên dự án của tệp.

  • key - Khóa tệp - Bắt buộc, Chuỗi
  • branch - Tên nhánh tùy chọn cho phân tích dựa trên nhánh. Sử dụng list_branches để khám phá các tên hợp lệ - Chuỗi
  • pullRequest - Khóa/ID pull request tùy chọn. Sử dụng list_pull_requests để khám phá các khóa hợp lệ - Chuỗi

Nguồn

• get_raw_source - Lấy mã nguồn dưới dạng văn bản thô từ SonarQube. Yêu cầu quyền 'See Source Code' trên tệp.

  • key - Khóa tệp - Bắt buộc, Chuỗi
  • branch - Tên nhánh tùy chọn cho phân tích dựa trên nhánh. Sử dụng list_branches để khám phá các tên hợp lệ - Chuỗi
  • pullRequest - Khóa/ID pull request tùy chọn. Sử dụng list_pull_requests để khám phá các khóa hợp lệ - Chuỗi

• get_scm_info - Lấy thông tin SCM của các tệp nguồn SonarQube. Yêu cầu quyền See Source Code trên dự án của tệp.

  • key - Khóa tệp - Bắt buộc, Chuỗi
  • commits_by_line - Nhóm các dòng theo commit SCM nếu giá trị là false, nếu không hiển thị các commit cho từng dòng - Chuỗi
  • from - Dòng đầu tiên để trả về. Bắt đầu từ 1 - Số
  • to - Dòng cuối cùng để trả về (bao gồm) - Số

Hệ thống

Lưu ý: Các công cụ hệ thống chỉ khả dụng khi kết nối với SonarQube Server.

• get_system_health - Lấy trạng thái sức khỏe của phiên bản SonarQube Server. Trả về GREEN (hoạt động đầy đủ), YELLOW (khả dụng nhưng cần chú ý), hoặc RED (không hoạt động).

• get_system_info - Lấy thông tin chi tiết về cấu hình hệ thống SonarQube Server bao gồm trạng thái JVM, cơ sở dữ liệu, chỉ mục tìm kiếm và cài đặt. Yêu cầu quyền 'Administer'.

• get_system_logs - Lấy nhật ký hệ thống SonarQube Server ở định dạng văn bản thuần túy. Yêu cầu quyền quản trị hệ thống.

  • name - Tên tùy chọn của nhật ký để lấy. Các giá trị có thể: access, app, ce, deprecation, es, web. Mặc định: app - Chuỗi

• ping_system - Ping hệ thống SonarQube Server để kiểm tra xem nó có hoạt động không. Trả về 'pong' dưới dạng văn bản thuần túy.

• get_system_status - Lấy thông tin trạng thái về SonarQube Server. Trả về trạng thái (STARTING, UP, DOWN, RESTARTING, DB_MIGRATION_NEEDED, DB_MIGRATION_RUNNING), phiên bản và id.

Webhooks

• create_webhook - Tạo một webhook mới cho tổ chức hoặc dự án SonarQube. Yêu cầu quyền 'Administer' trên dự án được chỉ định, hoặc quyền 'Administer' toàn cầu.

  • name - Tên webhook - Bắt buộc, Chuỗi
  • url - URL webhook - Bắt buộc, Chuỗi
  • projectKey - Khóa dự án tùy chọn cho webhook cụ thể của dự án - Chuỗi
  • secret - Bí mật webhook tùy chọn để bảo mật tải trọng webhook - Chuỗi

• list_webhooks - Liệt kê tất cả các webhook cho tổ chức hoặc dự án SonarQube. Yêu cầu quyền 'Administer' trên dự án được chỉ định, hoặc quyền 'Administer' toàn cầu.

  • projectKey - Khóa dự án tùy chọn để liệt kê các webhook cụ thể của dự án - Chuỗi

Tăng cường ngữ cảnh

# macOS/Linux (Bash/Zsh)
export SONARQUBE_TOKEN="{<YourUserToken>}"

{
  "mcpServers": {
    "sonarqube-mcp-server": {
      "command": "docker",
      "args": [
        "run", "-i", "--rm", "--pull=always",
        "-e", "SONARQUBE_URL",
        "-e", "SONARQUBE_TOKEN",
        "-e", "SONARQUBE_ORG",
        "-e", "SONARQUBE_PROJECT_KEY",
        "-e", "SONARQUBE_TOOLSETS",
        "-v", "/ABSOLUTE/PATH/TO/YOUR/PROJECT:/app/mcp-workspace:rw",
        "sonarsource/sonarqube-mcp"
      ],
      "env": {
        "SONARQUBE_URL": "https://sonarcloud.io",
        "SONARQUBE_ORG": "<YourOrganizationKey>",
        "SONARQUBE_PROJECT_KEY": "<YourProjectKey>",
        "SONARQUBE_TOOLSETS": "cag"
      }
    }
  }
}

Mức độ Sẵn sàng Tác nhân

Lưu ý: Các công cụ Mức độ Sẵn sàng Tác nhân chỉ khả dụng trên SonarQube Cloud và yêu cầu tính năng này được bật cho tổ chức của bạn.

• start_agentic_readiness_assessment - Bắt đầu đánh giá mức độ sẵn sàng tác nhân cho một dự án. Trả về ngay lập tức với trạng thái PENDING và một assessmentId. Sử dụng get_agentic_readiness_assessment để thăm dò kết quả.

  • projectKey - Khóa dự án - Chuỗi bắt buộc (Bị bỏ qua khi SONARQUBE_PROJECT_KEY được xác định)
  • branch - Nhánh để đánh giá. Bỏ qua để sử dụng nhánh mặc định của dự án - Chuỗi

• get_agentic_readiness_assessment - Truy xuất kết quả của một đánh giá. Gọi lại với cùng assessmentId cho đến khi trạng thái là COMPLETED, FAILED hoặc INTERRUPTED. Khi hoàn tất, trả về cấp độ tổng thể và phân tích chi tiết theo từng trụ cột với các hành động được khuyến nghị và bằng chứng.

  • assessmentId - ID đánh giá được trả về bởi start_agentic_readiness_assessment - Chuỗi bắt buộc

• list_agentic_readiness_assessments - Liệt kê tất cả các đánh giá cho một dự án, mới nhất trước. Sử dụng get_agentic_readiness_assessment để có kết quả chi tiết theo cấp trụ cột.

  • projectKey - Khóa dự án để liệt kê các đánh giá - Chuỗi bắt buộc (Bị bỏ qua khi SONARQUBE_PROJECT_KEY được xác định)
  • branch - Lọc các đánh giá theo tên nhánh. Bỏ qua để liệt kê các đánh giá cho tất cả các nhánh - Chuỗi
  • pageIndex - Chỉ mục trang dựa trên 1 (mặc định: 1) - Số
  • pageSize - Số mục trên mỗi trang, tối đa 100 (mặc định: 50) - Số

Ví dụ về Lời nhắc

Sau khi bạn đã thiết lập Máy chủ MCP SonarQube, đây là một số lời nhắc ví dụ cho các tình huống thực tế phổ biến:

My quality gate is failing for my project. Can you help me understand why and fix the most critical issues?

The quality gate on my feature branch is red. What do I need to fix to get it passing before I can merge to main?

I'm about to merge my pull request <#247> for the <web-app> project. Can you check if there are any quality issues I should address first?

We're deploying to production tomorrow. Can you check the quality gate status and alert me to any critical issues in this branch?

I want to reduce technical debt in my project. What are the top issues I should prioritize?

Our code coverage dropped below 70%. Can you identify which files have the lowest coverage and help me improve it?

I have 15 new code smells in my latest commit. Can you explain what they are and help me fix them?

SonarQube flagged a critical security vulnerability in <AuthController.java>. What's the issue and how do I fix it?

We need to pass a security audit. Can you check all our projects for security vulnerabilities and create a prioritized list of what needs to be fixed?

Are there any known vulnerabilities in our dependencies? Check this project for dependency risks.

I just wrote this authentication function. Can you analyze it for security issues and code quality problems before I commit?

Review the changes in <src/database/migrations> for any potential bugs or security issues.

Give me a health report for my project: quality gate status, number of bugs, Security Hotspots, and code coverage.

Compare code quality between our main branch and the develop branch. Are we introducing new issues?

What are the most common rule violations across all our projects? We might need to update our coding standards.

Show me all the issues that were marked as false positives in the last month. Are we seeing patterns that suggest our rules need adjustment?

Xây dựng

Ưu tiên sử dụng hình ảnh container sonarsource/sonarqube-mcp.

Để chạy máy chủ dưới dạng JAR độc lập mà không cần Docker, hãy tải xuống bản phát hành được xây dựng sẵn từ kho lưu trữ nhị phân SonarSource. Mọi phiên bản đã phát hành đều được xuất bản ở đó dưới dạng sonarqube-mcp-server-<version>.jar (ví dụ: sonarqube-mcp-server-1.19.0.2785.jar).

{
  "sonarqube": {
    "command": "java",
    "args": [
      "-jar",
      "<path_to_sonarqube_mcp_server_jar>"
    ],
    "env": {
      "STORAGE_PATH": "<path_to_your_mcp_storage>",
      "SONARQUBE_TOKEN": "<token>",
      "SONARQUBE_ORG": "<org>"
    }
  }
}

{
  "sonarqube": {
    "command": "java",
    "args": [
      "-jar",
      "<path_to_sonarqube_mcp_server_jar>"
    ],
    "env": {
      "STORAGE_PATH": "<path_to_your_mcp_storage>",
      "SONARQUBE_TOKEN": "<token>",
      "SONARQUBE_URL": "<url>"
    }
  }
}

./gradlew clean build -x test

./gradlew :dependencies --write-locks
./gradlew :its:dependencies --write-locks

Khắc phục sự cố

Nhật ký ứng dụng được ghi vào tệp STORAGE_PATH/logs/mcp.log theo mặc định. Để tắt hoàn toàn ghi nhật ký tệp, hãy đặt SONARQUBE_LOG_TO_FILE_DISABLED=true.

Các sự cố thường gặp

"Phiên bản máy chủ SonarQube không được hỗ trợ"

Máy chủ MCP kiểm tra phiên bản Máy chủ SonarQube được kết nối trong quá trình khởi động. Nếu phiên bản cũ hơn 2025.1 (SQS) hoặc 25.1 (SQCB), quá trình khởi động sẽ thất bại với:

SonarQube server version is not supported, minimal version is SQS 2025.1 or SQCB 25.1

Giải pháp: Nâng cấp Máy chủ SonarQube lên bản phát hành được hỗ trợ. Kiểm tra này chỉ áp dụng khi kết nối với Máy chủ SonarQube (SONARQUBE_URL không có SONARQUBE_ORG), không áp dụng cho SonarQube Cloud.

"Tính năng không hoạt động" hoặc "Thiếu công cụ/chức năng"

Bạn có thể đang chạy một hình ảnh Docker đã lỗi thời. Docker lưu trữ hình ảnh cục bộ, vì vậy bạn sẽ không tự động nhận được các bản cập nhật.

Giải pháp: Cập nhật lên phiên bản mới nhất:

docker pull sonarsource/sonarqube-mcp

Sau khi kéo hình ảnh mới nhất, hãy khởi động lại máy khách MCP của bạn để sử dụng phiên bản đã cập nhật.

Tùy chọn, thêm cờ --pull=always vào lệnh docker run của bạn để luôn kiểm tra và kéo phiên bản mới nhất:

docker run --init --pull=always -i --rm -e SONARQUBE_TOKEN -e SONARQUBE_ORG sonarsource/sonarqube-mcp

"Tôi muốn ghim vào một phiên bản cụ thể"

Duyệt các thẻ có sẵn tại sonarsource/sonarqube-mcp và tham chiếu phiên bản bạn muốn:

docker pull sonarsource/sonarqube-mcp:1.19.0.2785

docker run --init -i --rm \
  -e SONARQUBE_TOKEN -e SONARQUBE_ORG \
  sonarsource/sonarqube-mcp:1.19.0.2785

Trong cấu hình máy khách MCP của bạn, sử dụng sonarsource/sonarqube-mcp:<version> thay vì sonarsource/sonarqube-mcp và xóa --pull=always để Docker không âm thầm nâng cấp hình ảnh.

Dữ liệu và đo từ xa

Máy chủ này thu thập dữ liệu sử dụng ẩn danh và gửi đến SonarSource để giúp cải thiện sản phẩm. Không thu thập mã nguồn hoặc địa chỉ IP và SonarSource không chia sẻ dữ liệu với bất kỳ ai khác. Việc thu thập dữ liệu đo từ xa có thể bị vô hiệu hóa bằng thuộc tính hệ thống hoặc biến môi trường sau: TELEMETRY_DISABLED=true. Nhấp tại đây để xem mẫu dữ liệu được thu thập.

Giấy phép

Bản quyền 2025 SonarSource.

Được cấp phép theo Giấy phép Nguồn Mở SONAR v1.0. Việc sử dụng Máy chủ MCP SonarQube tuân thủ tài liệu này là Mục đích Không Cạnh tranh và do đó được phép theo SSAL.

Việc bạn sử dụng SonarQube qua MCP được điều chỉnh bởi Điều khoản Dịch vụ SonarQube Cloud hoặc Điều khoản và Điều kiện SonarQube Server, bao gồm việc sử dụng Dữ liệu Kết quả chỉ cho mục đích phát triển phần mềm nội bộ của bạn.