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!
- π 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"
- VS Code installed
- Docker Desktop running
- JIRA Server/Data Center access (not Atlassian Cloud)
- JIRA Personal Access Token
- MCP-compatible VS Code extension
# 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
# Basic setup without extras
./simple-setup.sh MyJiraProject
-
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
-
Configure Environment Variables
# Edit .env file JIRA_URL=https://your-jira-server.com JIRA_PERSONAL_TOKEN=your_token_here JIRA_SSL_VERIFY=false
-
Setup VS Code MCP Configuration
- File will be created at
.vscode/mcp.json
- Update with your JIRA credentials
- File will be created at
"List all available JIRA projects"
"What issues are in ECAPP project for release 25.28?"
"Give me details of issue ECAPP-10745"
"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'"
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 |
π― 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 .
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
- β 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 | Status | Notes |
---|---|---|
π macOS | β Full Support | Tested on macOS Monterey+ |
π§ Linux | β Full Support | Ubuntu, CentOS, Fedora, etc. |
πͺ Windows | β Supported | Works with WSL2 and Git Bash |
- Verify token validity
- Check token permissions
- For JIRA Server: use Personal Access Token (not Cloud API Token)
"JIRA_SSL_VERIFY": "false"
- Install Docker Desktop
- Verify Docker is in PATH
- Restart VS Code after Docker installation
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
# 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
- π Documentation: Check our Setup Guide
- π Issues: Report bugs or request features
- π¬ Discussions: Join the community discussions
- π§ Contact: Open an issue for support questions
This project is built on top of excellent open-source tools:
- π€ Model Context Protocol - AI assistant integration framework
- π MCP-Atlassian Plugin - JIRA connectivity for MCP
- π³ Docker - Containerized deployment
- π¨ VS Code - The best code editor
This project is licensed under the MIT License - see the LICENSE file for details.
If this project helped you, please consider giving it a star! β
π 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