MCP Atlassian Server

🚀 MCP Server Documentation

This documentation comprehensively covers the installation, configuration, usage, and troubleshooting of the MCP server.

🚀 Quick Start

Create a Project

mcp create project MyNewProject

Start a Project

mcp start MyNewProject

Stop a Project

mcp stop MyNewProject

Delete a Project

mcp delete MyNewProject

📦 Installation

Download the MCP Server

1. Visit the MCP Server Download Page.
2. Select the appropriate version for your operating system (Windows/Mac/Linux) and download it.

Installation Steps

1. Extract the Files:

   • Double - click the downloaded archive and extract its contents to a specified directory.

2. Configure Environment Variables (Windows users only):

   • Add the installation path of the MCP server to the system environment variable PATH. This allows you to start the service by directly entering mcp - server in the command line.

3. Start the Server:

   • Open a command - line tool, navigate to the extracted directory, and execute the command:

     mcp-server start
     

4. Access the Console:

   • Open http://localhost:8091 in your browser to access the management console.

5. Stop the Server:

   • Execute the command in the command - line tool:

     mcp-server stop
     

💻 Project Management

Create a New Project

Use the following command to create a new project named MyNewProject:

mcp create project MyNewProject

Configure Project Settings

Edit the project's configuration file, usually located at /path/to/MyNewProject/config.json.

Start and Stop a Project

Start the project:

mcp start MyNewProject

Stop the project:

mcp stop MyNewProject

🛠️ Troubleshooting

Unable to Connect to the MCP Server

1. Check Container Status (Docker users only):

   docker ps --filter "name=mcp-atlassian"
   

2. View Container Logs:

   docker logs mcp-atlassian
   

3. Verify the Atlassian API Token:

   • Ensure that your Atlassian account has the necessary API access permissions.
   • Check if the API Token is valid.

4. Test the Connection:

   curl -u "your-email@example.com:your-api-token" -H "Content-Type: application/json" https://your-site.atlassian.net/rest/api/3/project
   

Project Failed to Start

1. Check the log files for detailed error information.
2. Ensure that all dependencies are correctly installed.

📚 Appendix

Supported Command - Line Options

• --help: Display help information.
• --version: Display the MCP server version.
• --config <path>: Specify the configuration file path.

Example Configuration File

{
  "server": {
    "port": 8091,
    "host": "localhost"
  },
  "projects": [
    {
      "name": "MyProject",
      "path": "/var/www/MyProject"
    }
  ]
}

Contact Information

• Email: support@example.com
• Phone: +86 - 123 - 456789