github-report-mcp

This repository is a GitHub report generation tool built with TypeScript. It is designed to help developers easily obtain project progress and statistics. The features are simple, focusing on usability, and aim to facilitate team communication.

GitHub Stars

0

User Rating

Not Rated

Favorites

0

Views

51

Forks

0

Issues

0

README
GitHub Report MCP
Prerequisites
  • Node.js (latest version recommended)
  • npm (comes with Node.js)
Installation & Setup
  1. Clone the repository

    git clone <repository-url>
    cd github-report-mcp
    
  2. Install dependencies

    npm install
    
  3. Environment Configuration

    • Copy the example environment file:
      cp .env.example .env
      
    • Open .env file and fill in your GitHub token:
      GITHUB_TOKEN=your_github_token_here
      
  4. Compile the code

    npm run build
    
MCP Client Configuration

After compilation, reference the built file in your MCP client:

For Claude Desktop

Add to your Claude configuration file:

{
  "mcpServers": {
    "github-report": {
      "command": "node",
      "args": ["path/to/your/built/file.js"]
    }
  }
}
For VS Code

Configure the MCP extension to point to your compiled output file.

Getting a GitHub Token
  1. Go to GitHub Settings → Developer settings → Personal access tokens
  2. Generate a new token with appropriate repository permissions
  3. Copy the token and paste it in your .env file