mcp-gh-issue-mini

y-hirakaw/mcp-gh-issue-mini

3.2

If you are the rightful owner of mcp-gh-issue-mini and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.

A minimal MCP server for interacting with GitHub Issues.

mcp-gh-issue-mini

A production-ready MCP (Model Context Protocol) server for managing GitHub Issues with robust authentication and modular architecture.

Easily create, search, update, comment on, and close issues in any repositoryβ€”directly from MCP-compatible clients like Claude Code.

✨ Features

Core Functionality

  • Create new issues in any GitHub repository
  • List open issues with filtering
  • Get detailed issue information
  • Search issues with full GitHub query syntax (is:open label:bug "error")
  • Update issues (title, body, state)
  • Add comments with automatic MCP traceability
  • Retrieve all issue comments
  • Close issues

Advanced Features

  • πŸ” Dual Authentication: PAT + GitHub CLI fallback
  • πŸ—οΈ Modular Architecture: Clean separation of concerns
  • πŸ“ Comprehensive Logging: 4-level debug system
  • βœ… Full Test Coverage: 68.64% with 29 passing tests
  • πŸš€ Zero Config: Works with npx instantly

πŸ› οΈ Quick Start

Instant Setup (Recommended)

# Works immediately with GitHub CLI auth
gh auth login
npx mcp-gh-issue-mini

VS Code MCP Configuration

{
  "mcp": {
    "servers": {
      "mcp-gh-issue-mini": {
        "command": "npx",
        "args": ["mcp-gh-issue-mini"],
        "env": {
          "GITHUB_PERSONAL_ACCESS_TOKEN": "${env:GITHUB_PERSONAL_ACCESS_TOKEN}"
        }
      }
    }
  }
}

Optional: Add "DEBUG_MCP_GH_ISSUE": "true" to env for detailed logging

πŸ” Authentication System

Recommended: GitHub CLI Authentication

gh auth login  # One-time setup
npx mcp-gh-issue-mini  # Works immediately

Alternative: Personal Access Token

Set the environment variable GITHUB_PERSONAL_ACCESS_TOKEN if you prefer PAT authentication.

Required PAT Permissions:

PermissionAccess Level
IssuesRead & Write
MetadataRead (automatic)

Debug Mode

DEBUG_MCP_GH_ISSUE=true npx mcp-gh-issue-mini

πŸ“‹ Available Tools

  1. create_issue - Create new GitHub issue
  2. list_open_issues - List repository's open issues
  3. get_issue - Get detailed issue information
  4. update_issue - Update issue title, body, or state
  5. close_issue - Close an issue
  6. search_issues - Search issues with GitHub query syntax
  7. add_issue_comment - Add comment to issue
  8. get_issue_comments - Retrieve all issue comments

πŸ—οΈ Architecture

Modular Design

src/
β”œβ”€β”€ api/           # GitHub API integration
β”œβ”€β”€ auth/          # Dual authentication system  
β”œβ”€β”€ utils/         # Logging & helper functions
β”œβ”€β”€ test/          # Comprehensive test suite
└── index.ts       # MCP server entry point

Key Components

  • Unified GitHub API Client: Consolidated API handling
  • Smart Authentication: Automatic PAT β†’ CLI fallback
  • Configurable Logging: ERROR/WARN/INFO/DEBUG levels
  • Complete Type Safety: Full TypeScript definitions

πŸ“Š Quality Metrics

  • βœ… 29 tests passing (0 failures)
  • βœ… 68.64% code coverage
  • βœ… 0 security vulnerabilities
  • βœ… <5s build time
  • βœ… 8.6 kB package size

πŸš€ Installation & Distribution

NPM Package

# Direct usage
npx mcp-gh-issue-mini

# Install globally  
npm install -g mcp-gh-issue-mini

Development Setup

git clone https://github.com/y-hirakaw/mcp-gh-issue-mini.git
cd mcp-gh-issue-mini
npm install
npm run build
npm test

πŸ’‘ Why This Server?

Production-Ready: Robust error handling, comprehensive logging, dual authentication Developer-Friendly: Full TypeScript, extensive testing, clear architecture
Zero Dependencies: Minimal footprint with only essential dependencies Real-World Tested: Verified with actual GitHub repositories and various authentication scenarios

Perfect for learning MCP development patterns or integrating GitHub Issues into AI workflows.


πŸ“„ License

MIT License - see LICENSE file for details.

🀝 Contributing

Bug reports, suggestions, and PRs welcome! This project follows standard open-source contribution practices.