jadx-mcp-server

<div align="center"> # JADX-MCP-SERVER (Part of Zin's Reverse Engineering MCP Suite) ⚡ Fully automated MCP server built to communicate with JADX-AI-MCP Plugin to analyze Android APKs using LLMs like Claude — uncover vulnerabilities, parse manifests, and reverse engineer effortlessly.        [](http://www.apache.org/licenses/LICENSE-2.0.html) #### ⭐ Contributors Thanks to these wonderful people for their contributions ⭐ <table> <tr align="center"> <td> <a href="https://github.com/ljt270864457"> <img src="https://avatars.githubusercontent.com/u/8609890?v=4" width="30px;" alt=""/> <br />_{<b>ljt270864457</b>} </a> </td> <td> <a href="https://github.com/badmonkey7"> <img src="https://avatars.githubusercontent.com/u/41368882?v=4" width="30px;" alt=""/> <br />_{<b>badmonkey7</b>} </a> </td> <td> <a href="https://github.com/p0px"> <img src="https://avatars.githubusercontent.com/u/161268024?v=4" width="30px;" alt=""/> <br />_<b>p0px</b> </a> </td> <td> <a href="https://github.com/bx33661"> <img src="https://avatars.githubusercontent.com/u/138348615?v=4" width="30px;" alt=""/> <br />_{<b>bx33661</b>} </a> </td> <td> <a href="https://github.com/Haicaji"> <img src="https://avatars.githubusercontent.com/u/132796021?v=4" width="30px;" alt=""/> <br />_{<b>Haicaji</b>} </a> </td> <td> <a href="https://github.com/mostafaNazari702"> <img src="https://avatars.githubusercontent.com/u/93077724?v=4" width="30px;" alt=""/> <br />_{<b>Mostafa Nazari</b>} </a> </td> <td> <a href="https://github.com/ChineseAStar"> <img src="https://avatars.githubusercontent.com/u/24355243?v=4" width="30px;" alt=""/> <br />_{<b>ChineseAStar</b>} </a> </td> <td> <a href="https://github.com/cyal1r"> <img src="https://avatars.githubusercontent.com/u/33282478?v=4" width="30px;" alt=""/> <br />_<b>cyal1</b> </a> </td> <td> <a href="https://github.com/tiann"> <img src="https://avatars.githubusercontent.com/u/4233744?v=4" width="30px;" alt=""/> <br />_<b>tainn</b> </a> </td> <td> <a href="https://github.com/ZERO-A-ONE"> <img src="https://avatars.githubusercontent.com/u/18625356?v=4" width="30px;" alt=""/> <br />_{<b>ZERO-A-ONE</b>} </a> </td> <td> <a href="https://github.com/neoz"> <img src="https://avatars.githubusercontent.com/u/360582?v=4" width="30px;" alt=""/> <br />_<b>neoz</b> </a> </td> <td> <a href="https://github.com/SamadiPour"> <img src="https://avatars.githubusercontent.com/u/24422125?v=4" width="30px;" alt=""/> <br />_{<b>SamadiPour</b>} </a> </td> <td> <a href="https://github.com/wuseluosi"> <img src="https://avatars.githubusercontent.com/u/192840340?v=4" width="30px;" alt=""/> <br />_{<b>wuseluosi</b>} </a> </td> <td> <a href="https://github.com/CainYzb"> <img src="https://avatars.githubusercontent.com/u/50669073?v=4" width="30px;" alt=""/> <br />_{<b>CainYzb</b>} </a> </td> <td> <a href="https://github.com/tbodt"> <img src="https://avatars.githubusercontent.com/u/5678977?v=4" width="30px;" alt=""/> <br />_<b>tbodt</b> </a> </td> <td> <a href="https://github.com/LilNick0101"> <img src="https://avatars.githubusercontent.com/u/100995805?v=4" width="30px;" alt=""/> <br />_{<b>LikNick0101</b>} </a> </td> <td> <a href="https://github.com/lwsinclair"> <img src="https://avatars.githubusercontent.com/u/2829939?v=4" width="30px;" alt=""/> <br />_{<b>lwsinclair</b>} </a> </td> </tr> </table> </div> <!-- Still in early stage of development — expect bugs, crashes, and logical errors.--> <!-- MCP (Model Context Protocol) server that connects to a custom plugin of [JADX](https://github.com/skylot/jadx) called [JADX-AI-MCP](https://github.com/zinja-coder/jadx-ai-mcp) and provides reverse engineering capabilities directly to local LLMs like Claude Desktop.--> <div align="center"> <img alt="banner" height="480px" widht="620px" src="static/image.png"> </div> #### ReadTheDocs: - We are now live at Read The Docs: --- #### Download now: https://github.com/zinja-coder/jadx-ai-mcp/releases --- ## 🤖 What is JADX-MCP-SERVER? **JADX MCP Server** is a standalone Python server that interacts with a modified version of `jadx-gui` (see: [jadx-ai-mcp](https://github.com/zinja-coder/jadx-ai-mcp)) via MCP (Model Context Protocol). It lets LLMs communicate with the decompiled Android app context live. ## 🤖 What is JADX-AI-MCP? **JADX-AI-MCP** is a plugin for the [JADX decompiler](https://github.com/skylot/jadx) that integrates directly with [Model Context Protocol (MCP)](https://github.com/anthropic/mcp) to provide **live reverse engineering support with LLMs like Claude**. Think: "Decompile → Context-Aware Code Review → AI Recommendations" — all in real time. #### High Level Sequence Diagram ```mermaid sequenceDiagram LLM CLIENT->>JADX MCP SERVER: INVOKE MCP TOOL JADX MCP SERVER->>JADX AI MCP PLUGIN: INVOKE HTTP REQUEST JADX AI MCP PLUGIN->>REQUEST HANDLERS: INVOKE HTTP REQUEST HANDLER REQUEST HANDLERS->>JADX GUI: PERFORM ACTION/GATHER DATA JADX GUI->>REQUEST HANDLERS: ACTION PERFORMED/DATA GATHERED REQUEST HANDLERS->>JADX AI MCP PLUGIN: CRAFT HTTP RESPONSE JADX AI MCP PLUGIN->>JADX MCP SERVER:HTTP RESPONSE JADX MCP SERVER->>LLM CLIENT: MCP TOOL RESULT ``` Watch the demos! - **Perform quick analysis** https://github.com/user-attachments/assets/b65c3041-fde3-4803-8d99-45ca77dbe30a - **Quickly find vulnerabilities** https://github.com/user-attachments/assets/c184afae-3713-4bc0-a1d0-546c1f4eb57f - **Multiple AI Agents Support** https://github.com/user-attachments/assets/6342ea0f-fa8f-44e6-9b3a-4ceb8919a5b0 - **Analyze The APK Resources** https://github.com/user-attachments/assets/f42d8072-0e3e-4f03-93ea-121af4e66eb1 - **Your AI Assistant during debugging of APK using JADX** https://github.com/user-attachments/assets/2b0bd9b1-95c1-4f32-9b0c-38b864dd6aec It is combination of two tools: 1. [JADX-AI-MCP](https://github.com/zinja-coder/jadx-ai-mcp) 2. JADX MCP SERVER --- # Zin MCP Suite - **[APKTool-MCP-Server](https://github.com/zinja-coder/apktool-mcp-server)** - **[JAD-AI-MCP-Plugin](https://github.com/zinja-coder/jadx-ai-mcp)** - **[ZIN-MCP-Client](https://github.com/zinja-coder/zin-mcp-client)** ## Current MCP Tools The following MCP tools are available: - `fetch_current_class()` — Get the class name and full source of selected class - `get_selected_text()` — Get currently selected text - `get_all_classes()` — List all classes in the project - `get_class_source()` — Get full source of a given class - `get_method_by_name()` — Fetch a method’s source - `search_method_by_name()` — Search method across classes - `search_classes_by_keyword()` — Search for classes whose source code contains a specific keyword (supports pagination) - `get_methods_of_class()` — List methods in a class - `get_fields_of_class()` — List fields in a class - `get_smali_of_class()` — Fetch smali of class - `get_main_activity_class()` — Fetch main activity from jadx mentioned in AndroidManifest.xml file. - `get_main_application_classes_code()` — Fetch all the main application classes' code based on the package name defined in the AndroidManifest.xml. - `get_main_application_classes_names()` — Fetch all the main application classes' names based on the package name defined in the AndroidManifest.xml. - `get_android_manifest()` — Retrieve and return the AndroidManifest.xml content. - `get_manifest_component` - Retrieve specific manifest component instead of whole manifest file - `get_strings()` : Fetches the strings.xml file - `get_all_resource_file_names()` : Retrieve all resource files names that exists in application - `get_resource_file()` : Retrieve resource file content - `rename_variable()` : Renames the variable within a method - `debug_get_stack_frames()` : Get the stack frames from jadx debugger - `debug_get_threads()` : Get the insights of threads from jadx debugger - `debug_get_variables()` : Get the variables from jadx debugger - `xrefs_to_class()` : Find all references to a class (returns method-level and class-level references, supports pagination) - `xrefs_to_method()` : Find all references to a method (includes override-related methods, supports pagination) - `xrefs_to_field()` : Find all references to a field (returns methods that access the field, supports pagination) --- #### Note: Tested on Claude Desktop. Support for other LLMs might be tested in future. ## 🗒️ Sample Prompts 🔍 Basic Code Understanding "Explain what this class does in one paragraph." "Summarize the responsibilities of this method." "Is there any obfuscation in this class?" "List all Android permissions this class might require." 🛡️ Vulnerability Detection "Are there any insecure API usages in this method?" "Check this class for hardcoded secrets or credentials." "Does this method sanitize user input before using it?" "What security vulnerabilities might be introduced by this code?" 🛠️ Reverse Engineering Helpers "Deobfuscate and rename the classes and methods to something readable." "Can you infer the original purpose of this smali method?" "What libraries or SDKs does this class appear to be part of?" 📦 Static Analysis "List all network-related API calls in this class." "Identify file I/O operations and their potential risks." "Does this method leak device info or PII?" 🤖 AI Code Modification "Refactor this method to improve readability." "Add comments to this code explaining each step." "Rewrite this Java method in Python for analysis." 📄 Documentation & Metadata "Generate Javadoc-style comments for all methods." "What package or app component does this class likely belong to?" "Can you identify the Android component type (Activity, Service, etc.)?" 🐞 Debugger Assistant ``` "Fetch stack frames, varirables and threads from debugger and provide summary" "Based the stack frames from debugger, explain the execution flow of the application" "Based on the state of variables, is there security threat?" ``` --- ## 🛠️ Getting Started [READ HERE](https://github.com/zinja-coder/jadx-ai-mcp?tab=readme-ov-file#%EF%B8%8F-getting-started) Demo: **Perform Code Review to Find Vulnerabilities locally** https://github.com/user-attachments/assets/4cd26715-b5e6-4b4b-95e4-054de6789f42 ### Advanced CLI Options — Understanding the Flags There are **two separate connections** and each has its own host/port: ``` ┌─────────────┐ --host / --port ┌──────────────────┐ --jadx-host / --jadx-port ┌──────────────────┐ │ LLM Client │ ◄──────────────────► │ jadx-mcp-server │ ──────────────────────────► │ JADX-GUI Plugin │ │ (Claude, │ Where the MCP server │ │ Where the MCP server looks │ (jadx-ai-mcp) │ │ Codex..) │ LISTENS for clients │ │ for the JADX plugin │ │ └─────────────┘ └──────────────────┘ └──────────────────┘ ``` | Flag | Default | Controls | |------|---------|----------| | `--http` | off | Use HTTP transport instead of stdio | | `--host` | `127.0.0.1` | **Where the MCP server listens** (bind address for LLM clients) | | `--port` | `8651` | **Which port the MCP server listens on** | | `--jadx-host` | `127.0.0.1` | **Where to find the JADX plugin** (the target JADX-GUI machine) | | `--jadx-port` | `8650` | **Which port the JADX plugin is on** | ### Usage Examples **Scenario 1 — Everything on the same machine (most common):** ```bash # Default: MCP server on localhost:8651, connects to JADX plugin on localhost:8650 uv run jadx_mcp_server.py --http ``` **Scenario 2 — Docker container or WSL (MCP server accessible from host network):** ```bash # MCP server listens on ALL interfaces so the host can reach it # JADX plugin is still on the same machine uv run jadx_mcp_server.py --http --host 0.0.0.0 ``` **Scenario 3 — JADX-GUI running on a different machine (e.g., remote VM):** ```bash # MCP server runs locally, but connects to JADX plugin on a remote machine uv run jadx_mcp_server.py --http --jadx-host 192.168.1.100 ``` **Scenario 4 — Full remote setup (everything on different machines):** ```bash # MCP server listens on all interfaces on port 9999 # JADX plugin is on a different machine at 192.168.1.100:8652 uv run jadx_mcp_server.py --http --host 0.0.0.0 --port 9999 --jadx-host 192.168.1.100 --jadx-port 8652 ``` > [!CAUTION] > ### ⚠️ Security Warning — Remote Binding > > When using `--host 0.0.0.0` (or any non-localhost address), the MCP server binds to **all network interfaces** over **plain HTTP with no authentication**. This means: > > - **Anyone on the network** can connect and invoke all MCP tools > - There is **no TLS encryption** — traffic can be intercepted > - An attacker can use the server to **read decompiled code**, **rename classes/methods**, and **access debug info** > > **Mitigations:** > - Only bind to `0.0.0.0` on **trusted, isolated networks** (e.g., Docker bridge, local VM) > - Use a **firewall** to restrict access to the MCP port > - Consider an **SSH tunnel** instead: `ssh -L 8651:127.0.0.1:8651 remote-host` > > Similarly, `--jadx-host` with a non-localhost address means the MCP server will make **unauthenticated HTTP requests** to that host. Ensure the target is trusted. ## 🛣️ Future Roadmap - [x] Add Support for apktool - [ ] Add support for hermes code (ReactNative Application) - [ ] Add docker support - [x] Add more useful MCP Tools - [x] Make LLM be able to modify code on JADX - [x] Add prompts templates, give llm access to Android APK Files as Resources - [ ] ~~Build MCP Client to support Local LLM~~ - [ ] **END-GOAL** : Make all android reverse engineering and APK modification tools Connect with single MCP server to make reverse engineering apk files as easy as possible purely from vibes. ## NOTE For Contributors - The files related to JADX-AI-MCP can be found [here](https://github.com/zinja-coder/jadx-ai-mcp) - The files related to **jadx-mcp-server** can be found in this repository only. ## 🙏 Credits This project is a plugin for JADX, an amazing open-source Android decompiler created and maintained by [@skylot](https://github.com/skylot). All core decompilation logic belongs to them. I have only extended it to support my MCP server with AI capabilities. [📎 Original README (JADX)](https://github.com/skylot/jadx) The original README.md from jadx is included here in this repository for reference and credit. This MCP server is made possible by the extensibility of JADX-GUI and the amazing Android reverse engineering community. Also huge thanks to [@aaddrick](https://github.com/aaddrick) for developing Claude desktop for Debian based linux. And in last thanks to [@anthropics](https://github.com/anthropics) for developing the Model Context Protocol and [@FastMCP](https://github.com/modelcontextprotocol/python-sdk) team And all open source maintainers and contributors that makes libraries and dependencies which allows project like this possible. ## Audited and Received Assessment Badge [](https://mseep.ai/app/zinja-coder-jadx-mcp-server) Thank you Mseep.net for auditing and providing Assessment Badge. ### Dependencies This project uses following awesome libraries. - Plugin - Java - Javalin - https://javalin.io/ - Apache 2.0 License - SLF4J - https://slf4j.org/ - MIT License - org.w3c.dom - https://mvnrepository.com/artifact/org.w3c.dom - W3C Software and Document License - MCP Server - Python - FastMCP - https://github.com/jlowin/fastmcp - Apache 2.0 License - httpx - https://www.python-httpx.org - BSD-3-Clause (“BSD licensed”) ## 📄 License This plugin inherits the Apache 2.0 License from the original JADX repository. ## ⚖️ Legal Warning **Disclaimer** The tools `jadx-ai-mcp` and `jadx_mcp_server` are intended strictly for educational, research, and ethical security assessment purposes. They are provided "as-is" without any warranties, expressed or implied. Users are solely responsible for ensuring that their use of these tools complies with all applicable laws, regulations, and ethical guidelines. By using `jadx-ai-mcp` or `jadx_mcp_server`, you agree to use them only in environments you are authorized to test, such as applications you own or have explicit permission to analyze. Any misuse of these tools for unauthorized reverse engineering, infringement of intellectual property rights, or malicious activity is strictly prohibited. The developers of `jadx-ai-mcp` and `jadx_mcp_server` shall not be held liable for any damage, data loss, legal consequences, or other consequences resulting from the use or misuse of these tools. Users assume full responsibility for their actions and any impact caused by their usage. Use responsibly. Respect intellectual property. Follow ethical hacking practices. --- ## 🙌 Contribute or Support - Found it useful? Give it a ⭐️ - Got ideas? Open an [issue](https://github.com/zinja-coder/jadx-mcp-server/issues) or submit a PR - Built something on top? DM me or mention me — I’ll add it to the README! --- Built with ❤️ for the reverse engineering and AI communities.