pmd

Name: pmd
Author: roeiba

Local

github.com/roeibaDeveloper Tools2Updated 47w ago

Repository

About pmd

pmd is a multilanguage static code analyzer for developers, focused mainly on Java and Apex. It includes built-in rules, supports custom rules, and bundles CPD for detecting duplicated code.

Key features

01Detects common code flaws
02Supports multiple programming languages
03Includes 400+ built-in rules
04Defines rules in Java or XPath
05Finds duplicate code with CPD

Use cases

01Check Java or Apex projects for code issues
02Find repeated fragments across a codebase
03Create custom analysis rules for a project

MCP support

The input describes a static code analyzer and does not specify MCP functionality.

Configuration

Local server config is the same for every client. Copy it into your client’s MCP config file.

mcp.json · Universal config

{
  "mcpServers": {
    "roeiba-pmd": {
      "command": "npx",
      "args": [
        "-y",
        "@springsoftware/pmd-mcp"
      ]
    }
  }
}

Run commandnpx -y @springsoftware/pmd-mcp

Local servers need a runtime on your machine (e.g. Node.js 18+). Config file locations differ by client; see your client’s docs.

Packages

npm@springsoftware/pmd-mcp0.1.2stdio

Tools

Saved tool list · updated 3w ago

Parameter	Type	Required	Description
path	string	Yes	Path to source file or directory to analyze
excludes	array	No	File patterns to exclude from analysis
rulesets	array	No	Rulesets to apply (e.g., ["rulesets/java/quickstart.xml"]). Defaults to quickstart.
language_version	string	No	Language version (e.g., "java-21", "ecmascript-ES2022")
minimum_priority	number	No	Minimum priority to report (1=highest, 5=lowest). Default: all

Details

From the project README

PMD - source code analyzer

PMD is an extensible multilanguage static code analyzer. It finds common programming flaws like unused variables, empty catch blocks, unnecessary object creation, and so forth. It's mainly concerned with Java and Apex, but supports 16 other languages. It comes with 400+ built-in rules. It can be extended with custom rules. It uses JavaCC and Antlr to parse source files into abstract syntax trees (AST) and runs rules against them to find violations. Rules can be written in Java or using a XPath query.

Currently, PMD supports Java, JavaScript, Salesforce.com Apex and Visualforce, Kotlin, Swift, Modelica, PL/SQL, Apache Velocity, JSP, WSDL, Maven POM, HTML, XML and XSL. Scala is supported, but there are currently no Scala rules available.

Additionally, it includes CPD, the copy-paste-detector. CPD finds duplicated code in Coco, C/C++, C#, CSS, Dart, Fortran, Gherkin, Go, Groovy, HTML, Java, JavaScript, JSP, Julia, Kotlin, Lua, Matlab, Modelica, Objective-C, Perl, PHP, PL/SQL, Python, Ruby, Salesforce.com Apex and Visualforce, Scala, Swift, T-SQL, Typescript, Apache Velocity, WSDL, XML and XSL.

🚀️ Installation and Usage

Download the latest binary zip from the releases and extract it somewhere.

Execute bin/pmd check or bin\pmd.bat check.

ℹ️ How to get support?

How do I? -- Ask a question on StackOverflow or on discussions.
I got this error, why? -- Ask a question on StackOverflow or on discussions.
I got this error and I'm sure it's a bug -- file an issue.
I have an idea/request/question -- create a new discussion.
I have a quick question -- ask in our Gitter room or our PMD Guru at Gurubase.
Where's your documentation? -- https://docs.pmd-code.org/latest/

🤝️ Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Our latest source of PMD can be found on GitHub. Fork us!

For details, see How to contribute to PMD.

The rule designer is developed over at pmd/pmd-designer. Please see its README for developer documentation.

💵️ Financial Contributors

Become a financial contributor and help us sustain our community. Contribute

✨️ Contributors

This project follows the all-contributors specification. Contributions of any kind welcome!

See credits for the complete list.

📝️ License

BSD Style

Comments

Markdown supported

New to MCP?

From what the protocol is to installing your first server, these answers cover most first questions.

Read the getting-started guide

An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.

pmd