Cline Github MCP

🚀 GitHub PR Bot Server (GitHub PR-MCP)

The GitHub PR Bot Server (GitHub PR-MCP) is a powerful tool that simplifies the process of creating and managing pull requests on GitHub. It streamlines the workflow, enhances efficiency, and provides a seamless experience for developers.

🚀 Quick Start

📦 Installation

Quick Installation

npm install github-pr-mcp

Build the Project

1. Clone the repository:

   git clone https://github.com/your-username/github-pr-mcp.git
   cd github-pr-mcp
   

2. Install dependencies:

   npm install
   

3. Start the development server:

   npm run dev
   

💻 Usage Examples

Initialize the Configuration File

github-pr-mcp init

Run the Server

npm start

General Configuration

Environment Variables

Set the following environment variables to customize the behavior:

• GITHUB_TOKEN: Required. A GitHub personal access token for authentication.
• PORT: Optional. Defaults to 3000. Specifies the port on which the server runs.

Integrate GitHub PR Features

Create a Pull Request

const server = new GithubPRServer();
server.createPullRequest({
  owner: 'your-org',
  repo: 'your-repo',
  title: '新功能实现',
  head: 'feature-branch',
  base: 'main',
  // Other optional parameters...
});

📚 Documentation

Development

Directory Structure

src/
├── index.ts          # Main MCP server implementation
├── api/             # API routes and middleware
├── config/          # Configuration files
└── types/           # TypeScript type definitions

Add New Features

1. Define types in src/types/index.ts.
2. Update the main server implementation and add new features in src/index.ts.
3. Add new tool handlers in the GitHubServer class.
4. Update the documentation.

Development Environment Configuration

Prerequisites

• Node.js 18+
• npm or yarn
• Git
• A GitHub account with a personal access token

Local Development

1. Install dependencies:

   npm install
   

2. Start the development server:

   npm run dev
   

3. Run tests:

   npm test
   

Testing

• Unit tests: npm run test:unit
• Integration tests: npm run test:integration
• Test coverage: npm run test:coverage

Troubleshooting

Common Issues

1. Authentication Error

   • Confirm that the token has the required permissions.
   • Check if the token is correctly set in the environment.
   • Check the token's expiration date.

2. Build Issues

   • Clear the build directory: rm -rf build/
   • Reinstall dependencies: npm install

3. Server Startup Failure

   • Confirm that the port is not occupied.
   • Check if the environment variables are correctly set.

Contribution Guidelines

Submit Code

Follow the guidelines in the CONTRIBUTING.md file to contribute.

Create a Pull Request

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes and create a pull request to the main branch.

📄 License

This project is open-source under the LICENSE.

📞 Contact

If you have any questions or suggestions, please contact your.email@example.com.