Skip to main content

Guides

Practical guides and tutorials for common tasks and advanced usage of MCP JetBrains Code Inspections.

Available Guides​

Multi-IDE Usage​

Learn how to use the server across different JetBrains IDEs:

  • Automatic IDE detection
  • IDE priority system
  • Language-specific configurations
  • Switching between IDEs

Troubleshooting​

Solutions for common issues:

  • Timeout problems
  • IDE not found errors
  • Profile configuration issues
  • Performance optimization

Testing​

How to test your setup and verify functionality:

  • MCP Inspector usage
  • Manual testing methods
  • Debugging techniques
  • Validation approaches

Best Practices​

Proven patterns for production use:

  • Performance optimization
  • Configuration management
  • Error handling strategies
  • Team workflows

Quick Tips​

Performance Optimization​

// For large projects, increase timeout
{
  "env": {
    "INSPECTION_TIMEOUT": "600000" // 10 minutes
  }
}

IDE Selection​

# Force specific IDE
export FORCE_INSPECT_PATH="/Applications/IntelliJ.app/Contents/bin/inspect.sh"

Debug Mode​

// Enable debug logging via environment variable
{
  "env": {
    "DEBUG": "true"
  }
}

// Call the tool
await get_jetbrains_code_inspections({
  path: '/path/to/file'
});

Common Scenarios​

Testing the MCP Server​

Quick ways to test the server:

# Using MCP Inspector
yarn inspect

# Using the interactive test script
yarn test:mcp

# Direct testing
npx @modelcontextprotocol/inspector node dist/index.js

Analyzing a Full Project​

// Analyze entire project directory
await get_jetbrains_code_inspections({
    path: '/path/to/project',
});

// Analyze specific file
await get_jetbrains_code_inspections({
    path: '/path/to/project/src/file.ts',
});

CI/CD Integration​

Using inspections in continuous integration:

# Set timeout for large projects
export INSPECTION_TIMEOUT=600000  # 10 minutes

# Force specific IDE path
export FORCE_INSPECT_PATH="/usr/local/idea/bin/inspect.sh"

# Run inspection
node dist/index.js

Contributing Guides​

Have a useful guide or workflow? Consider contributing:

  1. Fork the repository
  2. Add your guide to this section
  3. Submit a pull request

Need Help?​