MCP DOCKER Atlassian

🚀 MCP-DOCKER-Atlassian

Docker-based Atlassian integration setup for use with the Copilot MCP extension in VS Code.

This repository contains configurations and scripts that allow you to easily run the MCP Atlassian server in a Docker container and access Confluence and Jira resources through the Model Context Protocol.

⚠️ Important Note

The MyPy type-checking issues inherited from the upstream project have been resolved. The type-checking system is now fully functional, and all checks pass.

🚀 Quick Start

Prerequisites

• Docker is installed and running.
• The Copilot Chat extension is installed in Visual Studio Code.
• An Atlassian cloud account and an API token.
  • Generate a token at https://id.atlassian.net/manage-profile/security/api-tokens.
  • Securely save the token, as you won't be able to view it again after creation.

Steps

1. Clone the repository:

   git clone https://github.com/shane-reaume/MCP-DOCKER-Atlassian.git
   cd MCP-DOCKER-Atlassian
   

2. Set up your credentials: Copy the example environment file and edit it:

   cp .env.example .env
   # Edit the .env file to enter your Atlassian credentials
   

   Note: Do not use quotes in the .env file.

3. Make the scripts executable:

   chmod +x *.sh
   

4. Start the MCP server:

   ./start-mcp.sh
   

   The server will start at http://localhost:9001/sse.

   Stop the MCP server:

   ./stop-mcp.sh
   

5. Configure VS Code: Add the following to your VS Code settings.json:

   "mcpManager.servers": [
     {
       "name": "Atlassian-MCP",
       "type": "sse",
       "url": "http://localhost:9001/sse",
       "enabled": true
     }
   ]
   

6. Stop the server to complete:

   ./stop-mcp.sh
   

✨ Features

Available Scripts

• start-mcp.sh: Build the Docker image and start the container.
• stop-mcp.sh: Stop the running container.
• check-mcp.sh: A diagnostic tool to verify if the server is running properly.
• cleanup.sh: Remove old containers and images.
• update-remote.sh: Assist in managing the Git remote repository.
• mcp-manager.sh: Other management commands.

Available MCP Commands

After connecting, you can use the following commands:

• @mcp confluence_search "search term"
• @mcp confluence_get_page "page title"
• @mcp jira_get_issue "PROJECT-123"
• @mcp jira_search "project = PROJECT AND status = 'In Progress'"

📚 Documentation

Troubleshooting

1. Startup issues:

   • Ensure Docker is correctly installed and running.
   • Check if you have sufficient permissions to execute the scripts.
   • View the output logs for more information.

2. Connection issues:

   • Confirm that the server has started successfully and is running at the specified address.
   • Check the network configuration to ensure no firewalls are blocking access.
   • Verify that the configuration in the .env file is correct.

Environment Variables

The MCP server is configured through the following environment variables:

Based On

This project is based on the following resources and libraries:

• Official MCP Documentation
• Docker Official Documentation
• VS Code Extension Development Guide

If you need further support or encounter issues, please refer to the relevant documentation or contact the project maintainers.