java-class-analyzer-mcp 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. java_class_analyzer_mcp-0.1.0/PKG-INFO +200 -0
  2. java_class_analyzer_mcp-0.1.0/README.md +185 -0
  3. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp/__init__.py +3 -0
  4. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp/analyzer/__init__.py +3 -0
  5. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp/analyzer/java_class_analyzer.py +384 -0
  6. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp/cfr-0.152.jar +0 -0
  7. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp/cli/__init__.py +3 -0
  8. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp/cli.py +145 -0
  9. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp/decompiler/__init__.py +3 -0
  10. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp/decompiler/decompiler_service.py +218 -0
  11. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp/main.py +102 -0
  12. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp/scanner/__init__.py +3 -0
  13. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp/scanner/dependency_scanner.py +342 -0
  14. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp.egg-info/PKG-INFO +200 -0
  15. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp.egg-info/SOURCES.txt +19 -0
  16. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp.egg-info/dependency_links.txt +1 -0
  17. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp.egg-info/entry_points.txt +2 -0
  18. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp.egg-info/requires.txt +2 -0
  19. java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp.egg-info/top_level.txt +1 -0
  20. java_class_analyzer_mcp-0.1.0/pyproject.toml +32 -0
  21. java_class_analyzer_mcp-0.1.0/setup.cfg +4 -0
java_class_analyzer_mcp-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,200 @@
1
+ Metadata-Version: 2.4
2
+ Name: java-class-analyzer-mcp
3
+ Version: 0.1.0
4
+ Summary: MCP server for scanning Maven dependencies and decompiling Java classes
5
+ Author: java-class-analyzer-mcp contributors
6
+ License: MIT
7
+ Keywords: mcp,java,decompiler,maven
8
+ Classifier: Programming Language :: Python :: 3
9
+ Classifier: License :: OSI Approved :: MIT License
10
+ Classifier: Operating System :: OS Independent
11
+ Requires-Python: >=3.11
12
+ Description-Content-Type: text/markdown
13
+ Requires-Dist: mcp[cli]>=1.26.0
14
+ Requires-Dist: click>=8.0.0
15
+
16
+ # Java Class Analyzer MCP
17
+
18
+ 一个基于 Model Context Protocol (MCP) 的 Java 类分析服务，可以扫描 Maven 项目依赖、反编译 Java 类文件、获取 class 方法列表等详细信息，并提供给 LLM 进行代码分析。
19
+
20
+ ## 适用场景
21
+
22
+ Cursor 等 AI 工具直接生成调用二方（内部调用）、三方包（外部调用）接口的代码，但因 AI 无法读取未在当前工程中打开的依赖源码，导致生成的代码错误频出，甚至出现幻觉式编码。
23
+
24
+ 为解决此问题，一般会直接拷贝源码内容喂给 LLM；或者先将源码文件放到当前工程内，再在对话中引用。
25
+
26
+ 而使用本地反编译 MCP 方案最有效，能精准解析 jar 包中的类与方法，显著提升代码生成的准确性和可用性。
27
+
28
+ ## 功能特性
29
+
30
+ - **使用方便**：基于 Python 实现，通过 `pip install` 一键安装，内置 CFR 反编译工具，无需手动下载
31
+ - **依赖扫描**：自动扫描 Maven 项目的所有依赖 JAR 包
32
+ - **类索引**：建立类全名到 JAR 包路径的映射索引
33
+ - **反编译**：使用内置 CFR 工具实时反编译 .class 文件为 Java 源码
34
+ - **类分析**：分析 Java 类的结构、方法、字段、继承关系等
35
+ - **智能缓存**：按包名结构缓存反编译结果，支持缓存控制
36
+ - **自动索引**：执行分析前自动检查并创建索引
37
+ - **LLM 集成**：通过 MCP 协议为 LLM 提供 Java 代码分析能力
38
+
39
+ ## 安装说明
40
+
41
+ ### 环境要求
42
+
43
+ - Python 3.11+
44
+ - Java Development Kit (JDK) 8+（用于运行 CFR 反编译工具）
45
+ - Maven 3.6+
46
+
47
+ ### 安装
48
+
49
+ ```bash
50
+ pip install java-class-analyzer-mcp
51
+ ```
52
+
53
+ CFR 反编译工具已内置于包中，无需手动下载。
54
+
55
+ ## MCP 服务配置
56
+
57
+ ### Cursor / 通用 MCP 客户端配置
58
+
59
+ 在 MCP 客户端配置文件中添加以下内容：
60
+
61
+ ```json
62
+ {
63
+ "mcpServers": {
64
+ "java-class-analyzer": {
65
+ "command": "java-class-analyzer-mcp",
66
+ "env": {
67
+ "LOG_LEVEL": "INFO",
68
+ "MAVEN_REPO": "~/.m2/repository",
69
+ "JAVA_HOME": "/path/to/your/jdk",
70
+ "CFR_PATH": ""
71
+ }
72
+ }
73
+ }
74
+ }
75
+ ```
76
+
77
+ ### OpenCode 配置示例
78
+
79
+ ```json
80
+ {
81
+ "mcp": {
82
+ "java-class-analyzer": {
83
+ "command": ["java-class-analyzer-mcp"],
84
+ "enabled": true,
85
+ "environment": {
86
+ "LOG_LEVEL": "INFO",
87
+ "MAVEN_REPO": "~/.m2/repository",
88
+ "JAVA_HOME": "",
89
+ "CFR_PATH": ""
90
+ },
91
+ "type": "local"
92
+ }
93
+ }
94
+ }
95
+ ```
96
+
97
+ ### 环境变量说明
98
+
99
+ | 变量 | 说明 | 默认值 |
100
+ |------|------|--------|
101
+ | `LOG_LEVEL` | 日志级别（`INFO` 静默，`DEBUG` 详细） | `INFO` |
102
+ | `MAVEN_REPO` | Maven 本地仓库路径 | `~/.m2/repository` |
103
+ | `JAVA_HOME` | Java 安装路径（留空则使用 PATH 中的 java） | 空 |
104
+ | `CFR_PATH` | CFR jar 包路径（留空则使用内置 jar） | 空 |
105
+
106
+ ## 项目结构
107
+
108
+ ```
109
+ java-class-analyzer-mcp/
110
+ ├── java_class_analyzer_mcp/
111
+ │ ├── __init__.py
112
+ │ ├── main.py # MCP 服务器主入口
113
+ │ ├── cli.py # 命令行工具
114
+ │ ├── cfr-0.152.jar # 内置 CFR 反编译工具
115
+ │ ├── scanner/
116
+ │ │ └── dependency_scanner.py # Maven 依赖扫描模块
117
+ │ ├── decompiler/
118
+ │ │ └── decompiler_service.py # Java 类反编译模块
119
+ │ └── analyzer/
120
+ │ └── java_class_analyzer.py # Java 类结构分析模块
121
+ └── pyproject.toml
122
+ ```
123
+
124
+ ## 可用的 MCP 工具
125
+
126
+ ### 1. scan_dependencies
127
+
128
+ 扫描 Maven 项目的所有依赖，建立类名到 JAR 包的映射索引。
129
+
130
+ **参数:**
131
+ - `projectPath` (string): Maven 项目根目录路径
132
+ - `forceRefresh` (boolean, 可选): 是否强制刷新索引，默认 false
133
+
134
+ ### 2. decompile_class
135
+
136
+ 反编译指定的 Java 类文件，返回 Java 源码。
137
+
138
+ **参数:**
139
+ - `className` (string): 要反编译的类全名，如 `com.example.QueryBizOrderDO`
140
+ - `projectPath` (string): Maven 项目根目录路径
141
+ - `useCache` (boolean, 可选): 是否使用缓存，默认 true
142
+
143
+ ### 3. analyze_class
144
+
145
+ 分析 Java 类的结构、方法、字段等信息。
146
+
147
+ **参数:**
148
+ - `className` (string): 要分析的类全名
149
+ - `projectPath` (string): Maven 项目根目录路径
150
+
151
+ ## 命令行工具
152
+
153
+ 安装后可直接使用命令行工具：
154
+
155
+ ```bash
156
+ # 启动 MCP 服务器（stdio 模式，供 MCP 客户端调用）
157
+ java-class-analyzer-mcp
158
+
159
+ # 生成 MCP 配置模板
160
+ java-class-analyzer-mcp config -o mcp-config.json
161
+
162
+ # 测试工具
163
+ java-class-analyzer-mcp test -t scan -p /path/to/project
164
+ java-class-analyzer-mcp test -t decompile -p /path/to/project -c com.example.MyClass
165
+ java-class-analyzer-mcp test -t analyze -p /path/to/project -c com.example.MyClass
166
+ java-class-analyzer-mcp test -t all -p /path/to/project -c com.example.MyClass --no-cache
167
+ ```
168
+
169
+ ## 缓存文件
170
+
171
+ 在项目目录下会生成以下缓存：
172
+
173
+ - `.mcp-class-index.json`: 类索引缓存文件
174
+ - `.mcp-decompile-cache/`: 反编译结果缓存目录（按包名结构）
175
+ - `.mcp-class-temp/`: 临时文件目录（按包名结构）
176
+
177
+ ## 工作流程
178
+
179
+ 1. **自动索引**: 首次调用 `analyze_class` 或 `decompile_class` 时，自动检查并创建索引
180
+ 2. **智能缓存**: 反编译结果按包名结构缓存，避免重复反编译
181
+ 3. **分析类**: 使用 `analyze_class` 或 `decompile_class` 获取类的详细信息
182
+ 4. **LLM 分析**: 将反编译的源码提供给 LLM 进行代码分析
183
+
184
+ ## 故障排除
185
+
186
+ **Maven 命令失败**
187
+ - 确保 Maven 已安装并在 PATH 中
188
+ - 检查项目是否有有效的 `pom.xml` 文件
189
+
190
+ **CFR 反编译失败**
191
+ - 确保 Java 环境已正确配置（`java` 命令可用）
192
+ - 如需指定自定义 CFR jar，设置 `CFR_PATH` 环境变量
193
+
194
+ **类未找到**
195
+ - 检查类名是否正确（需要完整包名）
196
+ - 使用 `scan_dependencies` 刷新索引：`forceRefresh: true`
197
+
198
+ ## 许可证
199
+
200
+ MIT License
java_class_analyzer_mcp-0.1.0/README.md ADDED
@@ -0,0 +1,185 @@
1
+ # Java Class Analyzer MCP
2
+
3
+ 一个基于 Model Context Protocol (MCP) 的 Java 类分析服务，可以扫描 Maven 项目依赖、反编译 Java 类文件、获取 class 方法列表等详细信息，并提供给 LLM 进行代码分析。
4
+
5
+ ## 适用场景
6
+
7
+ Cursor 等 AI 工具直接生成调用二方（内部调用）、三方包（外部调用）接口的代码，但因 AI 无法读取未在当前工程中打开的依赖源码，导致生成的代码错误频出，甚至出现幻觉式编码。
8
+
9
+ 为解决此问题，一般会直接拷贝源码内容喂给 LLM；或者先将源码文件放到当前工程内，再在对话中引用。
10
+
11
+ 而使用本地反编译 MCP 方案最有效，能精准解析 jar 包中的类与方法，显著提升代码生成的准确性和可用性。
12
+
13
+ ## 功能特性
14
+
15
+ - **使用方便**：基于 Python 实现，通过 `pip install` 一键安装，内置 CFR 反编译工具，无需手动下载
16
+ - **依赖扫描**：自动扫描 Maven 项目的所有依赖 JAR 包
17
+ - **类索引**：建立类全名到 JAR 包路径的映射索引
18
+ - **反编译**：使用内置 CFR 工具实时反编译 .class 文件为 Java 源码
19
+ - **类分析**：分析 Java 类的结构、方法、字段、继承关系等
20
+ - **智能缓存**：按包名结构缓存反编译结果，支持缓存控制
21
+ - **自动索引**：执行分析前自动检查并创建索引
22
+ - **LLM 集成**：通过 MCP 协议为 LLM 提供 Java 代码分析能力
23
+
24
+ ## 安装说明
25
+
26
+ ### 环境要求
27
+
28
+ - Python 3.11+
29
+ - Java Development Kit (JDK) 8+（用于运行 CFR 反编译工具）
30
+ - Maven 3.6+
31
+
32
+ ### 安装
33
+
34
+ ```bash
35
+ pip install java-class-analyzer-mcp
36
+ ```
37
+
38
+ CFR 反编译工具已内置于包中，无需手动下载。
39
+
40
+ ## MCP 服务配置
41
+
42
+ ### Cursor / 通用 MCP 客户端配置
43
+
44
+ 在 MCP 客户端配置文件中添加以下内容：
45
+
46
+ ```json
47
+ {
48
+ "mcpServers": {
49
+ "java-class-analyzer": {
50
+ "command": "java-class-analyzer-mcp",
51
+ "env": {
52
+ "LOG_LEVEL": "INFO",
53
+ "MAVEN_REPO": "~/.m2/repository",
54
+ "JAVA_HOME": "/path/to/your/jdk",
55
+ "CFR_PATH": ""
56
+ }
57
+ }
58
+ }
59
+ }
60
+ ```
61
+
62
+ ### OpenCode 配置示例
63
+
64
+ ```json
65
+ {
66
+ "mcp": {
67
+ "java-class-analyzer": {
68
+ "command": ["java-class-analyzer-mcp"],
69
+ "enabled": true,
70
+ "environment": {
71
+ "LOG_LEVEL": "INFO",
72
+ "MAVEN_REPO": "~/.m2/repository",
73
+ "JAVA_HOME": "",
74
+ "CFR_PATH": ""
75
+ },
76
+ "type": "local"
77
+ }
78
+ }
79
+ }
80
+ ```
81
+
82
+ ### 环境变量说明
83
+
84
+ | 变量 | 说明 | 默认值 |
85
+ |------|------|--------|
86
+ | `LOG_LEVEL` | 日志级别（`INFO` 静默，`DEBUG` 详细） | `INFO` |
87
+ | `MAVEN_REPO` | Maven 本地仓库路径 | `~/.m2/repository` |
88
+ | `JAVA_HOME` | Java 安装路径（留空则使用 PATH 中的 java） | 空 |
89
+ | `CFR_PATH` | CFR jar 包路径（留空则使用内置 jar） | 空 |
90
+
91
+ ## 项目结构
92
+
93
+ ```
94
+ java-class-analyzer-mcp/
95
+ ├── java_class_analyzer_mcp/
96
+ │ ├── __init__.py
97
+ │ ├── main.py # MCP 服务器主入口
98
+ │ ├── cli.py # 命令行工具
99
+ │ ├── cfr-0.152.jar # 内置 CFR 反编译工具
100
+ │ ├── scanner/
101
+ │ │ └── dependency_scanner.py # Maven 依赖扫描模块
102
+ │ ├── decompiler/
103
+ │ │ └── decompiler_service.py # Java 类反编译模块
104
+ │ └── analyzer/
105
+ │ └── java_class_analyzer.py # Java 类结构分析模块
106
+ └── pyproject.toml
107
+ ```
108
+
109
+ ## 可用的 MCP 工具
110
+
111
+ ### 1. scan_dependencies
112
+
113
+ 扫描 Maven 项目的所有依赖，建立类名到 JAR 包的映射索引。
114
+
115
+ **参数:**
116
+ - `projectPath` (string): Maven 项目根目录路径
117
+ - `forceRefresh` (boolean, 可选): 是否强制刷新索引，默认 false
118
+
119
+ ### 2. decompile_class
120
+
121
+ 反编译指定的 Java 类文件，返回 Java 源码。
122
+
123
+ **参数:**
124
+ - `className` (string): 要反编译的类全名，如 `com.example.QueryBizOrderDO`
125
+ - `projectPath` (string): Maven 项目根目录路径
126
+ - `useCache` (boolean, 可选): 是否使用缓存，默认 true
127
+
128
+ ### 3. analyze_class
129
+
130
+ 分析 Java 类的结构、方法、字段等信息。
131
+
132
+ **参数:**
133
+ - `className` (string): 要分析的类全名
134
+ - `projectPath` (string): Maven 项目根目录路径
135
+
136
+ ## 命令行工具
137
+
138
+ 安装后可直接使用命令行工具：
139
+
140
+ ```bash
141
+ # 启动 MCP 服务器（stdio 模式，供 MCP 客户端调用）
142
+ java-class-analyzer-mcp
143
+
144
+ # 生成 MCP 配置模板
145
+ java-class-analyzer-mcp config -o mcp-config.json
146
+
147
+ # 测试工具
148
+ java-class-analyzer-mcp test -t scan -p /path/to/project
149
+ java-class-analyzer-mcp test -t decompile -p /path/to/project -c com.example.MyClass
150
+ java-class-analyzer-mcp test -t analyze -p /path/to/project -c com.example.MyClass
151
+ java-class-analyzer-mcp test -t all -p /path/to/project -c com.example.MyClass --no-cache
152
+ ```
153
+
154
+ ## 缓存文件
155
+
156
+ 在项目目录下会生成以下缓存：
157
+
158
+ - `.mcp-class-index.json`: 类索引缓存文件
159
+ - `.mcp-decompile-cache/`: 反编译结果缓存目录（按包名结构）
160
+ - `.mcp-class-temp/`: 临时文件目录（按包名结构）
161
+
162
+ ## 工作流程
163
+
164
+ 1. **自动索引**: 首次调用 `analyze_class` 或 `decompile_class` 时，自动检查并创建索引
165
+ 2. **智能缓存**: 反编译结果按包名结构缓存，避免重复反编译
166
+ 3. **分析类**: 使用 `analyze_class` 或 `decompile_class` 获取类的详细信息
167
+ 4. **LLM 分析**: 将反编译的源码提供给 LLM 进行代码分析
168
+
169
+ ## 故障排除
170
+
171
+ **Maven 命令失败**
172
+ - 确保 Maven 已安装并在 PATH 中
173
+ - 检查项目是否有有效的 `pom.xml` 文件
174
+
175
+ **CFR 反编译失败**
176
+ - 确保 Java 环境已正确配置（`java` 命令可用）
177
+ - 如需指定自定义 CFR jar，设置 `CFR_PATH` 环境变量
178
+
179
+ **类未找到**
180
+ - 检查类名是否正确（需要完整包名）
181
+ - 使用 `scan_dependencies` 刷新索引：`forceRefresh: true`
182
+
183
+ ## 许可证
184
+
185
+ MIT License
java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp/__init__.py ADDED
@@ -0,0 +1,3 @@
1
+ """
2
+ Java Class Analyzer MCP Server (Python版)
3
+ """
java_class_analyzer_mcp-0.1.0/java_class_analyzer_mcp/analyzer/__init__.py ADDED
@@ -0,0 +1,3 @@
1
+ """
2
+ Java类结构分析模块
3
+ """