Aderyn MCP Server

Aderyn is retired and no longer maintained. There are no supported installation or upgrade paths. The usage and integration documentation below is retained for historical reference. Existing installations receive no updates or support.

<p align="center"> <br /> <a href="https://cyfrin.io/"> <img src="https://github.com/Cyfrin/aderyn/blob/dev/.github/images/aderyn_logo.png" width="400" alt=""/></a> <br /> </p> <p align="center"><strong>A powerful Solidity static analyzer that takes a bird's eye view over your smart contracts. </strong></p> <p align="center"> <br /> <a href="https://cyfrin.io/"> <img src="https://github.com/Cyfrin/aderyn/blob/dev/.github/images/poweredbycyfrinblue.png" width="145" alt=""/></a> <br /> </p> <p align="center"> <a href="https://cyfrin.gitbook.io/cyfrin-docs/aderyn-cli/readme">Docs</a> <a href="https://discord.gg/cyfrin">Discord</a> <a href="https://x.com/cyfrin">X/Twitter</a> <p>

---

<div align="center">

</div>

What is Aderyn?

Aderyn is an open-source public good developer tool. It is a Rust-based solidity smart contract static analyzer designed to help protocol engineers and security researchers find vulnerabilities in Solidity code bases.

You can read the Cyfrin official documentation for an in-depth look at Aderyn's functionalities.

The VS Code extension is also retired and has been delisted from the Visual Studio Marketplace.

Features

• Runs without need for any configuration support for Foundry and Hardhat projects.
• Creates Markdown, JSON and Sarif reports.
• Previously powered the VS Code extension.
• List of supported detectors
• Contributor Friendly
• Downloaded more than 45K times.

Installation and removal

Aderyn installation and upgrades are no longer supported through Homebrew, npm, Cyfrinup, or the shell installer. Legacy installer scripts and release assets may remain accessible during retirement; they are not supported installation paths.

Homebrew

The Aderyn Homebrew package is retired. Remove an existing installation with:

brew uninstall cyfrin/tap/aderyn

npm

The Aderyn npm package is retired. Remove an existing global installation with:

npm uninstall --global @cyfrin/aderyn

Quick Start (historical)

Run aderyn --version to check if Aderyn is installed successfully.

Quick Start example with video guide.

cd path/to/solidity/project/root
aderyn

This generates a report.md

See examples using more CLI options here

VS Code extension

The VS Code extension is retired and has been delisted from the Visual Studio Marketplace. Existing users can uninstall Aderyn from VS Code's Extensions view.

Github Action

The historical Aderyn CI Assistant integration performed static analysis on Solidity codebases in CI. This integration is no longer supported.

Contributing & License

Historical developer setup and contribution information is retained in the contribution guidelines. Aderyn is an open-source software licensed under the GPL-3.0 License.

To learn how to create your custom Aderyn detectors, checkout the official docs

Aderyn relies on a custom backend to generate AST for Solidity codebases. It leverages foundry-compilers

Credits

This project exists thanks to all the people who contribute.<br>

<a href="https://github.com/cyfrin/Aderyn/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cyfrin/Aderyn" /> </a>

Attribution

• Initial inspiration for AST Visitor code from solc-ast-rs.
• Original detectors based on 4naly3er detectors.
• Shoutout to the original king of static analysis slither.