使用说明
🔍 MCP JetBrains代码检查
[!小心]
⚠️ 废弃通知
此项目已弃用,但仍在运行。 从2025.2版本开始,JetBrains IDE(WebStorm、IntelliJ IDEA、PyCharm等)现在包括一个内置的MCP服务器,该服务器提供与外部客户端(如Claude Desktop、Cursor、VS Code等)的本地集成。
🔄 迁移选项
IDE版本 推荐解决方案 链接 2025.2+ 内置MCP服务器 官方文件 早期版本 JetBrains MCP插件 插件市场 ✅ 本地集成优势
- 直接IDE控制 无需外部工具
- 25+工具 综合工具集
- 更好的性能 以及可靠性
- 官方支持 来自JetBrains
[!重要] 本地人
get_file_problems工具需要设置errorsOnly: false用于与此项目类似的功能。这get_project_problems该工具仅返回关键错误。
A. 模型上下文协议(MCP) 该服务器为JetBrains IDE代码检查提供自动IDE选择和跨所有文件类型的统一检查配置文件。
[!提示] 📚 完整文档可用:请访问我们的综合文档 josedacosta.github.io/mcp-jetbrains代码检查
🎯 快速开始
[!注意] 在2分钟内开始!
# Clone the repository
git clone https://github.com/josedacosta/mcp-jetbrains-code-inspections.git
cd mcp-jetbrains-code-inspections
# Install and build
yarn install && yarn build
# Test with MCP Inspector
yarn inspect
然后使用以下命令配置MCP客户端(Claude Desktop、Cursor等) 配置如下.
✨ 特性
🚀 核心功能
|
🔧 高性能
|
📦 安装
[!注意] 先决条件:Node.js≥20,安装了JetBrains IDE
逐步安装
-
安装依赖项:
yarn install -
构建服务器:
yarn build -
配置MCP (参见 ⚙️ 配置 下节)
[!提示] 使用
yarn inspect安装后,使用MCP检查器测试服务器
🚀 用法
📚 MCP功能
服务器提供三种类型的MCP功能:
🔨 工具
- get_getbrains_code检查:对指定的文件或目录运行代码检查
💬 提示
- 分析项目:分析项目的代码质量问题
- 检查文件:检查特定文件中的问题
- 修复问题:获取解决检测到的问题的建议
📚 资源
- 我nspection://profiles:可用检查配置文件列表
- 我nspection://config:当前MCP服务器配置
- 我nspection://ides:系统上检测到的JetBrains IDE列表
🏃 运行服务器
[!提示] 为了开发,使用
yarn dev这包括热重新加载以实现更快的迭代。
# 🔄 Run in development mode (with hot-reload)
yarn dev
# 📦 Run the built server (production)
yarn start
# 🧪 Use MCP Inspector for interactive testing
yarn inspect
⚙️ 配置
代码检查服务器可以通过以下环境变量进行配置 .mcp.json:
{
"mcpServers": {
"mcp-jetbrains-code-inspections": {
"command": "node",
"args": ["./dist/index.js"],
"env": {
"EXCLUDE_INSPECTIONS": "SpellCheckingInspection"
}
}
}
}
📝 可用参数
🔧 刀具参数(必填)
[!重要] 该工具只接受LLM中的一个参数:
| 参数 | 类型 | 说明 | 必填 | 示例 |
|---|---|---|---|---|
path |
string |
要检查的文件或目录路径 | ✅ 是的 | "src/index.ts" 或 "./src" |
🌍 通过环境变量进行配置
[!注意] 所有配置都通过中的环境变量进行管理
.mcp.json这些设置控制检查服务器的操作方式。
📑 Available Environment Variables (click to expand)
| 环境变量 | 类型 | 描述 | 默认值 |
|---|---|---|---|
FORCE_INSPECT_PATH |
string |
强制特定IDE检查工具(禁用自动检测) | 自动检测 |
FORCE_PROJECT_ROOT |
string |
强制项目根目录(禁用自动检测) | 自动检测 |
FORCE_PROFILE_PATH |
string |
强制检查配置文件路径(禁用默认值) | 项目默认值 |
INSPECTION_TIMEOUT |
number |
最大分析时间(ms) | 120000 |
EXCLUDE_INSPECTIONS |
string |
要排除的逗号分隔的检查代码 | SpellCheckingInspection |
ONLY_INSPECTIONS |
string |
仅包括这些检验代码 | - |
RESPONSE_FORMAT |
'markdown'|'json' |
诊断输出格式 | 'markdown' |
DEBUG |
boolean |
启用调试日志记录 | false |
[!提示] 📚 有关详细的配置选项,请参阅 配置文档.
🧪 测试
1.️⃣ 交互式MCP测试
yarn test:mcp
这将运行一个交互式测试,允许您直接测试MCP服务器功能。
2.️⃣ MCP检查员测试(推荐)
# Launch the inspector (no installation needed)
yarn inspect
# Or for development mode with hot reload
yarn inspect:dev
检查器打开一个web界面,您可以在其中:
- 查看可用的工具、提示和资源
- 交互式测试get_getbrains_code_inspections工具
- 对常见任务使用预先配置的提示
- 访问服务器资源(配置文件、配置、检测到的IDE)
- 实时查看请求/响应
⚙️ 运作原理
🎯 自动IDE选择
[!注意] 服务器智能地检测并为您的项目选择最合适的JetBrains IDE。
优先级顺序:
- 智能 IDEA -终极Java/Kotlin集成开发环境
- WebStorm -JavaScript/TypeScript专家
- PyCharm 的 -Python开发
- 暴风雪 -PHP开发
- 戈兰 -Go编程
- 骑手 - .NET开发
- CLion -C/C++开发
- RubyMine -Ruby/Rails
- DataGraph -数据库管理
- DataSpell -数据科学
- AppCode -iOS/macOS开发
[!提示] 使用
FORCE_INSPECT_PATH以覆盖自动检测并指定特定的IDE。
🔒 隔离配置
[!重要] 关键创新:服务器使用临时隔离的配置目录
-Didea.config.path和-Didea.system.pathJVM属性。这使得即使IDE已经打开,检查也可以运行!
优点:
- ✅ 没有IDE冲突
- ✅ 并行执行支持
- ✅ 清洁、隔离的分析
- ✅ 不会干扰您的活动IDE会话
💻 输出示例
🔎 View Example Output (click to expand)
🔍 Searching for available JetBrains IDE inspect tools...
Following priority order: IntelliJ IDEA > WebStorm > PyCharm > PhpStorm > GoLand > ...
✅ WebStorm - Found and selected!
Path: /Applications/WebStorm.app/Contents/bin/inspect.sh
Note: Using isolated configuration - works even if IDE is already running
📊 Analysis Results:
⚠️ Warning: Unused variable 'config' at line 42
❌ Error: Missing semicolon at line 156
💡 Info: Consider using const instead of let at line 78
🛠️ 故障排除
❌ “未找到JetBrains IDE检查工具”
[!警告] 当在标准安装位置找不到JetBrains IDE时,会发生此错误。
解决:
- ✅ 验证是否已在中安装JetBrains IDE
/Applications/或~/Applications/ - ✅ 确保
inspect.sh文件是可执行的 - ✅ 使用
FORCE_INSPECT_PATH用于指定确切路径的环境变量
⚠️ “未找到检查配置文件”
[!小心] 没有检查配置文件,该工具无法正确分析您的代码。
修复步骤:
- 在JetBrains IDE中打开项目
- 首选 设置 → 检查
- 配置并保存检查配置文件
- 或者,使用
FORCE_PROFILE_PATH指定自定义配置文件
⏱️ 超时问题
[!提示] 默认超时为120秒。大型项目可能需要更多时间。
解决:
- 🔄 增加超时时间:设置
INSPECTION_TIMEOUT=300000(5分钟) - 📊 检查IDE当前是否没有索引
- 📦 对于非常大的项目,考虑检查特定的目录
🚫 “一次只能运行一个实例”
[!注意] ✅ 这已经不是问题了! 服务器通过使用隔离的配置目录自动处理此问题,即使IDE已经打开,也允许检查运行。
📚 文档
[!提示] 🌐 请访问我们的综合文档 josedacosta.github.io/mcp-jetbrains代码检查
可用部分:
| 第节 | 说明 |
|---|---|
| 🏁 入门指南 | 安装和先决条件 |
| ⚙️ 配置 | 环境变量和配置文件 |
| 📖 使用指南 | 基本和高级用法 |
| 🔬 技术细节 | 架构和IDE检测 |
| 💡 指南 | 最佳实践和故障排除 |
📖 JetBrains文档
[!提示] 了解有关JetBrains代码检查和命令行检查器的更多信息:
| 资源 | 描述 |
|---|---|
| 📘 代码检查概述 | 了解代码检查、严重性级别和检查配置文件 |
| 🔧 命令行代码检查器 | 使用inspect.sh/inspect.bat工具的详细文档 |
🤝 贡献
[!注意] 我们欢迎捐款!请查看我们的 贡献指南 了解全部细节。
我们正在寻找的内容:
- 🐛 Bug修复和问题报告
- ✨ 新功能和增强功能
- 📝 文档改进
- 🧪 测试覆盖范围扩展
- 🌍 语言/IDE支持
🚀 贡献者快速入门
[!重要] 我们跟随 常规承诺 并使用GitHub Flow。
# 1. Fork and clone the repository
git clone https://github.com/YOUR-USERNAME/mcp-jetbrains-code-inspections.git
# 2. Create a feature branch
git checkout -b feat/amazing-feature
# 3. Make your changes and commit
git commit -m 'feat(scope): add amazing feature'
# 4. Push to your fork
git push origin feat/amazing-feature
# 5. Open a Pull Request
[!提示] 看 贡献.md 用于分支命名、提交消息标准和PR指南。
🏷️ 关键词
🔍 SEO Keywords (click to expand)
MCP和AI集成:
MCP server • Model Context Protocol • Claude Code integration • MCP JetBrains • Claude AI code inspection • MCP tools • Claude Code extensions • MCP inspector • Anthropic MCP • Claude.ai code analysis • LLM code analysis • AI code review
JetBrains集成开发环境:
JetBrains code inspection • WebStorm MCP • IntelliJ IDEA MCP integration • PyCharm MCP server • PhpStorm code inspection • GoLand analysis • Rider code quality • CLion inspection • RubyMine linter • DataGrip SQL analysis • Android Studio inspection • RustRover analysis
技术条款:
JetBrains command line inspector • inspect.sh • automated code inspection • JetBrains unified profile • IDE code diagnostics • static code analysis • inspection severity levels • inspection profiles • Node.js MCP server • MCP environment variables • code problems detection
由以下材料制成❤️ Runtima团队
