Skip to content

Commit b06df1d

Browse files
committed
fix: resolve CI/CD errors - TypeScript types and ESLint formatting
1 parent 2c42255 commit b06df1d

File tree

8 files changed

+221
-205
lines changed

8 files changed

+221
-205
lines changed

README.md

Lines changed: 54 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -13,37 +13,37 @@
1313
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://makeapullrequest.com)
1414

1515
> [!CAUTION]
16+
>
1617
> ## ⚠️ Deprecated Notice
17-
>
18+
>
1819
> [![Status: Deprecated](https://img.shields.io/badge/Status-Deprecated-red.svg)](https://github.com/josedacosta/mcp-jetbrains-code-inspections#deprecated-notice)
19-
>
20+
>
2021
> **This project is deprecated but still functional.** Starting from version 2025.2, JetBrains IDEs (WebStorm, IntelliJ IDEA, PyCharm, etc.) now include a built-in MCP server that provides native integration with external clients like Claude Desktop, Cursor, VS Code, and others.
21-
>
22+
>
2223
> ### 🔄 Migration Options
23-
>
24-
> | IDE Version | Recommended Solution | Link |
25-
> |------------|---------------------|------|
26-
> | **2025.2+** | Built-in MCP server | [Official Documentation](https://www.jetbrains.com/help/webstorm/mcp-server.html) |
27-
> | **Earlier versions** | JetBrains MCP plugin | [Plugin Marketplace](https://plugins.jetbrains.com/plugin/26071-mcp-server) |
28-
>
24+
>
25+
> | IDE Version | Recommended Solution | Link |
26+
> | -------------------- | -------------------- | --------------------------------------------------------------------------------- |
27+
> | **2025.2+** | Built-in MCP server | [Official Documentation](https://www.jetbrains.com/help/webstorm/mcp-server.html) |
28+
> | **Earlier versions** | JetBrains MCP plugin | [Plugin Marketplace](https://plugins.jetbrains.com/plugin/26071-mcp-server) |
29+
>
2930
> ### ✅ Native Integration Benefits
30-
>
31+
>
3132
> - **Direct IDE control** without external tools
3233
> - **25+ tools** comprehensive tool set
3334
> - **Better performance** and reliability
3435
> - **Official support** from JetBrains
35-
>
36+
>
3637
> > [!IMPORTANT]
3738
> > The native `get_file_problems` tool requires setting `errorsOnly: false` for similar functionality to this project. The `get_project_problems` tool only returns critical errors.
38-
>
39+
>
3940
> 📚 **[View Migration Guide & Comparison →](https://josedacosta.github.io/mcp-jetbrains-code-inspections/deprecated/jetbrains-native-mcp)**
4041
4142
A **Model Context Protocol (MCP)** server that provides JetBrains IDE code inspections with automatic IDE selection and a unified inspection profile that works across all file types.
4243

4344
> [!TIP]
4445
> 📚 **Full Documentation Available**: Visit our comprehensive docs at [josedacosta.github.io/mcp-jetbrains-code-inspections](https://josedacosta.github.io/mcp-jetbrains-code-inspections/)
4546
46-
4747
## 🎯 Quick Start
4848

4949
> [!NOTE]
@@ -63,7 +63,6 @@ yarn inspect
6363

6464
Then configure your MCP client (Claude Desktop, Cursor, etc.) with the [configuration below](#️-configuration).
6565

66-
6766
## ✨ Features
6867

6968
<table>
@@ -74,10 +73,8 @@ Then configure your MCP client (Claude Desktop, Cursor, etc.) with the [configur
7473

7574
- 🔍 **Automatic IDE Detection**
7675
<br>Intelligently selects the best JetBrains IDE
77-
7876
-**Configurable Timeout**
7977
<br>Default 120s, adjustable for large projects
80-
8178
- 🔄 **Cross-IDE Compatible**
8279
<br>Works with all JetBrains IDEs
8380

@@ -88,24 +85,19 @@ Then configure your MCP client (Claude Desktop, Cursor, etc.) with the [configur
8885

8986
- 📊 **Smart Output Formats**
9087
<br>Markdown for LLMs, JSON for tools
91-
9288
- 🎯 **Concurrent Execution**
9389
<br>Run even when IDE is open
94-
9590
- 🌐 **Universal Profiles**
9691
<br>One profile for all languages
97-
9892
- 💬 **Built-in Prompts**
9993
<br>Pre-configured prompts for common tasks
100-
10194
- 📚 **Server Resources**
10295
<br>Access profiles, config, and IDE info
10396

10497
</td>
10598
</tr>
10699
</table>
107100

108-
109101
## 📦 Installation
110102

111103
> [!NOTE]
@@ -114,36 +106,40 @@ Then configure your MCP client (Claude Desktop, Cursor, etc.) with the [configur
114106
### Step-by-step Installation
115107

116108
1. **Install dependencies**:
117-
```bash
118-
yarn install
119-
```
109+
110+
```bash
111+
yarn install
112+
```
120113

121114
2. **Build the server**:
122-
```bash
123-
yarn build
124-
```
115+
116+
```bash
117+
yarn build
118+
```
125119

126120
3. **Configure MCP** (see [⚙️ Configuration](#️-configuration) section below)
127121

128122
> [!TIP]
129123
> Use `yarn inspect` after installation to test the server with the MCP Inspector
130124

131-
132125
## 🚀 Usage
133126

134127
### 📚 MCP Features
135128

136129
The server provides three types of MCP features:
137130

138131
#### 🔨 Tools
132+
139133
- **get_jetbrains_code_inspections**: Runs code inspections on specified files or directories
140134

141135
#### 💬 Prompts
136+
142137
- **analyze-project**: Analyze a project for code quality issues
143138
- **check-file**: Check a specific file for issues
144139
- **fix-issues**: Get suggestions to fix detected issues
145140

146141
#### 📚 Resources
142+
147143
- **inspection://profiles**: List of available inspection profiles
148144
- **inspection://config**: Current MCP server configuration
149145
- **inspection://ides**: List of detected JetBrains IDEs on the system
@@ -189,9 +185,9 @@ The code inspections server can be configured through environment variables in `
189185
> [!IMPORTANT]
190186
> The tool accepts only one parameter from the LLM:
191187

192-
| Parameter | Type | Description | Required | Example |
193-
| --------- | ------ | --------------------------------- | -------- | ------- |
194-
| `path` | `string` | File or directory path to inspect | ✅ Yes | `"src/index.ts"` or `"./src"` |
188+
| Parameter | Type | Description | Required | Example |
189+
| --------- | -------- | --------------------------------- | -------- | ----------------------------- |
190+
| `path` | `string` | File or directory path to inspect | ✅ Yes | `"src/index.ts"` or `"./src"` |
195191

196192
#### 🌍 Configuration via Environment Variables
197193

@@ -201,23 +197,22 @@ The code inspections server can be configured through environment variables in `
201197
<details>
202198
<summary><b>📑 Available Environment Variables</b> (click to expand)</summary>
203199

204-
| Environment Variable | Type | Description | Default |
205-
| --------------------- | ------------------ | --------------------------------------------------------- | ----------------------- |
206-
| `FORCE_INSPECT_PATH` | `string` | Force specific IDE inspect tool (disables auto-detection) | Auto-detected |
207-
| `FORCE_PROJECT_ROOT` | `string` | Force project root directory (disables auto-detection) | Auto-detected |
208-
| `FORCE_PROFILE_PATH` | `string` | Force inspection profile path (disables defaults) | Project defaults |
209-
| `INSPECTION_TIMEOUT` | `number` | Maximum analysis time (ms) | `120000` |
210-
| `EXCLUDE_INSPECTIONS` | `string` | Comma-separated inspection codes to exclude | `SpellCheckingInspection` |
211-
| `ONLY_INSPECTIONS` | `string` | Only include these inspection codes | - |
212-
| `RESPONSE_FORMAT` | `'markdown'\|'json'` | Output format for diagnostics | `'markdown'` |
213-
| `DEBUG` | `boolean` | Enable debug logging | `false` |
200+
| Environment Variable | Type | Description | Default |
201+
| --------------------- | -------------------- | --------------------------------------------------------- | ------------------------- |
202+
| `FORCE_INSPECT_PATH` | `string` | Force specific IDE inspect tool (disables auto-detection) | Auto-detected |
203+
| `FORCE_PROJECT_ROOT` | `string` | Force project root directory (disables auto-detection) | Auto-detected |
204+
| `FORCE_PROFILE_PATH` | `string` | Force inspection profile path (disables defaults) | Project defaults |
205+
| `INSPECTION_TIMEOUT` | `number` | Maximum analysis time (ms) | `120000` |
206+
| `EXCLUDE_INSPECTIONS` | `string` | Comma-separated inspection codes to exclude | `SpellCheckingInspection` |
207+
| `ONLY_INSPECTIONS` | `string` | Only include these inspection codes | - |
208+
| `RESPONSE_FORMAT` | `'markdown'\|'json'` | Output format for diagnostics | `'markdown'` |
209+
| `DEBUG` | `boolean` | Enable debug logging | `false` |
214210

215211
</details>
216212

217213
> [!TIP]
218214
> 📚 For detailed configuration options, see [Configuration Documentation](docs/configuration/).
219215

220-
221216
## 🧪 Testing
222217

223218
### 1️⃣ Interactive MCP Test
@@ -246,7 +241,6 @@ The inspector opens a web interface where you can:
246241
- Access server resources (profiles, config, detected IDEs)
247242
- See requests/responses in real-time
248243

249-
250244
## ⚙️ How It Works
251245

252246
### 🎯 Automatic IDE Selection
@@ -277,6 +271,7 @@ The inspector opens a web interface where you can:
277271
> **Key Innovation**: The server uses temporary isolated configuration directories with `-Didea.config.path` and `-Didea.system.path` JVM properties. This allows inspections to run even when the IDE is already open!
278272

279273
**Benefits:**
274+
280275
- ✅ No IDE conflicts
281276
- ✅ Parallel execution support
282277
- ✅ Clean, isolated analysis
@@ -294,7 +289,7 @@ The inspector opens a web interface where you can:
294289
✅ WebStorm - Found and selected!
295290
Path: /Applications/WebStorm.app/Contents/bin/inspect.sh
296291
Note: Using isolated configuration - works even if IDE is already running
297-
292+
298293
📊 Analysis Results:
299294
⚠️ Warning: Unused variable 'config' at line 42
300295
❌ Error: Missing semicolon at line 156
@@ -303,7 +298,6 @@ The inspector opens a web interface where you can:
303298
304299
</details>
305300
306-
307301
## 🛠️ Troubleshooting
308302
309303
### ❌ "JetBrains IDE inspect tool not found"
@@ -312,6 +306,7 @@ The inspector opens a web interface where you can:
312306
> This error occurs when no JetBrains IDE can be found in standard installation locations.
313307
314308
**Solutions:**
309+
315310
- ✅ Verify that a JetBrains IDE is installed in `/Applications/` or `~/Applications/`
316311
- ✅ Ensure the `inspect.sh` file is executable
317312
- ✅ Use `FORCE_INSPECT_PATH` environment variable to specify the exact path
@@ -322,6 +317,7 @@ The inspector opens a web interface where you can:
322317
> Without an inspection profile, the tool cannot analyze your code properly.
323318
324319
**Steps to fix:**
320+
325321
1. Open the project in a JetBrains IDE
326322
2. Go to **Settings****Inspections**
327323
3. Configure and save an inspection profile
@@ -333,6 +329,7 @@ The inspector opens a web interface where you can:
333329
> Default timeout is 120 seconds. Large projects may need more time.
334330
335331
**Solutions:**
332+
336333
- 🔄 Increase timeout: Set `INSPECTION_TIMEOUT=300000` (5 minutes)
337334
- 📊 Check that the IDE is not currently indexing
338335
- 📦 For very large projects, consider inspecting specific directories
@@ -342,40 +339,38 @@ The inspector opens a web interface where you can:
342339
> [!NOTE]
343340
>**This is no longer an issue!** The server automatically handles this by using isolated configuration directories, allowing inspections to run even when the IDE is already open.
344341
345-
346342
## 📚 Documentation
347343
348344
> [!TIP]
349345
> 🌐 Visit our comprehensive documentation at [josedacosta.github.io/mcp-jetbrains-code-inspections](https://josedacosta.github.io/mcp-jetbrains-code-inspections/)
350346
351347
**Available sections:**
352348
353-
| Section | Description |
354-
|---------|-------------|
355-
| 🏁 **[Getting Started](https://josedacosta.github.io/mcp-jetbrains-code-inspections/getting-started/)** | Installation and prerequisites |
356-
| ⚙️ **[Configuration](https://josedacosta.github.io/mcp-jetbrains-code-inspections/configuration/)** | Environment variables and profiles |
357-
| 📖 **[Usage Guide](https://josedacosta.github.io/mcp-jetbrains-code-inspections/usage/)** | Basic and advanced usage |
358-
| 🔬 **[Technical Details](https://josedacosta.github.io/mcp-jetbrains-code-inspections/technical/)** | Architecture and IDE detection |
359-
| 💡 **[Guides](https://josedacosta.github.io/mcp-jetbrains-code-inspections/guides/)** | Best practices and troubleshooting |
360-
349+
| Section | Description |
350+
| ------------------------------------------------------------------------------------------------------- | ---------------------------------- |
351+
| 🏁 **[Getting Started](https://josedacosta.github.io/mcp-jetbrains-code-inspections/getting-started/)** | Installation and prerequisites |
352+
| ⚙️ **[Configuration](https://josedacosta.github.io/mcp-jetbrains-code-inspections/configuration/)** | Environment variables and profiles |
353+
| 📖 **[Usage Guide](https://josedacosta.github.io/mcp-jetbrains-code-inspections/usage/)** | Basic and advanced usage |
354+
| 🔬 **[Technical Details](https://josedacosta.github.io/mcp-jetbrains-code-inspections/technical/)** | Architecture and IDE detection |
355+
| 💡 **[Guides](https://josedacosta.github.io/mcp-jetbrains-code-inspections/guides/)** | Best practices and troubleshooting |
361356
362357
## 📖 JetBrains Documentation
363358
364359
> [!TIP]
365360
> Learn more about JetBrains code inspections and the command-line inspector:
366361
367-
| Resource | Description |
368-
|----------|-------------|
369-
| 📘 **[Code Inspection Overview](https://www.jetbrains.com/help/webstorm/code-inspection.html)** | Learn about code inspections, severity levels, and inspection profiles |
370-
| 🔧 **[Command-Line Code Inspector](https://www.jetbrains.com/help/webstorm/command-line-code-inspector.html)** | Detailed documentation on using the inspect.sh/inspect.bat tool |
371-
362+
| Resource | Description |
363+
| -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
364+
| 📘 **[Code Inspection Overview](https://www.jetbrains.com/help/webstorm/code-inspection.html)** | Learn about code inspections, severity levels, and inspection profiles |
365+
| 🔧 **[Command-Line Code Inspector](https://www.jetbrains.com/help/webstorm/command-line-code-inspector.html)** | Detailed documentation on using the inspect.sh/inspect.bat tool |
372366
373367
## 🤝 Contributing
374368
375369
> [!NOTE]
376370
> We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for full details.
377371
378372
**What we're looking for:**
373+
379374
- 🐛 Bug fixes and issue reports
380375
- ✨ New features and enhancements
381376
- 📝 Documentation improvements
@@ -406,7 +401,6 @@ git push origin feat/amazing-feature
406401
> [!TIP]
407402
> See [CONTRIBUTING.md](CONTRIBUTING.md) for branch naming, commit message standards, and PR guidelines.
408403
409-
410404
## 🏷️ Keywords
411405
412406
<details>

docs/deprecated/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ You might still need this project if:
3535

3636
## Support
3737

38-
This project will continue to work but is no longer actively developed. For new features and improvements, please use the native JetBrains MCP integration.
38+
This project will continue to work but is no longer actively developed. For new features and improvements, please use the native JetBrains MCP integration.

0 commit comments

Comments
 (0)