SonarQube

เซิร์ฟเวอร์ SonarQube MCP

เซิร์ฟเวอร์ SonarQube MCP เป็นเซิร์ฟเวอร์ Model Context Protocol (MCP) ที่ช่วยให้สามารถเชื่อมต่อกับ SonarQube Server หรือ Cloud ได้อย่างราบรื่นสำหรับคุณภาพโค้ดและความปลอดภัย นอกจากนี้ยังรองรับการวิเคราะห์โค้ดบางส่วนโดยตรงภายในบริบทของเอเจนต์

การตั้งค่าอย่างรวดเร็ว

🚀 สร้างคอนฟิกูเรชันของคุณ

วิธีที่เร็วที่สุดในการเริ่มต้นคือ ตัวสร้างคอนฟิกูเรชันเซิร์ฟเวอร์ SonarQube MCP – เครื่องมือแบบโต้ตอบที่สร้างคอนฟิกูเรชันที่พร้อมใช้งานสำหรับไคลเอนต์เอเจนต์ AI ที่คุณต้องการ

การตั้งค่าด้วยตนเอง

หากคุณต้องการกำหนดค่าด้วยตัวเอง วิธีที่ง่ายที่สุดคือใช้อิมเมจคอนเทนเนอร์ของเราที่ sonarsource/sonarqube-mcp ใช้ sonarsource/sonarqube-mcp สำหรับการอัปเดตอัตโนมัติ (ด้วย --pull=always) หรือกำหนดเวอร์ชันแท็ก (เช่น sonarsource/sonarqube-mcp:1.19.0.2785) สำหรับการปรับใช้ที่ทำซ้ำได้ อ่านด้านล่างหากคุณต้องการสร้างในเครื่อง

หมายเหตุ: แม้ว่าตัวอย่างด้านล่างจะใช้ docker แต่รันไทม์คอนเทนเนอร์ที่เข้ากันได้กับ OCI ใดๆ ก็ใช้งานได้ (เช่น Podman, nerdctl) เพียงแทนที่ docker ด้วยเครื่องมือที่คุณต้องการ

{
  "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"
}

💡 เคล็ดลับ: เราขอแนะนำให้ดึงอิมเมจล่าสุดเป็นประจำหรือก่อนรายงานปัญหาเพื่อให้แน่ใจว่าคุณมีฟีเจอร์และการแก้ไขล่าสุด

การติดตั้งด้วยตนเอง

คุณสามารถติดตั้งเซิร์ฟเวอร์ SonarQube MCP ด้วยตนเองโดยคัดลอกข้อมูลต่อไปนี้ในไฟล์คอนฟิกูเรชันเซิร์ฟเวอร์ MCP:

• เพื่อเชื่อมต่อกับ 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>"
    }
  }
}

• เพื่อเชื่อมต่อกับ 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>"
    }
  }
}

การผสานรวมกับ SonarQube สำหรับ IDE

เซิร์ฟเวอร์ SonarQube MCP สามารถผสานรวมกับ SonarQube สำหรับ IDE เพื่อเพิ่มประสิทธิภาพขั้นตอนการทำงานการพัฒนาของคุณ ให้การวิเคราะห์โค้ดและข้อมูลเชิงลึกที่ดีขึ้นโดยตรงภายใน IDE ของคุณ

{
  "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>"
    }
  }
}

คอนฟิกูเรชัน

ขึ้นอยู่กับสภาพแวดล้อมของคุณ คุณควรระบุตัวแปรสภาพแวดล้อมเฉพาะ

พื้นฐาน

คุณควรเพิ่มตัวแปรต่อไปนี้เมื่อรันเซิร์ฟเวอร์ MCP:

การเมานต์พื้นที่ทำงาน (การลดการใช้บริบท)

โดยค่าเริ่มต้น เครื่องมือวิเคราะห์ analyze_code_snippet กำหนดให้เอเจนต์ส่งเนื้อหาไฟล์ทั้งหมดเป็นอาร์กิวเมนต์ fileContent สำหรับไฟล์ขนาดใหญ่หรือเมื่อวิเคราะห์หลายไฟล์ในเซสชันเดียว สิ่งนี้จะเพิ่มการใช้หน้าต่างบริบทและต้นทุนอย่างมีนัยสำคัญ วิธีแก้ไข: เมานต์ไดเรกทอรีโปรเจกต์ของคุณลงในคอนเทนเนอร์ที่ /app/mcp-workspace เมื่อตรวจพบการเมานต์นี้ เซิร์ฟเวอร์จะอ่านไฟล์โดยตรงจากดิสก์โดยใช้อาร์กิวเมนต์ filePath ที่สัมพันธ์กับโปรเจกต์ — เนื้อหาไฟล์จะไม่ผ่านบริบทของเอเจนต์

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

เมื่อการเมานต์ทำงานอยู่:

• run_advanced_code_analysis จะพร้อมใช้งานหากองค์กรของคุณมีสิทธิ์
• analyze_code_snippet: ต้องใช้ filePath และไม่ใช้ fileContent — เซิร์ฟเวอร์จะแก้ไขไฟล์ในลักษณะเดียวกัน

การเปิดใช้งานชุดเครื่องมือแบบเลือก

โดยค่าเริ่มต้น เฉพาะชุดเครื่องมือที่สำคัญเท่านั้นที่จะถูกเปิดใช้งานเพื่อลดภาระบริบท คุณสามารถเปิดใช้งานชุดเครื่องมือเพิ่มเติมได้ตามต้องการ

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

เพื่อเปิดใช้งานฟังก์ชันทั้งหมด ต้องตั้งค่าตัวแปรสภาพแวดล้อมต่อไปนี้ก่อนเริ่มเซิร์ฟเวอร์:

ตัวอย่าง:

• SonarQube Cloud: ต้องใช้เฉพาะ SONARQUBE_TOKEN และ SONARQUBE_ORG เท่านั้น
• SonarQube Cloud US: ตั้งค่า SONARQUBE_TOKEN, SONARQUBE_ORG และ SONARQUBE_URL=https://sonarqube.us

SonarQube Server

ข้อกำหนดเวอร์ชัน: ต้องใช้ SonarQube Server 2025.1 (SQS) หรือ 25.1 (SonarQube Community Build) หรือใหม่กว่า ในระหว่างการเริ่มต้น MCP server จะอ่านเวอร์ชันของอินสแตนซ์ที่เชื่อมต่อและออกจากระบบพร้อมแสดงข้อผิดพลาดหากเวอร์ชันเก่าเกินไป (ตัวอย่างเช่น legacy 9.x/10.x Server releases และ Community Build 24.x ไม่ได้รับการสนับสนุน) SonarQube Cloud ไม่ต้องอยู่ภายใต้การตรวจสอบนี้

⚠️ การเชื่อมต่อกับ SonarQube Server ต้องใช้โทเค็นประเภท USER และจะไม่ทำงานอย่างถูกต้องหากใช้ project tokens หรือ global tokens

💡 เคล็ดลับการกำหนดค่า (โหมด stdio): การมีอยู่ของ SONARQUBE_ORG จะกำหนดว่าคุณกำลังเชื่อมต่อกับ SonarQube Cloud หรือ Server หากตั้งค่า SONARQUBE_ORG จะใช้ SonarQube Cloud มิฉะนั้นจะใช้ SonarQube Server

โหมดการขนส่ง (Transport Modes)

ข้อกำหนด MCP กำหนดกลไกการขนส่งสองแบบ: Stdio และ Streamable HTTP SonarQube MCP Server รองรับทั้งสองแบบ:

หมายเหตุ: Streamable HTTP คือ MCP network transport ปัจจุบัน การขนส่ง HTTP แบบ SSE-only ที่เก่ากว่าจาก MCP เวอร์ชันก่อนหน้าถูกเลิกใช้และไม่ได้รับการสนับสนุน

1. Stdio (ค่าเริ่มต้น - แนะนำสำหรับการพัฒนาท้องถิ่น)

โหมดที่แนะนำสำหรับการพัฒนาท้องถิ่นและการตั้งค่าผู้ใช้คนเดียว ใช้โดย MCP clients ส่วนใหญ่

ตัวอย่าง - Docker กับ 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)

การขนส่ง Streamable HTTP ที่ไม่เข้ารหัส ใช้ HTTPS แทนสำหรับการติดตั้งผู้ใช้หลายคน

⚠️ ไม่แนะนำ: ใช้ Stdio สำหรับการพัฒนาท้องถิ่นหรือ HTTPS (Streamable HTTP) สำหรับการติดตั้งการผลิตผู้ใช้หลายคน

หมายเหตุ: ในโหมด Streamable HTTP (HTTP หรือ HTTPS) เซิร์ฟเวอร์ไม่มีสถานะ — คำขอของ client แต่ละรายการต้องรวมส่วนหัว Authorization: Bearer <token> ที่มีโทเค็น SonarQube ของผู้ใช้เอง สำหรับ SonarQube Cloud องค์กรจะถูกแก้ไขดังนี้:

• หากตั้งค่า SONARQUBE_ORG ที่การเริ่มต้นเซิร์ฟเวอร์ คำขอทั้งหมดจะถูกส่งไปยังองค์กรนั้น Clients ต้องไม่ ส่งส่วนหัว SONARQUBE_ORG — การทำเช่นนั้นจะส่งผลให้เกิดข้อผิดพลาด
• หากไม่ได้ตั้งค่า SONARQUBE_ORG ที่การเริ่มต้นเซิร์ฟเวอร์ client แต่ละรายการ ต้อง จัดหาส่วนหัว SONARQUBE_ORG ในทุกคำขอ Clients ยังสามารถจำกัดเครื่องมือที่มองเห็นได้ต่อคำขอโดยการจัดหาส่วนหัว SONARQUBE_TOOLSETS และ/หรือ SONARQUBE_READ_ONLY; สิ่งเหล่านี้ใช้การกรองเพิ่มเติมเหนือการกำหนดค่าระดับเซิร์ฟเวอร์ — สามารถลดขอบเขตได้เท่านั้น ไม่สามารถขยายได้ ไม่มีการรักษาสถานะเซสชันระหว่างคำขอ

เลิกใช้แล้ว: ส่วนหัวคำขอ SONARQUBE_TOKEN ยังคงได้รับการยอมรับสำหรับความเข้ากันได้ย้อนหลัง แต่จะถูกลบออกในเวอร์ชันอนาคต ย้ายไปใช้ Authorization: Bearer <token>

3. HTTPS (Streamable HTTP ผ่าน TLS) (แนะนำสำหรับการติดตั้งการผลิตผู้ใช้หลายคน)

การขนส่ง Streamable HTTP ที่ปลอดภัยด้วยการเข้ารหัส TLS ต้องใช้ใบรับรอง SSL

✅ แนะนำสำหรับการผลิต: ใช้ HTTPS เมื่อติดตั้ง MCP server สำหรับผู้ใช้หลายคนผ่าน Streamable HTTP เซิร์ฟเวอร์ผูกกับ 127.0.0.1 (localhost) โดยค่าเริ่มต้นเพื่อความปลอดภัย

การกำหนดค่าใบรับรอง SSL (ไม่บังคับ):

ตัวอย่าง - Docker กับ SonarQube Cloud:

หมายเหตุ: เมื่อรันในคอนเทนเนอร์ ให้ตั้งค่า SONARQUBE_HTTP_HOST=0.0.0.0 เพื่อให้คอนเทนเนอร์ฟังบนอินเทอร์เฟซทั้งหมดและการแมปพอร์ตของ runtime ทำงาน และตั้งค่า SONARQUBE_MCP_IN_CONTAINER=true เพื่อบอกเซิร์ฟเวอร์ว่าอยู่ภายในคอนเทนเนอร์ อิมเมจ Docker อย่างเป็นทางการตั้งค่าอย่างหลังโดยอัตโนมัติ; ตั้งค่าด้วยตัวเองเมื่อใช้ OCI runtimes อื่นๆ (Podman, Kubernetes, Nomad, ฯลฯ) แฟล็กพอร์ตฝั่งโฮสต์ควบคุมว่าใครสามารถเข้าถึงเซิร์ฟเวอร์จากภายนอกคอนเทนเนอร์ได้ SONARQUBE_HTTP_HOST=0.0.0.0 ควบคุมเฉพาะตำแหน่งที่เซิร์ฟเวอร์ฟังภายในคอนเทนเนอร์ — CORS ของเบราว์เซอร์ยังอนุญาตต้นทาง localhost โดยค่าเริ่มต้น

สำหรับเซิร์ฟเวอร์ที่รัน บนเครื่องของคุณเอง (เข้าถึงได้จาก 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

สำหรับเซิร์ฟเวอร์ที่ เข้าถึงได้จากเครือข่าย (การติดตั้งระยะไกล):

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

การกำหนดค่า Client (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"
      }
    }
  }
}

การกำหนดค่า Client (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"
      }
    }
  }
}

หมายเหตุ: SONARQUBE_TOOLSETS และ SONARQUBE_READ_ONLY เป็นส่วนหัวต่อคำขอที่ไม่บังคับซึ่งจำกัดชุดเครื่องมือระดับเซิร์ฟเวอร์สำหรับคำขอนั้นๆ โดยเฉพาะ สามารถลดขอบเขตได้เท่านั้น — ไม่สามารถเปิดใช้งานชุดเครื่องมือหรือยกข้อจำกัดเกินกว่าที่เซิร์ฟเวอร์เปิดใช้ได้

หมายเหตุ: สำหรับการพัฒนาท้องถิ่น ให้ใช้การขนส่ง Stdio แทน (ค่าเริ่มต้น) HTTPS Streamable HTTP มีไว้สำหรับการติดตั้งการผลิตผู้ใช้หลายคนพร้อมใบรับรอง SSL ที่เหมาะสม

Service Endpoints

เมื่อรันในโหมด Streamable HTTP (http หรือ https) เซิร์ฟเวอร์จะเปิดเผย service endpoints ที่ไม่ต้องรับรองความถูกต้องสองสามรายการนอกเหนือจาก MCP endpoint ที่ /mcp สิ่งเหล่านี้มีไว้สำหรับการใช้งานระหว่างบริการ (การตรวจสอบ การจัดระเบียบ การตรวจสอบความเข้ากันได้ของ client) และไม่ต้องใช้ส่วนหัว Authorization

Endpoints เหล่านี้ไม่พร้อมใช้งานเมื่อรันด้วยการขนส่ง Stdio

ใบรับรองที่กำหนดเอง

หาก SonarQube Server ของคุณใช้ใบรับรองที่ลงนามด้วยตนเองหรือใบรับรองจาก Certificate Authority (CA) ส่วนตัว คุณสามารถเพิ่มใบรับรองที่กำหนดเองลงในคอนเทนเนอร์ที่จะถูกติดตั้งโดยอัตโนมัติ

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>"
    }
  }
}

พร็อกซี

SonarQube MCP Server รองรับพร็อกซี HTTP และ SOCKS5 ผ่านคุณสมบัติระบบ Java มาตรฐาน

ใบรับรองไคลเอ็นต์ (Mutual TLS)

หากเซิร์ฟเวอร์ SonarQube ของคุณกำหนดให้ไคลเอ็นต์ต้องแสดงใบรับรองระหว่างการจับมือ TLS (mutual TLS) คุณสามารถระบุคีย์สโตร์ PKCS12 ได้โดยการเมานต์ลงในคอนเทนเนอร์และส่งตำแหน่งผ่าน 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>"
    }
  }
}

เครื่องมือ

การวิเคราะห์

• analyze_code_snippet - วิเคราะห์เนื้อหาไฟล์ด้วยตัววิเคราะห์ SonarQube เพื่อระบุปัญหาคุณภาพโค้ดและความปลอดภัย วิเคราะห์เนื้อหาไฟล์ทั้งหมดเสมอเพื่อความแม่นยำ สามารถกรองผลลัพธ์เป็นโค้ดสั้นๆ ที่ระบุได้

  เลิกใช้งาน: analyze_code_snippet จะถูกลบออกในเวอร์ชันอนาคต เชื่อมต่อ SonarQube for IDE เพื่อใช้ analyze_file_list หรือเปิดใช้งานการวิเคราะห์ Vortex สำหรับองค์กรของคุณเพื่อใช้ run_advanced_code_analysis (ดูด้านล่าง)

  การใช้งาน:

  • เมื่อเมานต์เวิร์กสเปซ (แนะนำ): ส่ง filePath (สัมพันธ์กับโปรเจกต์) — เซิร์ฟเวอร์อ่านไฟล์โดยตรง ทำให้เนื้อหาไฟล์ไม่อยู่ในบริบทของเอเจนต์
  • เมื่อไม่ได้เมานต์เวิร์กสเปซ: ส่ง fileContent ที่สมบูรณ์สำหรับการวิเคราะห์ไฟล์ทั้งหมด (รายงานปัญหาทั้งหมด)
  • เพิ่ม codeSnippet ที่ไม่บังคับเพื่อกรองผลลัพธ์ - เฉพาะปัญหาภายในโค้ดสั้นๆ จะถูกรายงาน (ตำแหน่งโค้ดสั้นๆ ถูกตรวจจับอัตโนมัติ)

  พารามิเตอร์:

  • projectKey - คีย์โปรเจกต์ SonarQube - สตริงที่จำเป็น (ไม่สนใจเมื่อกำหนด SONARQUBE_PROJECT_KEY)
  • filePath - เส้นทางสัมพันธ์กับโปรเจกต์ของไฟล์ที่จะวิเคราะห์ (เช่น src/main/java/MyClass.java) ใช้เมื่อเมานต์เวิร์กสเปซที่ /app/mcp-workspace - สตริง
  • fileContent - เนื้อหาไฟล์ที่สมบูรณ์เป็นสตริง จำเป็นเมื่อไม่ได้เมานต์เวิร์กสเปซ - สตริง
  • codeSnippet - โค้ดสั้นๆ เพื่อกรองปัญหา (ต้องตรงกับเนื้อหาใน fileContent) - สตริง
  • language - ภาษาของโค้ด (เช่น 'java', 'python', 'js', 'ts', 'tsx', 'jsx') - สตริง
  • scope - ขอบเขตของไฟล์: MAIN หรือ TEST (ค่าเริ่มต้น: MAIN) - สตริง

  ภาษาที่รองรับ: Java, Kotlin, Python, Ruby, Go, JavaScript (js, jsx), TypeScript (ts, tsx), JSP, PHP, XML, HTML, CSS, CloudFormation, Kubernetes, Terraform, Azure Resource Manager, Ansible, Docker, การตรวจจับความลับ

เมื่อเปิดใช้งานการรวมกับ SonarQube for IDE: (เครื่องมือสองตัวนี้ถูกแท็กภายใต้ชุดเครื่องมือ analysis และ ide)

• analyze_file_list - วิเคราะห์ไฟล์ในไดเรกทอรีทำงานปัจจุบันโดยใช้ SonarQube for IDE เครื่องมือนี้เชื่อมต่อกับอินสแตนซ์ SonarQube for IDE ที่รันอยู่เพื่อวิเคราะห์คุณภาพโค้ดบนรายการไฟล์

  • file_absolute_paths - รายการเส้นทางไฟล์สัมบูรณ์ที่จะวิเคราะห์ - String[] ที่จำเป็น

• toggle_automatic_analysis - เปิดหรือปิดการวิเคราะห์อัตโนมัติของ SonarQube for IDE เมื่อเปิดใช้งาน SonarQube for IDE จะวิเคราะห์ไฟล์โดยอัตโนมัติเมื่อมีการแก้ไขในไดเรกทอรีทำงาน เมื่อปิดใช้งาน การวิเคราะห์อัตโนมัติจะถูกปิด

  • enabled - เปิดหรือปิดการวิเคราะห์อัตโนมัติ - บูลีนที่จำเป็น

บน SonarQube Server, stdio แสดงรายการเครื่องมือบริบท Vortex และ run_advanced_code_analysis เมื่อทั้งฮับ CAG และ A3S ได้รับสิทธิ์

เมื่อเปิดใช้งานการวิเคราะห์ Vortex:

ต้องเมานต์เวิร์กสเปซที่ /app/mcp-workspace

• run_advanced_code_analysis - รันการวิเคราะห์ Vortex บนไฟล์เดียว องค์กรถูกอนุมานจากการกำหนดค่า MCP (SonarQube Server ใช้ตัวยึดตำแหน่ง UUID nil)
  • projectKey - คีย์ของโปรเจกต์ - สตริงที่จำเป็น (ไม่สนใจเมื่อกำหนด SONARQUBE_PROJECT_KEY)
  • branch - ชื่อสาขาที่ใช้ดึงบริบทการวิเคราะห์ล่าสุด - สตริงที่จำเป็น
  • filePath - เส้นทางสัมพันธ์กับโปรเจกต์ของไฟล์ที่จะวิเคราะห์ (เช่น src/main/java/MyClass.java) - สตริงที่จำเป็น
  • fileScope - กำหนดขอบเขตที่ไฟล์มาจาก: 'MAIN' หรือ 'TEST' (ค่าเริ่มต้น: MAIN) - สตริง

ความครอบคลุม

• search_files_by_coverage - ค้นหาไฟล์ในโปรเจกต์ที่เรียงตามความครอบคลุม (จากน้อยไปมาก - ความครอบคลุมแย่ที่สุดก่อน) เครื่องมือนี้ช่วยระบุไฟล์ที่ต้องปรับปรุงความครอบคลุมของการทดสอบ

  • projectKey - คีย์โปรเจกต์ที่จะค้นหา - สตริงที่จำเป็น (ไม่สนใจเมื่อกำหนด SONARQUBE_PROJECT_KEY)
  • branch - ชื่อสาขาที่ไม่บังคับสำหรับการวิเคราะห์ตามสาขา ใช้ list_branches เพื่อค้นหาชื่อที่ถูกต้อง - สตริง
  • pullRequest - คีย์/ID คำขอดึงที่ไม่บังคับ ใช้ list_pull_requests เพื่อค้นหาคีย์ที่ถูกต้อง - สตริง
  • maxCoverage - เกณฑ์ความครอบคลุมสูงสุด (0-100) คืนค่าเฉพาะไฟล์ที่มีความครอบคลุม <= ค่านี้ - ตัวเลข
  • pageIndex - ดัชนีหน้า (เริ่มที่ 1, ค่าเริ่มต้น: 1) - ตัวเลข
  • pageSize - ขนาดหน้า (ค่าเริ่มต้น: 100, สูงสุด: 500) - ตัวเลข

• get_file_coverage_details - รับข้อมูลความครอบคลุมทีละบรรทัดสำหรับไฟล์เฉพาะ รวมถึงบรรทัดที่ไม่ได้ครอบคลุมและบรรทัดที่มีสาขาครอบคลุมบางส่วน เครื่องมือนี้ช่วยระบุตำแหน่งที่แน่นอนในการเพิ่มความครอบคลุมของการทดสอบ ใช้หลังจากระบุไฟล์ที่มีความครอบคลุมต่ำผ่าน search_files_by_coverage

  • key - คีย์ไฟล์ (เช่น my_project:src/foo/Bar.java) - สตริงที่จำเป็น
  • branch - ชื่อสาขาที่ไม่บังคับสำหรับการวิเคราะห์ตามสาขา ใช้ list_branches เพื่อค้นหาชื่อที่ถูกต้อง - สตริง
  • pullRequest - คีย์/ID คำขอดึงที่ไม่บังคับ ใช้ list_pull_requests เพื่อค้นหาคีย์ที่ถูกต้อง - สตริง
  • from - บรรทัดแรกที่จะวิเคราะห์ (เริ่มที่ 1, ค่าเริ่มต้น: 1) - ตัวเลข
  • to - บรรทัดสุดท้ายที่จะวิเคราะห์ (รวม) หากไม่ระบุ จะคืนค่าทุกบรรทัด - ตัวเลข

ความเสี่ยงด้าน dependencies

หมายเหตุ: ความเสี่ยงด้าน dependencies มีเฉพาะเมื่อเชื่อมต่อกับ SonarQube Server 2025.4 Enterprise หรือสูงกว่าที่เปิดใช้งาน SonarQube Advanced Security

• search_dependency_risks - ค้นหาปัญหาการวิเคราะห์องค์ประกอบซอฟต์แวร์ (ความเสี่ยงด้าน dependencies) ของโปรเจกต์ SonarQube พร้อมกับเวอร์ชันที่ปรากฏในโปรเจกต์ แอปพลิเคชัน หรือพอร์ตโฟลิโอที่วิเคราะห์
  • projectKey - คีย์โปรเจกต์ - สตริงที่จำเป็น (ไม่สนใจเมื่อกำหนด SONARQUBE_PROJECT_KEY)
  • branch - ชื่อสาขาที่ไม่บังคับสำหรับการวิเคราะห์ตามสาขา ใช้ list_branches เพื่อค้นหาชื่อที่ถูกต้อง - สตริง
  • pullRequest - คีย์/ID คำขอดึงที่ไม่บังคับ ใช้ list_pull_requests เพื่อค้นหาคีย์ที่ถูกต้อง - สตริง
  • pageIndex - ดัชนีหน้าที่ไม่บังคับ (เริ่มที่ 1, ค่าเริ่มต้น: 1) - จำนวนเต็ม
  • pageSize - ขนาดหน้าที่ไม่บังคับ ต้องมากกว่า 0 และน้อยกว่าหรือเท่ากับ 500 (ค่าเริ่มต้น: 100) - จำนวนเต็ม

องค์กร

หมายเหตุ: องค์กรมีเฉพาะเมื่อเชื่อมต่อกับ SonarQube Cloud

• list_enterprises - แสดงรายการองค์กรที่พร้อมใช้งานใน SonarQube Cloud ที่คุณมีสิทธิ์เข้าถึง ใช้เครื่องมือนี้เพื่อค้นหา ID องค์กรที่สามารถใช้กับเครื่องมืออื่นๆ ได้
  • enterpriseKey - คีย์องค์กรที่ไม่บังคับเพื่อกรองผลลัพธ์ - สตริง

ปัญหา

• change_sonar_issue_status - เปลี่ยนสถานะของปัญหา SonarQube เป็น "accept", "falsepositive" หรือ "reopen" ปัญหา

  • key - คีย์ปัญหา - สตริงที่จำเป็น
  • status - สถานะใหม่ของปัญหา - Enum ที่จำเป็น {"accept", "falsepositive", "reopen"}
  • comment - ความคิดเห็นที่ไม่บังคับอธิบายการเปลี่ยนสถานะ - สตริง

• search_sonar_issues_in_projects - ค้นหาปัญหา SonarQube ในโปรเจกต์ขององค์กรของฉัน

  • projectKeys - รายการคีย์โปรเจกต์ SonarQube ที่ไม่บังคับ - String[]
  • branch - ชื่อสาขาที่ไม่บังคับสำหรับการวิเคราะห์ตามสาขา ใช้ list_branches เพื่อค้นหาชื่อที่ถูกต้อง - สตริง
  • pullRequest - คีย์/ID คำขอดึงที่ไม่บังคับ ใช้ list_pull_requests เพื่อค้นหาคีย์ที่ถูกต้อง - สตริง
  • severities - รายการระดับความรุนแรงที่ไม่บังคับเพื่อกรอง ค่าที่เป็นไปได้: INFO, LOW, MEDIUM, HIGH, BLOCKER - String[]
  • impactSoftwareQualities - รายการคุณภาพซอฟต์แวร์ที่ไม่บังคับเพื่อกรอง ค่าที่เป็นไปได้: MAINTAINABILITY, RELIABILITY, SECURITY - String[]
  • issueStatuses - รายการสถานะปัญหาที่ไม่บังคับเพื่อกรอง ค่าที่เป็นไปได้: OPEN, CONFIRMED, FALSE_POSITIVE, ACCEPTED, FIXED, IN_SANDBOX - String[]
  • tags - รายการแท็กปัญหาที่ไม่บังคับเพื่อกรอง แท็กเป็นตัวพิมพ์เล็ก - String[]
  • inNewCodePeriod - คืนค่าเฉพาะปัญหาในช่วงโค้ดใหม่ ต้องมีรายการเดียวใน projectKeys และ files - บูลีน
  • issueKey - คีย์ปัญหาที่ไม่บังคับเพื่อดึงปัญหาเฉพาะ - สตริง
  • pageIndex - ดัชนีหน้าที่ไม่บังคับ (เริ่มที่ 1, ค่าเริ่มต้น: 1) - จำนวนเต็ม
  • pageSize - ขนาดหน้าที่ไม่บังคับ ต้องมากกว่า 0 และน้อยกว่าหรือเท่ากับ 500 (ค่าเริ่มต้น: 100) - จำนวนเต็ม

Security Hotspots

• search_security_hotspots - ค้นหา Security Hotspots ในโปรเจกต์ SonarQube

  • projectKey - คีย์โปรเจกต์หรือแอปพลิเคชัน - สตริงที่จำเป็น (ไม่สนใจเมื่อกำหนด SONARQUBE_PROJECT_KEY)
  • hotspotKeys - รายการคีย์ Security Hotspot เฉพาะที่คั่นด้วยเครื่องหมายจุลภาคเพื่อดึงข้อมูล - String[]
  • branch - ชื่อสาขาที่ไม่บังคับสำหรับการวิเคราะห์ตามสาขา ใช้ list_branches เพื่อค้นหาชื่อที่ถูกต้อง - สตริง
  • pullRequest - คีย์/ID คำขอดึงที่ไม่บังคับ ใช้ list_pull_requests เพื่อค้นหาคีย์ที่ถูกต้อง - สตริง
  • files - รายการเส้นทางไฟล์ที่ไม่บังคับเพื่อกรอง - String[]
  • status - ตัวกรองสถานะที่ไม่บังคับ: TO_REVIEW, REVIEWED - สตริง
  • resolution - ตัวกรองการแก้ไขที่ไม่บังคับ: FIXED, SAFE, ACKNOWLEDGED - สตริง
  • sinceLeakPeriod - กรอง hotspots ที่สร้างตั้งแต่ช่วง leak (โค้ดใหม่) - บูลีน
  • onlyMine - แสดงเฉพาะ hotspots ที่กำหนดให้ฉัน - บูลีน
  • pageIndex - ดัชนีหน้าที่ไม่บังคับ (เริ่มที่ 1, ค่าเริ่มต้น: 1) - จำนวนเต็ม
  • pageSize - ขนาดหน้าที่ไม่บังคับ ต้องมากกว่า 0 และน้อยกว่าหรือเท่ากับ 500 (ค่าเริ่มต้น: 100) - จำนวนเต็ม

• show_security_hotspot - รับข้อมูลโดยละเอียดเกี่ยวกับ Security Hotspot เฉพาะ รวมถึงรายละเอียดกฎ บริบทโค้ด โฟลว์ และความคิดเห็น

  • hotspotKey - คีย์ Security Hotspot - สตริงที่จำเป็น

• change_security_hotspot_status - ตรวจสอบ Security Hotspot โดยการเปลี่ยนสถานะ เมื่อทำเครื่องหมายเป็น REVIEWED คุณต้องระบุ resolution (FIXED, SAFE, หรือ ACKNOWLEDGED)

  • hotspotKey - คีย์ของ Security Hotspot - String ที่จำเป็น
  • status - สถานะใหม่ - Enum ที่จำเป็น {"TO_REVIEW", "REVIEWED"}
  • resolution - Resolution เมื่อสถานะเป็น REVIEWED - Enum {"FIXED", "SAFE", "ACKNOWLEDGED"}
  • comment - ความคิดเห็นในการตรวจสอบเพิ่มเติม (ไม่บังคับ) - String

ภาษา

• list_languages - แสดงรายการภาษาโปรแกรมทั้งหมดที่รองรับในอินสแตนซ์ SonarQube นี้
  • q - รูปแบบที่ใช้กรองคีย์/ชื่อภาษา (ไม่บังคับ) - String

การวัดผล

• get_component_measures - รับการวัดผล SonarQube สำหรับคอมโพเนนต์ (โปรเจกต์, ไดเรกทอรี, ไฟล์)
  • projectKey - คีย์โปรเจกต์ - String ที่จำเป็นเมื่อไม่ได้กำหนดค่า SONARQUBE_PROJECT_KEY
  • branch - ชื่อ branch สำหรับการวิเคราะห์แบบ branch (ไม่บังคับ) ใช้ list_branches เพื่อค้นหาชื่อที่ถูกต้อง - String
  • metricKeys - คีย์ metric ที่ต้องการดึงข้อมูล (เช่น ncloc, complexity, violations, coverage) (ไม่บังคับ) - String[]
  • pullRequest - คีย์/ID ของ pull request (ไม่บังคับ) ใช้ list_pull_requests เพื่อค้นหาคีย์ที่ถูกต้อง - String

Metrics

• search_metrics - ค้นหา metrics ของ SonarQube
  • pageIndex - ดัชนีหน้าเริ่มต้นที่ 1 (ไม่บังคับ, ค่าเริ่มต้น: 1) - Integer
  • pageSize - ขนาดหน้า (ไม่บังคับ) ต้องมากกว่า 0 และน้อยกว่าหรือเท่ากับ 500 (ค่าเริ่มต้น: 100) - Integer

Portfolios

• list_portfolios - แสดงรายการ portfolios ระดับองค์กรที่พร้อมใช้งานใน SonarQube พร้อมตัวเลือกการกรองและการแบ่งหน้า

  สำหรับ SonarQube Server:

  • q - คำค้นหาเพื่อกรอง portfolios ตามชื่อหรือคีย์ (ไม่บังคับ) - String
  • favorite - หากเป็น true จะส่งคืนเฉพาะ portfolios ที่เป็นรายการโปรด - Boolean
  • pageIndex - หมายเลขหน้าเริ่มต้นที่ 1 (ไม่บังคับ, ค่าเริ่มต้น: 1) - Integer
  • pageSize - ขนาดหน้า สูงสุด 500 (ไม่บังคับ, ค่าเริ่มต้น: 100) - Integer

  สำหรับ SonarQube Cloud:

  • enterpriseId - enterprise uuid สามารถละเว้นได้เฉพาะเมื่อระบุพารามิเตอร์ 'favorite' เป็น true - String
  • q - คำค้นหาเพื่อกรอง portfolios ตามชื่อ (ไม่บังคับ) - String
  • favorite - จำเป็นต้องเป็น true หากละเว้นพารามิเตอร์ 'enterpriseId' หากเป็น true จะส่งคืนเฉพาะ portfolios ที่ผู้ใช้ที่เข้าสู่ระบบทำเครื่องหมายเป็นรายการโปรด ไม่สามารถเป็น true เมื่อ 'draft' เป็น true - Boolean
  • draft - หากเป็น true จะส่งคืนเฉพาะ drafts ที่สร้างโดยผู้ใช้ที่เข้าสู่ระบบ ไม่สามารถเป็น true เมื่อ 'favorite' เป็น true - Boolean
  • pageIndex - ดัชนีของหน้าที่จะดึงข้อมูล (ไม่บังคับ, ค่าเริ่มต้น: 1) - Integer
  • pageSize - ขนาดของหน้าที่จะดึงข้อมูล (ไม่บังคับ, ค่าเริ่มต้น: 50) - Integer

โปรเจกต์

• search_my_sonarqube_projects - ค้นหาโปรเจกต์ SonarQube การตอบสนองจะถูกแบ่งหน้า

  • pageIndex - ดัชนีหน้าเริ่มต้นที่ 1 (ไม่บังคับ, ค่าเริ่มต้น: 1) - Integer
  • pageSize - ขนาดหน้า (ไม่บังคับ) ต้องมากกว่า 0 และน้อยกว่าหรือเท่ากับ 500 (ค่าเริ่มต้น: 500) - Integer
  • q - คำค้นหาเพื่อกรองโปรเจกต์ตามชื่อ (การจับคู่บางส่วน) หรือคีย์ (การจับคู่แบบตรงทั้งหมด) (ไม่บังคับ) - String

• list_branches - แสดงรายการ branch ที่วิเคราะห์แล้วสำหรับโปรเจกต์

  • SonarQube Cloud: ส่งคืน branch แบบ long-lived (LONG) และ short-lived (SHORT) พร้อมฟิลด์ type และ mergeBranch ตัวกรอง branchTypes เพิ่มเติม (ไม่บังคับ): ALL (ค่าเริ่มต้น), LONG, หรือ SHORT
  • SonarQube Server: ส่งคืน branch ที่วิเคราะห์แล้วทั้งหมด (ชื่อ, quality gate, วันที่วิเคราะห์) ไม่มีตัวกรอง type, mergeBranch, หรือ branchTypes
  • ใช้ชื่อ branch ที่ส่งคืนเป็นพารามิเตอร์ branch ในเครื่องมืออื่น สำหรับการวิเคราะห์ pull request ให้ใช้ list_pull_requests แทน
  • projectKey - คีย์โปรเจกต์ (เช่น my_project) - String ที่จำเป็น (ไม่สนใจเมื่อกำหนด SONARQUBE_PROJECT_KEY)
  • branchTypes - (เฉพาะ SonarQube Cloud) ตัวกรองเพิ่มเติม (ไม่บังคับ): ALL (ค่าเริ่มต้น), LONG, หรือ SHORT - Enum {"ALL", "LONG", "SHORT"}

• list_pull_requests - แสดงรายการ pull requests ทั้งหมดสำหรับโปรเจกต์ ใช้เครื่องมือนี้เพื่อค้นหา pull requests สำหรับการวิเคราะห์แบบ PR-decorated (coverage, issues, quality gate) ส่งคืนคีย์/ID ของ pull request ซึ่งสามารถใช้กับเครื่องมืออื่นได้ สำหรับการวิเคราะห์แบบ branch ที่ไม่มี pull requests ให้ใช้ list_branches แทน

  • projectKey - คีย์โปรเจกต์ (เช่น my_project) - String ที่จำเป็น (ไม่สนใจเมื่อกำหนด SONARQUBE_PROJECT_KEY)

Quality Gates

• get_project_quality_gate_status - รับสถานะ Quality Gate สำหรับโปรเจกต์ SonarQube

  • analysisId - ID การวิเคราะห์ (ไม่บังคับ) - String
  • branch - ชื่อ branch สำหรับการวิเคราะห์แบบ branch (ไม่บังคับ) ใช้ list_branches เพื่อค้นหาชื่อที่ถูกต้อง - String
  • projectId - ID โปรเจกต์ (ไม่บังคับ) - String
  • projectKey - คีย์โปรเจกต์ (ไม่บังคับ) - String
  • pullRequest - คีย์/ID ของ pull request (ไม่บังคับ) ใช้ list_pull_requests เพื่อค้นหาคีย์ที่ถูกต้อง - String

• list_quality_gates - แสดงรายการ quality gates ทั้งหมดใน SonarQube ของฉัน

กฎ

• show_rule - แสดงข้อมูลโดยละเอียดเกี่ยวกับกฎของ SonarQube
  • key - คีย์กฎ - String ที่จำเป็น

การทำซ้ำ

• search_duplicated_files - ค้นหาไฟล์ที่มีการทำซ้ำของโค้ดในโปรเจกต์ SonarQube โดยค่าเริ่มต้น จะดึงข้อมูลไฟล์ที่ซ้ำกันทั้งหมดโดยอัตโนมัติจากทุกหน้า (สูงสุด 10,000 ไฟล์) ส่งคืนเฉพาะไฟล์ที่มีการทำซ้ำ

  • projectKey - คีย์โปรเจกต์ - String ที่จำเป็น (ไม่สนใจเมื่อกำหนด SONARQUBE_PROJECT_KEY)
  • branch - ชื่อ branch สำหรับการวิเคราะห์แบบ branch (ไม่บังคับ) ใช้ list_branches เพื่อค้นหาชื่อที่ถูกต้อง - String
  • pullRequest - คีย์/ID ของ pull request (ไม่บังคับ) ใช้ list_pull_requests เพื่อค้นหาคีย์ที่ถูกต้อง - String
  • pageSize - จำนวนผลลัพธ์ต่อหน้าสำหรับการแบ่งหน้าด้วยตนเอง (ไม่บังคับ, สูงสุด: 500) หากไม่ระบุ จะดึงข้อมูลไฟล์ที่ซ้ำกันทั้งหมดโดยอัตโนมัติ - Integer
  • pageIndex - หมายเลขหน้าสำหรับการแบ่งหน้าด้วยตนเอง (ไม่บังคับ, เริ่มต้นที่ 1) หากไม่ระบุ จะดึงข้อมูลไฟล์ที่ซ้ำกันทั้งหมดโดยอัตโนมัติ - Integer

• get_duplications - รับข้อมูลการทำซ้ำสำหรับไฟล์ ต้องมีสิทธิ์ Browse บนโปรเจกต์ของไฟล์

  • key - คีย์ไฟล์ - String ที่จำเป็น
  • branch - ชื่อ branch สำหรับการวิเคราะห์แบบ branch (ไม่บังคับ) ใช้ list_branches เพื่อค้นหาชื่อที่ถูกต้อง - String
  • pullRequest - คีย์/ID ของ pull request (ไม่บังคับ) ใช้ list_pull_requests เพื่อค้นหาคีย์ที่ถูกต้อง - String

แหล่งที่มา

• get_raw_source - รับซอร์สโค้ดเป็นข้อความดิบจาก SonarQube ต้องมีสิทธิ์ 'See Source Code' บนไฟล์

  • key - คีย์ไฟล์ - String ที่จำเป็น
  • branch - ชื่อ branch สำหรับการวิเคราะห์แบบ branch (ไม่บังคับ) ใช้ list_branches เพื่อค้นหาชื่อที่ถูกต้อง - String
  • pullRequest - คีย์/ID ของ pull request (ไม่บังคับ) ใช้ list_pull_requests เพื่อค้นหาคีย์ที่ถูกต้อง - String

• get_scm_info - รับข้อมูล SCM ของไฟล์ซอร์ส SonarQube ต้องมีสิทธิ์ See Source Code บนโปรเจกต์ของไฟล์

  • key - คีย์ไฟล์ - String ที่จำเป็น
  • commits_by_line - จัดกลุ่มบรรทัดตาม commit ของ SCM หากค่าเป็น false มิฉะนั้นจะแสดง commits สำหรับแต่ละบรรทัด - String
  • from - บรรทัดแรกที่จะส่งคืน เริ่มต้นที่ 1 - Number
  • to - บรรทัดสุดท้ายที่จะส่งคืน (รวม) - Number

ระบบ

หมายเหตุ: เครื่องมือระบบจะพร้อมใช้งานเฉพาะเมื่อเชื่อมต่อกับ SonarQube Server เท่านั้น

• get_system_health - รับสถานะสุขภาพของอินสแตนซ์ SonarQube Server ส่งคืน GREEN (ทำงานเต็มรูปแบบ), YELLOW (ใช้งานได้แต่ต้องได้รับการดูแล), หรือ RED (ไม่ทำงาน)

• get_system_info - รับข้อมูลโดยละเอียดเกี่ยวกับการกำหนดค่าระบบ SonarQube Server รวมถึงสถานะ JVM, ฐานข้อมูล, ดัชนีการค้นหา และการตั้งค่า ต้องมีสิทธิ์ 'Administer'

• get_system_logs - รับบันทึกระบบ SonarQube Server ในรูปแบบข้อความธรรมดา ต้องมีสิทธิ์การดูแลระบบ

  • name - ชื่อของบันทึกที่จะรับ (ไม่บังคับ) ค่าที่เป็นไปได้: access, app, ce, deprecation, es, web ค่าเริ่มต้น: app - String

• ping_system - Ping ระบบ SonarQube Server เพื่อตรวจสอบว่าทำงานอยู่หรือไม่ ส่งคืน 'pong' เป็นข้อความธรรมดา

• get_system_status - รับข้อมูลสถานะเกี่ยวกับ SonarQube Server ส่งคืนสถานะ (STARTING, UP, DOWN, RESTARTING, DB_MIGRATION_NEEDED, DB_MIGRATION_RUNNING), เวอร์ชัน และ id

Webhooks

• create_webhook - สร้าง webhook ใหม่สำหรับองค์กรหรือโปรเจกต์ SonarQube ต้องมีสิทธิ์ 'Administer' บนโปรเจกต์ที่ระบุ หรือสิทธิ์ 'Administer' ระดับโลก

  • name - ชื่อ webhook - String ที่จำเป็น
  • url - URL ของ webhook - String ที่จำเป็น
  • projectKey - คีย์โปรเจกต์สำหรับ webhook เฉพาะโปรเจกต์ (ไม่บังคับ) - String
  • secret - ความลับของ webhook สำหรับรักษาความปลอดภัย payload ของ webhook (ไม่บังคับ) - String

• list_webhooks - แสดงรายการ webhooks ทั้งหมดสำหรับองค์กรหรือโปรเจกต์ SonarQube ต้องมีสิทธิ์ 'Administer' บนโปรเจกต์ที่ระบุ หรือสิทธิ์ 'Administer' ระดับโลก

  • projectKey - คีย์โปรเจกต์เพื่อแสดงรายการ webhooks เฉพาะโปรเจกต์ (ไม่บังคับ) - String

การเสริมบริบท

# 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"
      }
    }
  }
}

ความพร้อมสำหรับ Agentic

หมายเหตุ: เครื่องมือความพร้อมสำหรับ Agentic มีเฉพาะบน SonarQube Cloud และต้องเปิดใช้งานฟีเจอร์สำหรับองค์กรของคุณ

• start_agentic_readiness_assessment - เริ่มการประเมินความพร้อมสำหรับ agentic สำหรับโปรเจกต์ คืนค่าทันทีด้วยสถานะ PENDING และ assessmentId ใช้ get_agentic_readiness_assessment เพื่อสอบถามผลลัพธ์

  • projectKey - คีย์โปรเจกต์ - String ที่จำเป็น (ไม่สนใจเมื่อกำหนด SONARQUBE_PROJECT_KEY)
  • branch - สาขาที่จะประเมิน ละเว้นเพื่อใช้สาขาเริ่มต้นของโปรเจกต์ - String

• get_agentic_readiness_assessment - ดึงผลลัพธ์ของการประเมิน เรียกซ้ำด้วย assessmentId เดียวกันจนกว่าสถานะจะเป็น COMPLETED, FAILED, หรือ INTERRUPTED เมื่อเสร็จสิ้น จะคืนค่าระดับโดยรวมและการแยกย่อยรายเสาหลักพร้อมการดำเนินการที่แนะนำและหลักฐาน

  • assessmentId - ID การประเมินที่คืนค่าโดย start_agentic_readiness_assessment - String ที่จำเป็น

• list_agentic_readiness_assessments - แสดงรายการการประเมินทั้งหมดสำหรับโปรเจกต์ เรียงจากใหม่ไปเก่า ใช้ get_agentic_readiness_assessment สำหรับผลลัพธ์ระดับเสาหลักเต็มรูปแบบ

  • projectKey - คีย์โปรเจกต์เพื่อแสดงรายการการประเมิน - String ที่จำเป็น (ไม่สนใจเมื่อกำหนด SONARQUBE_PROJECT_KEY)
  • branch - กรองการประเมินตามชื่อสาขา ละเว้นเพื่อแสดงรายการการประเมินสำหรับทุกสาขา - String
  • pageIndex - ดัชนีหน้าแบบ 1-based (ค่าเริ่มต้น: 1) - Number
  • pageSize - จำนวนรายการต่อหน้า สูงสุด 100 (ค่าเริ่มต้น: 50) - Number

ตัวอย่างพรอมต์

เมื่อคุณตั้งค่า SonarQube MCP Server แล้ว นี่คือตัวอย่างพรอมต์สำหรับสถานการณ์จริงทั่วไป:

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?

การสร้าง

ควรใช้ อิมเมจคอนเทนเนอร์ sonarsource/sonarqube-mcp

ในการรันเซิร์ฟเวอร์เป็น JAR แบบสแตนด์อโลนโดยไม่ใช้ Docker ให้ดาวน์โหลดบิลด์ที่เผยแพร่ล่วงหน้าจาก ที่เก็บไบนารี SonarSource ทุกเวอร์ชันที่เผยแพร่จะถูกโพสต์ที่นั่นเป็น sonarqube-mcp-server-<version>.jar (ตัวอย่างเช่น 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

การแก้ไขปัญหา

บันทึกแอปพลิเคชันจะถูกเขียนไปยังไฟล์ STORAGE_PATH/logs/mcp.log โดยค่าเริ่มต้น หากต้องการปิดการบันทึกไฟล์ทั้งหมด ให้ตั้งค่า SONARQUBE_LOG_TO_FILE_DISABLED=true

ปัญหาทั่วไป

"SonarQube server version is not supported"

MCP server ตรวจสอบเวอร์ชัน SonarQube Server ที่เชื่อมต่อระหว่างการเริ่มต้น หากอินสแตนซ์เก่ากว่า 2025.1 (SQS) หรือ 25.1 (SQCB) การเริ่มต้นจะล้มเหลวด้วย:

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

วิธีแก้ไข: อัปเกรด SonarQube Server เป็นเวอร์ชันที่รองรับ การตรวจสอบนี้ใช้เฉพาะเมื่อเชื่อมต่อกับ SonarQube Server (SONARQUBE_URL โดยไม่มี SONARQUBE_ORG) ไม่ใช่ SonarQube Cloud

"Feature is not working" หรือ "Missing tools/functionality"

คุณอาจรันอิมเมจ Docker ที่ล้าสมัย Docker แคชอิมเมจในเครื่อง ดังนั้นคุณจะไม่ได้รับการอัปเดตโดยอัตโนมัติ

วิธีแก้ไข: อัปเดตเป็นเวอร์ชันล่าสุด:

docker pull sonarsource/sonarqube-mcp

หลังจากดึงอิมเมจล่าสุด ให้รีสตาร์ท MCP client ของคุณเพื่อใช้เวอร์ชันที่อัปเดต

คุณสามารถเพิ่มแฟล็ก --pull=always ในคำสั่ง docker run ของคุณเพื่อตรวจสอบและดึงเวอร์ชันล่าสุดเสมอ:

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

"I want to pin to a specific version"

เรียกดูแท็กที่มีอยู่ที่ sonarsource/sonarqube-mcp และอ้างอิงเวอร์ชันที่คุณต้องการ:

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

ในการกำหนดค่า MCP client ของคุณ ใช้ sonarsource/sonarqube-mcp:<version> แทน sonarsource/sonarqube-mcp และลบ --pull=always เพื่อให้ Docker ไม่อัปเกรดอิมเมจโดยไม่แจ้งเตือน

ข้อมูลและเทเลเมทรี

เซิร์ฟเวอร์นี้เก็บข้อมูลการใช้งานแบบไม่ระบุตัวตนและส่งไปยัง SonarSource เพื่อช่วยปรับปรุงผลิตภัณฑ์ ไม่มีการเก็บซอร์สโค้ดหรือที่อยู่ IP และ SonarSource จะไม่แบ่งปันข้อมูลกับผู้อื่น การเก็บเทเลเมทรีสามารถปิดได้ด้วยพร็อพเพอร์ตี้ระบบหรือตัวแปรสภาพแวดล้อมต่อไปนี้: TELEMETRY_DISABLED=true คลิก ที่นี่ เพื่อดูตัวอย่างข้อมูลที่เก็บ

ใบอนุญาต

ลิขสิทธิ์ 2025 SonarSource

ได้รับอนุญาตภายใต้ SONAR Source-Available License v1.0 การใช้ SonarQube MCP Server ตามเอกสารนี้เป็นวัตถุประสงค์ที่ไม่แข่งขันและได้รับอนุญาตภายใต้ SSAL

การใช้ SonarQube ผ่าน MCP ของคุณอยู่ภายใต้ SonarQube Cloud Terms of Service หรือ SonarQube Server Terms and Conditions รวมถึงการใช้ข้อมูลผลลัพธ์เพื่อวัตถุประสงค์การพัฒนาซอฟต์แวร์ภายในของคุณเท่านั้น