MCP Atlassian Sprint

MCP Atlassian is an integrated tool that provides Model Context Protocol services for Atlassian products (Confluence and Jira), supporting both cloud and on - premise deployments.

Knowledge management and memory Developer tools #Atlassian Integration #Knowledge Management #Project Management #IDE Tools .Python

rating : 2.5 points

downloads : 9.6K

update time : 2025-04-28

Open Site

What is MCP Atlassian?

MCP Atlassian is a Model Context Protocol (MCP) server used to connect and operate the Confluence and Jira services in the Atlassian platform. It allows you to access and manage your team's knowledge base and task management system through simple commands.

How to use MCP Atlassian?

Simply install the server and configure the corresponding API tokens to start using. You can search for content, create pages, update projects, etc.

Applicable Scenarios

Suitable for enterprise teams that need efficient management and collaboration, especially those that rely on Confluence and Jira for knowledge sharing and task tracking.

Main Features

Confluence Integration

Supports searching, creating, updating, and deleting Confluence spaces and pages.

Jira Integration

Supports searching, creating, updating, and deleting Jira projects and their related tasks.

Multi - platform Support

Compatible with Atlassian Cloud and Server/Data Center deployments.

Advantages

Seamless integration with Atlassian products

Supports multiple query languages (CQL and JQL)

Easy to install and configure

Limitations

Requires a valid API token

Some advanced features may require specific permissions

How to Use

Install the Server

Install MCP Atlassian via brew, pip, or Docker.

Configure Authentication

Generate an API token and configure the URL and credentials on the server.

Start Using

Run the server and test the basic functions.

Usage Examples

Example 1: Search Confluence Content

Search for Confluence pages through a CQL query.

Example 2: Create a Jira Task

Create a new Jira task through a JQL query.

Frequently Asked Questions

How to obtain an API token?

Does it support SSL verification?

How to switch the transport mode?

Related Resources

Official Documentation

Detailed installation and configuration guide.

GitHub Code Repository

Source code and contribution guide.

Demo Video

Quickly understand the functions of MCP Atlassian.

Installation

Copy the following command to your Client for configuration

{
  "mcpServers": {
    "mcp-atlassian": {
      "command": "uvx",
      "args": [
        "mcp-atlassian",
        "--confluence-url=https://your-company.atlassian.net/wiki",
        "--confluence-username=your.email@company.com",
        "--confluence-token=your_api_token",
        "--jira-url=https://your-company.atlassian.net",
        "--jira-username=your.email@company.com",
        "--jira-token=your_api_token"
      ]
    }
  }
}

{
  "mcpServers": {
    "mcp-atlassian": {
      "command": "uvx",
      "args": [
        "mcp-atlassian",
        "--confluence-url=https://confluence.your-company.com",
        "--confluence-personal-token=your_token",
        "--jira-url=https://jira.your-company.com",
        "--jira-personal-token=your_token"
      ]
    }
  }
}

{
  "mcpServers": {
    "mcp-atlassian": {
      "command": "python",
      "args": [
        "-m",
        "mcp-atlassian",
        "--confluence-url=https://your-company.atlassian.net/wiki",
        "--confluence-username=your.email@company.com",
        "--confluence-token=your_api_token",
        "--jira-url=https://your-company.atlassian.net",
        "--jira-username=your.email@company.com",
        "--jira-token=your_api_token"
      ]
    }
  }
}

{
  "mcpServers": {
    "mcp-atlassian": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "mcp/atlassian",
        "--confluence-url=https://your-company.atlassian.net/wiki",
        "--confluence-username=your.email@company.com",
        "--confluence-token=your_api_token",
        "--jira-url=https://your-company.atlassian.net",
        "--jira-username=your.email@company.com",
        "--jira-token=your_api_token"
      ]
    }
  }
}

{
  "mcpServers": {
    "mcp-atlassian": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "--env-file",
        "/path/to/your/.env",
        "mcp/atlassian"
      ]
    }
  }
}

{
  "mcpServers": {
    "mcp-atlassian": {
      "command": "uv",
      "args": [
        "--directory", "/path/to/your/mcp-atlassian",
        "run", "mcp-atlassian",
        "--confluence-url=https://your-domain.atlassian.net/wiki",
        "--confluence-username=your.email@domain.com",
        "--confluence-token=your_api_token",
        "--jira-url=https://your-domain.atlassian.net",
        "--jira-username=your.email@domain.com",
        "--jira-token=your_api_token"
      ]
    }
  }
}

Note: Your key is sensitive information, do not share it with anyone.

🚀 MCP Atlassian Server Guide

This guide provides a comprehensive overview of the MCP Atlassian Server, including installation, configuration, usage, development, and troubleshooting. It aims to help you manage your Confluence and Jira projects effectively.

🚀 Quick Start

Installation

You can install the mcp-atlassian package using either npm or yarn:

npm install mcp-atlassian --save

Or with yarn:

yarn add mcp-atlassian

Configuration

Create a .env file in the root directory of your project and add the following content:

CONFLUENCE_URL=Your Atlassian URL
CONFLUENCE_USERNAME=Your username
CONFLUENCE_TOKEN=Your API token

JIRA_URL=Your Jira URL
JIRA_USERNAME=Your username
JIRA_TOKEN=Your API token

Starting the Server

Start the server using the following command:

npx mcp-atlassian

✨ Features

Server Features

Resource Filtering: Only display active Atlassian spaces and Jira projects that users interact with.
Supported Protocols:
- confluence://{space_key}: Access a Confluence space.
- jira://{project_key}: Access a Jira project.

Available Tools

Tool	Description
`confluence_search`	Search Confluence content using CQL.
`confluence_get_page`	Retrieve the content of a specific Confluence page.
`confluence_get_page_children`	Get the child pages of a specific Confluence page.
`confluence_get_page_ancestors`	Get the parent pages of a specific Confluence page.
`confluence_get_comments`	Retrieve the comments on a specific Confluence page.
`confluence_create_page`	Create a new Confluence page.
`confluence_update_page`	Update an existing Confluence page.
`confluence_delete_page`	Delete an existing Confluence page.
`jira_get_issue`	Get detailed information about a specific Jira issue.
`jira_search`	Search Jira issues using JQL.
`jira_get_project_issues`	Retrieve all issues in a specific Jira project.
`jira_create_issue`	Create a new issue in Jira.
`jira_update_issue`	Update an existing Jira issue.
`jira_delete_issue`	Delete an existing Jira issue.
`jira_get_transitions`	Get the available status transitions for a specific Jira issue.
`jira_transition_issue`	Transition a Jira issue to a new status.
`jira_add_worklog`	Add a worklog to a Jira issue.
`jira_get_worklog`	Retrieve the worklog entries for a Jira issue.
`jira_link_to_epic`	Link an issue to an epic task.
`jira_get_epic_issues`	Get all issues associated with a specific epic task.

📦 Development and Debugging

Local Development Setup

Clone the repository:

git clone https://github.com/your-username/mcp-atlassian.git
cd mcp-atlassian

Install dependencies:
```
npm install
```
Start the development server:
```
npm run dev
```

Debugging Tools

Install the mcp-debug package for debugging your MCP server:

npm install mcp-debug --save-dev

⚠️ Important Note

Protect Tokens: Do not store API tokens in plain text in your code. Use environment variables instead.
Limit Access: Ensure that access to Atlassian and Jira complies with your security policies.

🔧 Advanced Configuration

Setting up a Proxy Server

Add the following to your .env file to set up a proxy:

HTTP_PROXY=http://Proxy address:Port
HTTPS_PROXY=https://Proxy address:Port

Enabling Logging

Enable detailed logging in your .env file:

DEBUG=true

📚 Troubleshooting

Authentication Failure

Check your username and token for accuracy.
Ensure that your token has sufficient permissions.

Connection Issues

Check your network connection.
Verify that the target URLs are correct.

Debugging Tool Commands

Use the --verbose option to enable detailed output in the command line:

mcp-atlassian <command> --verbose

💻 Usage Examples

Searching Confluence Content

mcp-atlassian confluence_search --query "Your search term"

Creating a New Jira Issue

mcp-atlassian jira_create_issue --projectKey "Project key" --issueType "Task" --summary "Issue summary" --description "Detailed description"

📚 Documentation

For more advanced features and configuration options, refer to the full developer documentation: https://github.com/your-username/mcp-atlassian/wiki

With this guide, you can successfully configure and use the MCP Atlassian Server to manage your Confluence and Jira projects. If you have any questions or suggestions, please refer to the documentation or contact the community.