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 ต้องใช้โทเคนประเภท USER และจะทำงานไม่ถูกต้องหากใช้โทเคนโปรเจกต์หรือโทเคนทั่วโลก 💡 เคล็ดลับการกำหนดค่า (โหมด stdio): การมีอยู่ของ SONARQUBE_ORG กำหนดว่าคุณกำลังเชื่อมต่อกับ SonarQube Cloud หรือ Server ถ้า SONARQUBE_ORG ถูกตั้งค่า จะใช้ SonarQube Cloud มิฉะนั้นจะใช้ SonarQube Server

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

ข้อกำหนด MCP กำหนดกลไกการขนส่งสองแบบ: Stdio และ Streamable HTTP เซิร์ฟเวอร์ SonarQube MCP รองรับทั้งสองแบบ:

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

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

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

ตัวอย่าง - 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) เซิร์ฟเวอร์ไม่มีสถานะ — คำขอแต่ละรายการจากไคลเอนต์ต้องมีส่วนหัว Authorization: Bearer <token> พร้อมโทเค็น SonarQube ของผู้ใช้เอง สำหรับ SonarQube Cloud องค์กรจะถูกกำหนดดังนี้:

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

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

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

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

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

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

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

หมายเหตุ: เมื่อรันในคอนเทนเนอร์ ให้ตั้ง SONARQUBE_HTTP_HOST=0.0.0.0 เพื่อให้คอนเทนเนอร์ฟังบนอินเทอร์เฟซทั้งหมดและการแมปพอร์ตของรันไทม์ทำงาน และตั้ง SONARQUBE_MCP_IN_CONTAINER=true เพื่อบอกเซิร์ฟเวอร์ว่าอยู่ในคอนเทนเนอร์ อิมเมจ Docker อย่างเป็นทางการตั้งค่านี้โดยอัตโนมัติ; ตั้งด้วยตัวเองเมื่อใช้รันไทม์ OCI อื่น ๆ (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

การกำหนดค่าไคลเอนต์ (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"
      }
    }
  }
}

การกำหนดค่าไคลเอนต์ (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 ที่เหมาะสม

เอ็นด์พอยต์บริการ

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

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

ใบรับรองแบบกำหนดเอง

หากเซิร์ฟเวอร์ SonarQube ของคุณใช้ใบรับรองที่เซ็นชื่อเองหรือใบรับรองจากหน่วยงานออกใบรับรอง (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 รองรับพร็อกซี HTTP และ SOCKS5 ผ่านคุณสมบัติระบบ Java มาตรฐาน

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

หากเซิร์ฟเวอร์ SonarQube ของคุณกำหนดให้ไคลเอนต์แสดงใบรับรองระหว่างการจับมือ TLS (mutual TLS) คุณสามารถระบุ PKCS12 keystore โดยการเมานต์ลงในคอนเทนเนอร์และส่งตำแหน่งผ่าน 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 - String ที่จำเป็น (ไม่สนใจเมื่อกำหนด SONARQUBE_PROJECT_KEY)
  • filePath - เส้นทางสัมพัทธ์ของไฟล์ที่ต้องการวิเคราะห์ (เช่น src/main/java/MyClass.java) ใช้เมื่อเมานต์เวิร์กสเปซที่ /app/mcp-workspace - String
  • fileContent - เนื้อหาไฟล์ทั้งหมดเป็นสตริง จำเป็นเมื่อไม่ได้เมานต์เวิร์กสเปซ - String
  • codeSnippet - สไนปเพตโค้ดเพื่อกรองปัญหา (ต้องตรงกับเนื้อหาในไฟล์คอนเทนต์) - String
  • language - ภาษาของโค้ด (เช่น 'java', 'python', 'js', 'ts', 'tsx', 'jsx') - String
  • scope - ขอบเขตของไฟล์: MAIN หรือ TEST (ค่าเริ่มต้น: MAIN) - String

  ภาษาที่รองรับ: 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 - เปิดหรือปิดการวิเคราะห์อัตโนมัติ - Boolean ที่จำเป็น

เมื่อเปิดใช้งานการวิเคราะห์ Vortex สำหรับองค์กร SonarQube Cloud ของคุณ:

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

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

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

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

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

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

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

ความเสี่ยงจาก Dependency

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

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

องค์กร

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

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

ปัญหา

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

  • key - คีย์ปัญหา - String ที่จำเป็น
  • status - สถานะใหม่ของปัญหา - Enum ที่จำเป็น {"accept", "falsepositive", "reopen"}

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

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

Security Hotspots

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

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

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

  • hotspotKey - คีย์ Security Hotspot - String ที่จำเป็น

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

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

ภาษา

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

Measures

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

เมตริก

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

Portfolios

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

  สำหรับ SonarQube Server:

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

  สำหรับ SonarQube Cloud:

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

โปรเจกต์

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

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

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

  • SonarQube Cloud: ส่งคืนสาขาแบบมีอายุยาว (LONG) และแบบมีอายุสั้น (SHORT) พร้อมฟิลด์ type และ mergeBranch ตัวกรอง branchTypes เพิ่มเติม (ไม่บังคับ): ALL (ค่าเริ่มต้น), LONG, หรือ SHORT
  • SonarQube Server: ส่งคืนสาขาที่ได้รับการวิเคราะห์ทั้งหมด (ชื่อ, สถานะคุณภาพเกต, วันที่วิเคราะห์) ไม่มีตัวกรอง type, mergeBranch, หรือ branchTypes
  • ใช้ชื่อสาขาที่ส่งคืนเป็นพารามิเตอร์ 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 (ความครอบคลุม, ปัญหา, คุณภาพเกต) ส่งคืนคีย์/ID ของ pull request ซึ่งสามารถใช้กับเครื่องมืออื่น ๆ สำหรับการวิเคราะห์แบบใช้สาขาที่ไม่มี pull requests ใช้ list_branches แทน

  • projectKey - คีย์โปรเจกต์ (เช่น my_project) - String ที่จำเป็น (ถูกละเว้นเมื่อกำหนด SONARQUBE_PROJECT_KEY)

คุณภาพเกต

• get_project_quality_gate_status - รับสถานะคุณภาพเกตสำหรับโปรเจกต์ SonarQube

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

• list_quality_gates - แสดงรายการคุณภาพเกตทั้งหมดใน SonarQube ของฉัน

กฎ

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

การทำซ้ำ (Duplications)

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

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

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

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

แหล่งที่มา

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

  • key - คีย์ไฟล์ - String ที่จำเป็น
  • 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 - จัดกลุ่มบรรทัดตามคอมมิต SCM หากเป็น false ไม่เช่นนั้นจะแสดงคอมมิตสำหรับแต่ละบรรทัด - 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 - ความลับ (secret) ของ webhook สำหรับรักษาความปลอดภัยของ payload (ไม่บังคับ) - 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 - คีย์โปรเจกต์ - Required String (ไม่สนใจเมื่อกำหนด SONARQUBE_PROJECT_KEY)
  • branch - สาขาที่จะประเมิน ละเว้นเพื่อใช้สาขาเริ่มต้นของโปรเจกต์ - String

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

  • assessmentId - ID การประเมินที่ส่งคืนโดย start_agentic_readiness_assessment - Required String

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

  • projectKey - คีย์โปรเจกต์ที่จะแสดงรายการการประเมิน - Required String (ไม่สนใจเมื่อกำหนด SONARQUBE_PROJECT_KEY)
  • branch - กรองการประเมินตามชื่อสาขา ละเว้นเพื่อแสดงรายการการประเมินสำหรับทุกสาขา - String
  • pageIndex - ดัชนีหน้าเริ่มต้นที่ 1 (ค่าเริ่มต้น: 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

ปัญหาทั่วไป

"ฟีเจอร์ไม่ทำงาน" หรือ "เครื่องมือ/ฟังก์ชันหายไป"

คุณอาจกำลังรันอิมเมจ 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

"ฉันต้องการระบุเวอร์ชันเฉพาะ"

เรียกดูแท็กที่มีอยู่ที่ 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 ไม่อัปเกรดอิมเมจอย่างเงียบ ๆ

ข้อมูลและ telemetry

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

ใบอนุญาต

ลิขสิทธิ์ 2025 SonarSource.

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

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