easy-mcp-github-tools-python

Easy MCP GitHub Tools Application

This is a set of tools for github to be used with easy mcp server.
https://github.com/ground-creative/easy-mcp-python

Key Features

• Branch Management: Easily create and delete branches in your GitHub repositories.
• Issue Tracking: Create, update, and delete issues, as well as manage comments on issues.
• Commit History: Fetch detailed commit information and commit history for any branch in your repository.
• File Management: Create, update, and delete files within your GitHub repositories, including fetching file contents and differences.
• Pull Requests: Create and manage pull requests, including merging them into target branches.
• Global Search: Perform global searches across GitHub for repositories, issues, and code.
• Release Management: Retrieve and manage releases within your GitHub repositories.
• OAuth Authentication: Securely authenticate users using GitHub's OAuth service.

Authentication

This application uses GitHub oAuth service to authenticate the user.
To use this app, you must create an OAuth application on GitHub.

How To Authenticate:

1. Go to auth/login and authenticate

2. Use the paramater X-ACCESS-TOKEN with the request headers when making calls to the server.

Create GitHub Application Instructions

To use this app, you must first create an OAuth application on GitHub. Follow these steps:

1. Go to your GitHub account settings.
2. Navigate to Developer settings > OAuth Apps.
3. Click on New OAuth App.
4. Fill in the required fields:
   • Application Name: Choose a name for your application.
   • Homepage URL: Enter the main URL of your application (ex: https://mcp.yourdomain.com).
   • Authorization callback URL: Set this to http://{Your Host}:{Your Port}/auth/callback.
5. After creating the application, you will receive a Client ID and Client Secret. Keep these credentials safe, as you will need them to add them to the client_credentials.json file.

Installation

1. Clone the repository from the root folder of the easy mcp installation:

git clone https://github.com/ground-creative/easy-mcp-github-tools-python.git app

2. Install requirements:

pip install -r app/requirements.txt

3. Generate encryption key:

python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"

4. Add parameters to env file:

APP_HOST=Application Host ex: `https://mcp.yourdomain.com`
DB_PATH=storage/sqlite_credentials.db
CYPHER=Your Encryption Key Here

# Optional
SITE_URL=Main Application Site URL
SITE_NAME=MAin Application Site Name

5. Create json file client_credentials.json with GitHub oauth credentials in storage folder:

# Follow instructions of section "Create GitHub Application instructions" to create credentials

{
    "client_id": "XXXXX",
    "client_secret": "XXXXXXX"
}

6. Run the server:

# Run via fastapi wrapper
python3 run.py -s fastapi

Available MCP Tools

The following tools are provided by this MCP server:

Server Info Page

The server info page with the tools specs URL is the {APP_HOST} parameter configured in the .env file.

Screenshots

Server info page:

GitHub application oAuth page

User authenticated page