# JYMP MCP Server
<img src="https://raw.githubusercontent.com/mahendra189/jymp/refs/heads/main/assets/logo.png" alt="JYMP Logo" width="80" height="80" />
<img src="https://i.pinimg.com/736x/fa/83/b8/fa83b8de8ff5a8e2dc98c6f7e249c842.jpg" alt="JYMP Logo" width="80" height="80" />



> 🔗 **MCP server that combines your codebase files into a single prompt for AI assistants**

Turn any directory into an AI-ready codebase prompt. Works with Perplexity, Claude Desktop, and any MCP-compatible client.

[![npm version](https://img.shields.io/npm/v/@mahendra189/j
[![License: MIT](https://***

## 📦 Installation

```bash
npm install -g @mahendra189/jymp-mcp-server
```

**Find the installation path:**

```bash
which jymp-mcp-server
```

Copy this path - you'll need it for the setup below.

Example output:
- macOS (NVM): `/Users/yourusername/.nvm/versions/node/v22.10.0/bin/jymp-mcp-server`
- macOS (Homebrew): `/opt/homebrew/bin/jymp-mcp-server`
- Windows: `C:\Users\yourusername\AppData\Roaming\npm\jymp-mcp-server.cmd`

***

## 🚀 Setup for Perplexity (Mac)

1. Open **Perplexity Mac App**
2. Go to **Settings → Connectors**
3. Install **PerplexityXPC helper** (if not already installed)
4. Click **"Add Connector"**
5. Enter:

**Server Name:**
```
JYMP Codebase Tool
```

**Command:** (use YOUR path from `which jymp-mcp-server`)
```
/Users/yourusername/.nvm/versions/node/v22.10.0/bin/jymp-mcp-server
```

6. Click **Save**
7. Wait for status to show **"Running"** (green)

### Usage

1. Go to Perplexity homepage
2. Under **"Sources"** at the bottom, toggle **JYMP** ON
3. Try these prompts:

```
List all files in /Users/yourusername/my-project

Create a codebase prompt for /Users/yourusername/my-project

Combine these files: src/index.ts, src/utils.ts from /Users/yourusername/my-project
```

***

## 🖥️ Setup for Claude Desktop

### macOS

1. Find your installation path:
```bash
which jymp-mcp-server
```

2. Open config file:
```bash
nano ~/Library/Application\ Support/Claude/claude_desktop_config.json
```

3. Add (replace with YOUR path from step 1):

```json
{
  "mcpServers": {
    "jymp": {
      "command": "/Users/yourusername/.nvm/versions/node/v22.10.0/bin/jymp-mcp-server"
    }
  }
}
```

4. **Completely quit and restart Claude Desktop**

5. Look for the **🔨 hammer icon** to verify connection

### Windows

1. Find your installation path:
```cmd
where jymp-mcp-server
```

2. Open config file:
```
notepad %APPDATA%\Claude\claude_desktop_config.json
```

3. Add (use double backslashes):

```json
{
  "mcpServers": {
    "jymp": {
      "command": "C:\\Users\\yourusername\\AppData\\Roaming\\npm\\jymp-mcp-server.cmd"
    }
  }
}
```

4. Restart Claude Desktop

***

## 📚 Available Tools

### 1. `get_codebase_files`
Lists all files in a directory (respects `.jympignore`)

**Example:**
```
"List all files in /Users/me/my-app"
```

### 2. `create_codebase_prompt`
Combines all files into a single LLM prompt

**Example:**
```
"Create a codebase prompt for /Users/me/my-app with basic compression"
```

**Parameters:**
- `directory`: Path to your project
- `compression`: `none` or `basic` (optional)

### 3. `create_prompt_from_files`
Combines specific files into a prompt

**Example:**
```
"Combine src/index.ts and src/utils.ts from /Users/me/my-app"
```

**Parameters:**
- `directory`: Base directory path
- `files`: Array of file paths
- `compression`: `none` or `basic` (optional)

***

## ⚙️ Configuration

### Exclude Files with .jympignore

Create a `.jympignore` file in your project root:

```
node_modules
.git
dist
build
.env
*.log
.DS_Store
coverage/
```

The server automatically respects these exclusions.

### Compression Modes

- **`none`** (default): Full file contents
- **`basic`**: Removes comments, blank lines, and compresses whitespace

***

## 🔧 Troubleshooting

### "command not found: jymp-mcp-server" after installation

**Problem:** npm global bin directory not in PATH

**Solution:**

```bash
# Add npm global bin to your PATH
echo 'export PATH="$(npm bin -g):$PATH"' >> ~/.zshrc
source ~/.zshrc

# Then reinstall
npm install -g @mahendra189/jymp-mcp-server

# Find the path
which jymp-mcp-server
```

***

### "Server not running" in Perplexity

**Solutions:**

1. Make sure you used the **full path** from `which jymp-mcp-server`
2. Test the command in Terminal first:
```bash
/your/full/path/to/jymp-mcp-server
```
3. Try removing and re-adding the connector
4. Double-check you copied the path correctly (no typos)

***

### "Could not connect" in Claude Desktop

**Solutions:**

1. **Completely quit** Claude Desktop (Cmd+Q, not just close window)
2. Verify you used the correct full path from `which jymp-mcp-server`
3. Test in Terminal first to ensure it works
4. Check for typos in the config file
5. Make sure the JSON syntax is correct (commas, quotes, etc.)

***

### Permission Errors on macOS

Claude may need disk access permissions:

1. Go to **System Settings → Privacy & Security → Files and Folders**
2. Grant Claude access to the directories you want to scan

***

### Still Having Issues?

Run these diagnostic commands:

```bash
# Check Node.js is installed
node --version

# Check npm is working
npm --version

# List global packages
npm list -g --depth=0

# Find jymp-mcp-server path
which jymp-mcp-server

# Test it directly
$(which jymp-mcp-server)
```

If the last command works, then use that exact path in Perplexity/Claude config.

***

## 📖 Example Use Cases

### Code Review
```
"Create a codebase prompt for /Users/me/pull-request-branch"
```
Get all changed files in one prompt to review with AI

### Documentation
```
"List all files in /Users/me/project/docs"
```
See your documentation structure

### Debugging
```
"Combine src/bug.ts and tests/bug.test.ts from /Users/me/project"
```
Get relevant code for debugging with AI

### Onboarding
```
"Create a codebase prompt for /Users/me/new-project with basic compression"
```
Get a compressed overview of a new codebase

***

## 🗑️ Uninstall

```bash
npm uninstall -g @mahendra189/jymp-mcp-server
```

***

## 🐛 Report Issues

Found a bug? Have a feature request?

GitHub: https://github.com/mahendra189/jymp-mcp-server/issues

---

## 📄 License

MIT © Mahendra Kumar

---

## 🔗 Related Projects

- [JYMP CLI](https://github.com/mahendra189/jymp) - The original JYMP tool with interactive UI
- [MCP Documentation](https://modelcontextprotocol.io) - Learn more about Model Context Protocol

***

**Made with ❤️ by Mahendrakumar**