Github Kanban

🚀 GitHub Issue Kanban MCP Server

A kanban management tool based on GitHub issues, supporting automated task management via Large Language Models (LLMs) and providing visualization for project progress. It is an implementation of the Model Context Protocol (MCP).

🚀 Quick Start

The GitHub Issue Kanban MCP Server is a powerful tool that integrates with the GitHub ecosystem to manage issues effectively. Here's how you can get started:

Installation

1. Clone the repository:

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

2. Install dependencies:

npm install

3. Start the service:

node src/index.ts

Configuration

Add the following configuration to the config.json file:

{
  "github": {
    "token": "your_github_token", // Replace with your GitHub access token
    "owner": "your_owner_name"   // Replace with the owner name of your repository
  },
  "mcp": {
    "endpoint": "http://localhost:3000" // Endpoint address of the MCP service
  }
}

✨ Features

• 🔄 Display GitHub issues in a kanban board.
• 🤖 Automate task management with the assistance of large language models.
• 📊 Visualize project progress.
• 🔗 Fully integrated into the GitHub ecosystem.
• 💬 Support adding comments to issues.

📦 Project Structure

kanban-server/
├── src/                    # Source code directory
│   ├── handlers/          # Request handlers
│   │   ├── comment-handlers.ts  # Module for handling comment requests
│   │   ├── issue-handlers.ts    # Module for handling issue requests
│   │   └── state-handlers.ts   # Module for handling state requests
│   ├── models/            # Data model definitions
│   │   └── Issue.ts      # Define the issue data structure
│   ├── routes/           # API route configurations
│   │   └── routes.ts     # Define all API routes
│   └── utils/            # Collection of utility functions
│       └── validator.ts  # Data validation tool
├── package.json          # Project dependencies and script definitions
└── README.md             # Project documentation

💻 Usage Examples

Tool Commands

1. List Issues (list_issues)

List all issues in a specified repository.

Command:

node list-issues.js [owner] [repo]

Example:

node list-issues.js sunwood-ai-labs github-kanban-mcp-server

2. Create a New Issue (create_issue)

Create a new issue with a specified title and content.

Command:

node create-issue.js [owner] [repo] --title "Issue Title" --body "Issue Description"

Example:

node create-issue.js sunwood-ai-labs github-kanban-mcp-server --title "New Feature Request" --body "Please implement Feature X."

3. Update an Existing Issue (update_issue)

Update the state, title, and content of a specified issue.

Command:

node update-issue.js [owner] [repo] [issue_number] [--state open|closed|--title New Title |--body New Content]

Example:

node update-issue.js sunwood-ai-labs github-kanban-mcp-server 1 --state closed

4. Add a Comment (add_comment)

Add a new comment to a specified issue.

Command:

node add-comment.js [owner] [repo] [issue_number] [--body "Comment Content" --state open|closed]

Example:

node add-comment.js sunwood-ai-labs github-kanban-mcp-server 1 --body "This feature is great!"

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

🤝 Contribution Guidelines

1. Fork this repository.
2. Create a new branch: git checkout -b feature/your-feature-name
3. Commit your changes: git commit -m 'feat: Describe your new feature'
4. Push to the branch: git push origin feature/your-feature-name
5. Submit a Pull Request.

📮 Feedback

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