MCP Atlassian

🚀 MCP Atlassian Installation and Configuration

This project offers a comprehensive solution for integrating and utilizing MCP within the Atlassian ecosystem, enabling seamless interaction with Confluence and Jira.

🚀 Quick Start

📦 Installation

Use the following command to install MCP Atlassian:

uvx mcp-atlassian install

The installation commands for different platforms are as follows:

• macOS:

uvx mcp-atlassian install --platform=darwin

• Windows:

uvx mcp-atlassian install --platform=windows

• Linux (supports major distributions):

uvx mcp-atlassian install --platform=linux

⚙️ Configuration

Environment Variable Configuration

Set the following environment variables in the terminal or command prompt:

export MCP_ATLASSIAN_APISecret=your_api_token_here

⚠️ Important Note

• Cloud users: Use the CONFLUENCE_API_TOKEN and JIRA_API_TOKEN environment variables.
• Server/Data Center users: Use CONFLUENCE_USERNAME, CONFLUENCE_PASSWORD, JIRA_USERNAME, and JIRA_PASSWORD.

IDE Configuration

Configure the MCP server in your IDE:

{
  "mcpServers": {
    "mcp-atlassian": {
      "command": "uvx mcp-atlassian run",
      "args": []
    }
  }
}

📚 Documentation

📎 Resource Links

• confluence://{space_key}: Access a Confluence space.
• jira://{project_key}: Access a Jira project.

⚠️ Important Note

The MCP server filters and displays the visibility of Confluence spaces and Jira projects based on the user's current interaction.

🛠️ Key Tools

Confluence Tools

• confluence_search: Search Confluence content using CQL.
• confluence_get_page: Get the content of a specific page.
• confluence_create_page: Create a new page.
• confluence_update_page: Update an existing page.
• confluence_attach_content: Attach content to a page.

Jira Tools

• jira_get_issue: Get the details of a specific issue.
• jira_search: Search for issues using JQL.
• jira_create_issue: Create a new issue.
• jira_update_issue: Update an existing issue.
• jira_transition_issue: Transition an issue to a new status.
• jira_add_comment: Add a comment to an issue.

🐞 Troubleshooting and Debugging

Common Issues

• No response: Check if the environment variables are set correctly.
• Authentication failure: Ensure that the API tokens or credentials are accurate.
• Connection timeout: Verify network connectivity and the status of the target service.

Debugging Tools

Use the following command to start debugging:

uvx mcp-atlassian debug

Configure the debugging parameters in your IDE:

{
  "mcpServers": {
    "mcp-atlassian-debug": {
      "command": "uvx mcp-atlassian debug",
      "args": []
    }
  }
}

🔒 Security

• Protect API tokens: Avoid storing them in plain text in your code.
• Environment variable security: Ensure that sensitive information is not accidentally leaked.
• Update strategy: Regularly change API tokens to enhance security.

🤝 Contribution Guidelines

Development Environment Setup

Install the dependencies:

uvx mcp-atlassian dev-dependencies install

Start the development server:

uvx mcp-atlassian dev

Submitting Code

Use the following command to submit changes:

uvx mcp-atlassian pull-request

📄 License

MCP Atlassian is licensed under the MIT License. The specific terms are as follows:

Copyright © [Year] [Author's Name]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

1. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
2. Modified versions must carry the copyright notice and this license notice.