@lxptools/mcpal/README.md

MCPal is a Model Context Protocol (MCP) server designed to enhance developer productivity by providing a suite of tools for common development tasks.

# MCPal

MCPal is a Model Context Protocol (MCP) server designed to enhance developer productivity by providing a suite of tools for common development tasks. 



## ✨ Features
| ✨ Feature                              | Description                                                                                           |
|----------------------------------------|-------------------------------------------------------------------------------------------------------|
| **Hi MCPal**                           | A simple tool to greet the user.                                                                      |
| **PR Title and Description Generator** | Generates pull request titles and descriptions based on recent commit changes.                        |
| **Local Code Review**                  | Analyzes staged Git diffs to identify code quality issues and suggest improvements.                   |
| **Remote PR Review**                   | Assists in reviewing remote pull requests by fetching PR details and providing review assistance.     |
| **Cherry-Pick PR Creator**             | Creates cherry-pick pull requests from existing PRs.                                                  |




## ⚙️ Configuration

### For Cursor

Add the MCPal MCP server configuration:

```json
{
  "mcpServers": {
    "mcpal": {
      "command": "npx",
      "args": ["-y", "@lxptools/mcpal"],
      "env": {
        "BITBUCKET_USER": "{{BB username}}",
        "BITBUCKET_TOKEN": "{{BB token}}",
      },
    }
  }
}
```

### For Claude Desktop

Add the MCPal MCP server configuration:

```json
{
  "mcpServers": {
    "mcpal": {
      "command": "npx",
      "args": ["-y", "@lxptools/mcpal"],
      "env": {
        "BITBUCKET_USER": "{{BB username}}",
        "BITBUCKET_TOKEN": "{{BB token}}",
      },
    }
  }
}
```

## 📋 Usage Examples

Once the server is running, you can use the tools with your LLM tool. Here are some example prompts:

*   "Hi MCPal"
*   "Generate a PR title and description for the latest commit in the repository at `/path/to/your/repo`"
*   "Review the staged code changes in the repository at `/path/to/your/repo`"
*   "Review the pull request at `{{remote-bb-pr}}`"
*   "Create a cherry-pick PR for `{{master-pr-url}}` into `{{target-release-branch}}`"

## 📚 Available Tools

### `hi_mcp_pal`

A simple tool to greet the user.

**Parameters:**

*   None

### `pr title and desc`

Helps generate PR title and description based on the recent commit changes.

**Parameters:**

*   `repopath` (string, required): Path to the repository for which the latest commit is to be fetched and generate pr title and description.

### `code_review`

Analyzes staged Git diffs to identify code quality issues and suggest improvements.

**Parameters:**

*   `repopath` (string, required): Path of the git repository.
*   `prompt` (string, optional): Custom prompt for code review, defaults to a predefined template.

### `remote_pr_review`

Helps with reviewing remote pull requests by fetching PR details and providing review assistance.

**Parameters:**

*   `pull_request_url` (string, required): URL of the pull request to review.
*   `user_prompt` (string, optional): Custom prompt for the review, defaults to a predefined template.

### `raise_cp`

Create a cherry-pick pull request from an existing PR.

**Parameters:**

*   `pull_request_url` (string, required): URL of the pull request to cherry-pick.
*   `target_branch` (string, required): Target branch to cherry-pick into, e.g., "{{release-}}".