Skip to main content
Glama
README.md
# ohm-mcp (npm package)

**NPX wrapper for the OHM MCP Python refactoring server**

This package provides a convenient way to run the OHM MCP (Model Context Protocol) server using `npx`. The server offers comprehensive Python code refactoring capabilities including AST-based analysis, automated refactoring, performance optimization, and more.

## Installation

### Option 1: Published Package (when available on npm)
```bash
# Install globally (optional)
npm install -g ohm-mcp

# Or use directly with npx (recommended)
npx ohm-mcp@latest
```

### Option 2: Local Development
If you're developing locally or the package isn't published yet:
```bash
# Use the local package directory
npx --package /path/to/ohm-mcp-npm ohm-mcp

# Example with absolute path
npx --package /Users/username/projects/ohm-mcp-npm ohm-mcp
```

## Usage

### With Cline (VS Code Extension)

Add to your Cline MCP settings:

```json
{
  "mcpServers": {
    "ohm-mcp": {
      "command": "npx",
      "args": ["ohm-mcp@latest"]
    }
  }
}
```

### With Cursor IDE

Add to your MCP configuration:

```json
{
  "mcpServers": {
    "ohm-mcp": {
      "command": "npx",
      "args": ["ohm-mcp@latest"]
    }
  }
}
```

### Direct Command Line Usage

```bash
# Run the MCP server directly
npx ohm-mcp@latest

# Or if installed globally
ohm-mcp
```

## What It Does

This package automatically:

1. **Finds Python**: Locates a Python 3.8+ interpreter on your system
2. **Installs Dependencies**: Downloads and installs the OHM MCP Python package if needed
3. **Launches Server**: Starts the MCP server with stdio communication

## Requirements

- **Node.js**: 18+ (for npx)
- **Python**: 3.8+ (auto-detected)
- **Internet Connection**: Required for initial package download

## Troubleshooting

### "Python interpreter not found"
- Ensure Python 3.8+ is installed and in your PATH
- Try: `python --version` or `python3 --version`

### "Failed to install OHM MCP Python package"
- Ensure pip is available: `python -m pip --version`
- Check internet connection
- Try manual installation: `pip install ohm-mcp`

### Server won't start
- Check that port 3000+ isn't blocked (if using alternative configs)
- Ensure no firewall blocks Python execution

## Development

To modify this wrapper:

```bash
cd ohm-mcp-npm
npm install
npm run build  # if needed
npm test
```

## Publishing

```bash
cd ohm-mcp-npm
npm version patch  # or minor/major
npm publish
```

## Related Packages

- **ohm-mcp** (Python): The actual MCP server implementation
- **ohm-mcp-cli** (Python): Command-line interface for the server

## License

MIT - Same as the Python OHM MCP package

---

**Made with ❤️ for better code quality**