使用说明

项目简介

本项目是一个 Model Context Protocol (MCP) 服务器，旨在为大型语言模型 (LLM) 应用提供访问 Atlassian Confluence 和 Jira 云平台数据的能力。通过此服务器，LLM 可以检索 Confluence 知识库文章、Jira 问题追踪信息等，从而增强 LLM 在企业知识管理和项目管理领域的应用。

主要功能点

Confluence 内容访问:
- 搜索和读取 Confluence 空间和页面内容。
- 获取 Confluence 页面的评论。
Jira 问题访问:
- 搜索和读取 Jira 问题。
- 获取 Jira 项目的问题列表和元数据。
工具集成:
- 提供 Confluence 和 Jira 的搜索、内容获取等工具，供 LLM 调用。
资源管理:
- 将 Confluence 空间和 Jira 项目作为资源进行管理和访问。
MCP 协议标准:
- 完全遵循 MCP 协议，易于与各种 MCP 客户端集成。

安装步骤

克隆仓库

git clone https://github.com/MCP-Mirror/sooperset_mcp-atlassian.git
cd sooperset_mcp-atlassian

安装依赖 建议使用 'uv' 包管理器以获得更快的安装速度：

uv pip install -r requirements.txt

或者使用 'pip'：

pip install -r requirements.txt

配置环境变量 在项目根目录下创建 '.env' 文件，并填入您的 Atlassian API 凭据：

CONFLUENCE_URL=https://your-domain.atlassian.net/wiki
[email protected]
CONFLUENCE_API_TOKEN=YOUR_CONFLUENCE_API_TOKEN
JIRA_URL=https://your-domain.atlassian.net
[email protected]
JIRA_API_TOKEN=YOUR_JIRA_API_TOKEN

请将 'YOUR_CONFLUENCE_API_TOKEN' 和 'YOUR_JIRA_API_TOKEN' 替换为您在 Atlassian 账号中生成的 API Token。您可以在 https://id.atlassian.com/manage-profile/security/api-tokens 获取 API Token。

服务器配置

要将此 MCP 服务器与 MCP 客户端（例如 Claude Desktop）配合使用，您需要在客户端的配置文件（例如 'claude_desktop_config.json'）中添加服务器配置。以下是一个示例配置，可以直接复制到您的客户端配置文件中：

{
  "mcpServers": {
    "mcp-atlassian": {
      "command": "uvx",
      "args": ["mcp-atlassian"],
      "env": {
        "CONFLUENCE_URL": "https://your-domain.atlassian.net/wiki",
        "CONFLUENCE_USERNAME": "[email protected]",
        "CONFLUENCE_API_TOKEN": "YOUR_CONFLUENCE_API_TOKEN",
        "JIRA_URL": "https://your-domain.atlassian.net",
        "JIRA_USERNAME": "[email protected]",
        "JIRA_API_TOKEN": "YOUR_JIRA_API_TOKEN"
      }
    }
  }
}

配置参数说明：

'"mcp-atlassian"': 服务器名称，您可以自定义，用于在客户端中标识此服务器。
'"command": "uvx"': 启动服务器的命令。这里 'uvx' 是一个快速的 Python 运行器，假设您的环境中已安装 'uv' 并添加到环境变量。如果您使用 'pip' 安装依赖，且没有使用虚拟环境，可以将命令改为 'python'，并需要调整 '"args"' 参数。
'"args": ["mcp-atlassian"]': 传递给启动命令的参数。'mcp-atlassian' 指向 'src/mcp_atlassian/init.py' 中定义的入口点，'uvx mcp-atlassian' 命令会直接运行服务器。
'"env"': 环境变量配置，用于服务器连接 Atlassian 服务。请务必将 'CONFLUENCE_URL'、'CONFLUENCE_USERNAME'、'CONFLUENCE_API_TOKEN'、'JIRA_URL'、'JIRA_USERNAME'、'JIRA_API_TOKEN' 替换为您的实际 Atlassian Cloud 域名、邮箱和 API Token。请确保这些信息正确，否则服务器将无法连接到 Atlassian 服务。

基本使用方法

启动 MCP 服务器。在克隆的仓库目录下，打开终端并执行以下命令启动服务器 (如果使用 'uvx'):

uvx mcp-atlassian

如果使用 'uv run':

uv run mcp-atlassian

或者，如果您需要指定仓库路径：

uv run --directory /path/to/sooperset_mcp-atlassian mcp-atlassian

请将 '/path/to/sooperset_mcp-atlassian' 替换为实际仓库路径。

配置 MCP 客户端。根据您的 MCP 客户端（例如 Claude Desktop）的指引，将上面提供的服务器配置信息添加到客户端的配置文件中。
连接并使用。启动 MCP 客户端，客户端应该能够自动连接到正在运行的 MCP 服务器。连接成功后，您就可以在客户端中使用 Confluence 和 Jira 的资源和工具了。具体的使用方式请参考您的 MCP 客户端的使用说明。

注意事项

API Token 安全: 请妥善保管您的 Atlassian API Token，避免泄露。
环境变量配置: 确保 '.env' 文件中的环境变量配置正确，特别是 URL、用户名和 API Token。
网络连接: 确保服务器可以访问 Atlassian Cloud 服务，客户端可以访问 MCP 服务器。

关键词