Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

About mcp-jira-integration is a tool designed to streamline the integration between MCP (Management Control Platform) and Jira.

License

Notifications You must be signed in to change notification settings

r-pedraza/mcp-jira-integration

Repository files navigation

πŸš€ MCP-JIRA Integration Skeleton

GitHub release (latest by date) GitHub GitHub stars

Complete project skeleton for connecting VS Code to JIRA using Model Context Protocol (MCP). Get your team querying JIRA with natural language in minutes, not hours!

✨ Features

  • πŸš€ One-command setup - Complete project scaffolding in seconds
  • πŸ”’ Security-first - No credentials in git, template-based configuration
  • πŸ“š Comprehensive docs - Setup guides, examples, and troubleshooting
  • 🎯 Team ready - Perfect for organizations and development teams
  • 🌍 Cross-platform - Works on macOS, Linux, and Windows
  • ⚑ Natural language queries - "Show me high-priority bugs in project X"

πŸ“‹ Prerequisites

  • VS Code installed
  • Docker Desktop running
  • JIRA Server/Data Center access (not Atlassian Cloud)
  • JIRA Personal Access Token
  • MCP-compatible VS Code extension

πŸš€ Quick Start

Option A: Automatic Setup (Recommended)

# Clone this repository
git clone <your-repo-url>
cd mcp-jira-integration
# Make scripts executable
chmod +x *.sh
# Run complete setup
./setup-mcp-jira.sh MyJiraProject
# Verify installation
cd MyJiraProject
./verify-setup.sh
# Configure your credentials
./configure.sh

Option B: Simple Setup

# Basic setup without extras
./simple-setup.sh MyJiraProject

πŸ”§ Configuration

  1. Generate JIRA Personal Access Token

    • Go to your JIRA Server instance
    • Navigate to User Profile β†’ Personal Access Tokens
    • Create new token with read permissions
    • ⚠️ IMPORTANT: Save the token securely
  2. Configure Environment Variables

    # Edit .env file
    JIRA_URL=https://your-jira-server.com
    JIRA_PERSONAL_TOKEN=your_token_here
    JIRA_SSL_VERIFY=false
  3. Setup VS Code MCP Configuration

    • File will be created at .vscode/mcp.json
    • Update with your JIRA credentials

πŸ“Š Usage Examples

Basic Queries

"List all available JIRA projects"
"What issues are in ECAPP project for release 25.28?"
"Give me details of issue ECAPP-10745"

Advanced Queries

"Generate a markdown summary of all issues in release 25.28 for ECAPP project"
"How many issues does each developer have assigned in ECAPP project?"
"Search issues with JQL: project = ECAPP AND fixVersion = '25.28'"

πŸ› οΈ Available Scripts

Script Purpose
setup-mcp-jira.sh Complete setup with full structure and configuration
simple-setup.sh Basic setup with essential files only
configure.sh Quick configuration of variables and templates
verify-setup.sh Verification of installation and dependencies

🎬 Demo

🎯 Click to see setup demo
# Clone repository
git clone https://github.com/r-pedraza/mcp-jira-integration.git
cd mcp-jira-integration
# Run setup (takes ~30 seconds)
./setup-mcp-jira.sh MyJiraProject
# πŸš€ MCP-JIRA Integration Setup
# ================================
# Project name: MyJiraProject
# πŸ“ Creating project structure...
# βœ… Directory structure created
# πŸ“¦ Creating requirements.txt...
# 🐍 Setting up Python module...
# πŸ”§ Creating configuration templates...
# πŸ› οΈ Creating utility scripts...
# πŸ”’ Creating .gitignore...
# πŸ“š Creating documentation...
# βœ… All files created successfully
# Configure your credentials
cd MyJiraProject
./configure.sh
# πŸ”§ MCP-JIRA Configuration Setup
# ================================
# βœ… .env file created from template
# βœ… mcp.json file created from template
# ⚠️ Please edit .env and .vscode/mcp.json with your JIRA credentials
# Edit .env and .vscode/mcp.json with your actual JIRA details
# Then verify everything works
./verify-setup.sh
# πŸ” MCP-JIRA Setup Verification
# ===============================
# βœ… Docker is installed
# βœ… .env file exists
# βœ… .vscode/mcp.json exists
# πŸŽ‰ Verification completed!
# Open in VS Code and start querying!
code .

πŸ—οΈ What Gets Created

The setup script generates a complete project structure:

MyJiraProject/
β”œβ”€β”€ πŸ“„ README.md # Project documentation
β”œβ”€β”€ πŸ“¦ requirements.txt # Python dependencies 
β”œβ”€β”€ πŸ”§ .env.template/.env # Environment configuration
β”œβ”€β”€ πŸ”’ .gitignore # Git ignore rules (protects credentials)
β”œβ”€β”€ βš™οΈ configure.sh # Configuration helper script
β”œβ”€β”€ βœ… verify-setup.sh # Setup verification script
β”œβ”€β”€ 🐍 mcp_jira/ # Python module
β”‚ β”œβ”€β”€ __init__.py
β”‚ └── __main__.py # Local configuration checker
β”œβ”€β”€ 🎨 .vscode/
β”‚ └── mcp.json # VS Code MCP configuration
└── πŸ“š docs/ # Documentation
 └── SETUP_GUIDE.md # Detailed setup instructions

πŸ”’ Security Features

  • βœ… No sensitive data in repository - Only templates with placeholder values
  • βœ… Credential protection - Real tokens and URLs never committed to git
  • βœ… SSL flexibility - Support for self-signed certificates in corporate environments
  • βœ… Project filtering - Limit access to specific JIRA projects for performance
  • βœ… Template system - Safe configuration management

🌍 Platform Support

Platform Status Notes
🍎 macOS βœ… Full Support Tested on macOS Monterey+
🐧 Linux βœ… Full Support Ubuntu, CentOS, Fedora, etc.
πŸͺŸ Windows βœ… Supported Works with WSL2 and Git Bash

πŸ”— Resources

πŸ› Troubleshooting

Authentication Error (401)

  • Verify token validity
  • Check token permissions
  • For JIRA Server: use Personal Access Token (not Cloud API Token)

SSL Connection Error

"JIRA_SSL_VERIFY": "false"

Docker Not Found

  • Install Docker Desktop
  • Verify Docker is in PATH
  • Restart VS Code after Docker installation

🀝 Contributing

We welcome contributions! Here's how you can help:

  • πŸ› Report bugs by opening an issue
  • πŸ’‘ Suggest features for better JIRA integration
  • πŸ“– Improve documentation with examples and guides
  • πŸ”§ Submit PRs for bug fixes and enhancements
  • ⭐ Star the repository to show your support

Development Setup

# Fork and clone your fork
git clone https://github.com/YOUR-USERNAME/mcp-jira-integration.git
cd mcp-jira-integration
# Test your changes
./setup-mcp-jira.sh TestProject
cd TestProject
./verify-setup.sh

πŸ“ž Support & Community

πŸ™ Acknowledgments

This project is built on top of excellent open-source tools:

πŸ“„ License

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

⭐ Star History

If this project helped you, please consider giving it a star! ⭐

Star History Chart


πŸš€ Ready to revolutionize your JIRA workflow with VS Code?

Get Started Now β€’ View Documentation β€’ Report Issues

Made with ❀️ for development teams worldwide


Ready! You can now query JIRA information directly from VS Code using natural language. πŸš€

Created on July 22, 2025

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /