Atlassian

🚀 MCP Atlassian Documentation

This MCP server enables AI agents to interact with Atlassian products (including Confluence and Jira) through a standard interface. It offers the following features:

• Confluence: Search for content, get space information, retrieve specific pages.
• Jira: Search for issues, get issue details, list projects, etc.

✨ Prerequisites

• Node.js (v16 or higher)
• npm or yarn
• An Atlassian account and API token
• Docker (optional, for containerized deployment)

📦 Installation

Standard Installation Steps

1. Clone the repository:

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

2. Install dependencies:

   npm install
   # Or use the make command
   make install
   

3. Create a .env file in the root directory and add your Atlassian credentials:

   ATLASSIAN_HOST=https://your-domain.atlassian.net
   ATLASSIAN_EMAIL=your-email@example.com
   ATLASSIAN_API_TOKEN=your-api-token
   

Docker Installation Steps

1. Clone the repository:

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

2. Create a .env file as described above.

3. Build and run the container using Docker:

   # Build the Docker image
   make docker-build
   
   # Run the Docker container
   make docker-run
   
   # Or use Docker Compose
   make docker-compose
   

💻 Usage Examples

Start the Server

# Start with npm
npm start

# Use the make command
make start

# Run with Docker
make docker-run

After starting, the MCP server will listen on standard input and respond to requests on standard output.

List of Available Tools

Confluence Toolset

• search-confluence: Search for content in Confluence using CQL.

  • Parameter: query (string)

• get-confluence-space: Get information about a specific Confluence space.

  • Parameter: spaceKey (string)

• get-confluence-content: Retrieve specific content by ID.

  • Parameter: contentId (string)

• get-confluence-pages: Get all pages in a space.

  • Parameters: spaceKey (string), limit (number, optional)

Jira Toolset

• search-jira-issues: Search for issues using JQL.

  • Parameters: jql (string), maxResults (number, optional)

• get-jira-issue: Retrieve a specific issue by its key.

  • Parameter: issueKey (string)

• get-jira-projects: Get all projects.

  • Parameter: None

• get-jira-project: Retrieve a specific project by its key.

  • Parameter: projectKey (string)

• get-jira-issues: Get a list of issues.

  • Parameter: None

📚 Documentation

Project Structure

The project's directory structure is as follows:

mcp-atlassian/
├── src/          # Source code directory
│   ├── confluence.js    # Implementation of Confluence-related functions
│   └── jira.js         # Implementation of Jira-related functions
├── Makefile        # Project build file
└── .env.example    # Example of the .env file

Build and Test

1. Develop using npm:

   npm run dev
   

2. Test the project:

   npm test
   

3. Package the project:

   npm run build
   

Using the Makefile

The Makefile provides the following commands:

• make install: Install dependencies.
• make dev: Start the development server.
• make build: Build for production.
• make test: Run test cases.
• make docker-build: Build the Docker image.
• make docker-run: Run the Docker container.

📄 License

The project follows the [License Name] agreement. Please refer to [License File Path] for specific details.

🔗 Contribution Guidelines

Community contributions are welcome! If you have any questions or suggestions, please contact us in the following ways:

• Submit an Issue to the GitHub repository.
• Send an email to the contact email.
• Fork the repository and submit a Pull Request.

Before making any modifications, please carefully read our [Contribution Guidelines](Contribution Specification Path).