Github Kanban MCP Server

🚀 GitHub Issue Kanban MCP Server

A Model Context Protocol (MCP) server that combines GitHub issues with large language models (LLMs) for efficient task automation and management.

🚀 Quick Start

The GitHub Issue Kanban MCP Server is a powerful tool that integrates GitHub issues with large language models (LLMs) to achieve efficient task automation management. Here's how you can get started quickly:

First, make sure you have Node.js and npm installed (Node.js >=14, npm >=6). Then, clone the repository using the command git clone https://github.com/sunwood-ai-labs/github-kanban-mcp-server.git and navigate to the project directory with cd github-kanban-mcp-server. Next, install the necessary dependencies by running npm install. Finally, start the service with npm start.

✨ Features

• 🔄 Manage GitHub issues in a kanban board format.
• 🤖 Automate task processing driven by LLM.
• 📊 Visualize and track project progress.
• 💡 Support comment interaction.
• 🔧 Flexibly configure multiple states and labels.

📚 Documentation

Project Structure

├── src/
│   ├── index.ts           # Entry file
│   ├── server.ts          # Core server logic
│   ├── services/
│       ├── githubService.ts      # Handling GitHub API calls
│       └── mcpService.ts        # Implementation of MCP protocol interface
├── interfaces/
│   ├── issue.ts           # Definition of issue interface
│   └── comment.ts         # Definition of comment interface
└── package.json          # Project dependency management

Installation Guide

1. Ensure Node.js and npm are installed (Node.js >=14, npm >=6).
2. Clone the repository:

   git clone https://github.com/sunwood-ai-labs/github-kanban-mcp-server.git
   cd github-kanban-mcp-server
   

3. Install dependencies:

   npm install
   

4. Start the service:

   npm start
   

Configuration Instructions

Add the MCP server configuration to config.json:

{
  "mcpServer": {
    "host": "localhost",
    "port": 3000,
    "githubToken": "your_github_token"
  }
}

Available Tools

1. List Issues

• Command: list_issues
• Parameters:
  • repo: Target repository name (required)
  • state: Filter by state (open/closed) (optional, default: all)

2. Create a New Issue

• Command: create_issue
• Parameters:
  • repo: Repository name (required)
  • title: Issue title (required)
  • body: Issue description (optional)
  • labels: List of labels (optional)

3. Update an Existing Issue

• Command: update_issue
• Parameters:
  • repo: Repository name (required)
  • issue_number: Issue number (required)
  • title: New title (optional)
  • body: New description (optional)
  • state: New state (open/closed) (optional)
  • labels: New list of labels (optional)

4. Add a Comment

• Command: add_comment
• Parameters:
  • repo: Repository name (required)
  • issue_number: Issue number (required)
  • body: Comment content (required, supports Markdown format)
  • state: Update state (open/closed) (optional)

📄 License

This project is licensed under the MIT License. For details, see the LICENSE file.

🤑 Contribution Guidelines

1. Fork the project repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m '✨ New: A clear and concise feature description').
4. Push to the remote branch (git push origin feature/amazing-feature).
5. Submit a Pull Request.

📬 Feedback

If you encounter any issues or have suggestions, please submit them via Issues.