MIT License
991
最近更新:10个月前

Atlassian 工具(Confluence、Jira)的 MCP 服务器

MCP Atlassian

PyPI Version
PyPI - Downloads
PePy - Total Downloads
License
smithery badge

适用于 Atlassian 产品(Confluence 和 Jira)的模型上下文协议 (MCP) 服务器。此集成支持 Confluence 和 Jira Cloud 以及 Server/Data Center 部署。

示例用法

让您的 AI 助手:

  • 📝 自动更新 Jira - “根据会议记录更新 Jira”
  • 🔍 AI 驱动的 Confluence 搜索 - “在 Confluence 中找到我们的 OKR 指南并总结它”
  • 🐛 智能 Jira 问题过滤 - “显示上周 PROJ 项目中的紧急错误”
  • 📄 内容创建与管理 - “为 XYZ 功能创建技术设计文档”

功能演示

https://github.com/user-attachments/assets/35303504-14c6-4ae4-913b-7c25ea511c3e

Confluence 演示

https://github.com/user-attachments/assets/7fe9c488-ad0c-4876-9b54-120b666bb785

兼容性

产品 部署类型 支持状态
Confluence Cloud ✅ 完全支持
Confluence Server/Data Center ✅ 支持(版本 6.0+)
Jira Cloud ✅ 完全支持
Jira Server/Data Center ✅ 支持(版本 8.14+)

快速入门指南

1. 认证设置

首先,为 Confluence 和 Jira 生成必要的认证令牌:

对于 Cloud

  1. 前往 https://id.atlassian.com/manage-profile/security/api-tokens
  2. 点击 Create API token,命名它
  3. 立即复制该令牌

对于 Server/Data Center

  1. 前往您的个人资料(头像)→ ProfilePersonal Access Tokens
  2. 点击 Create token,命名它,设置过期时间
  3. 立即复制该令牌

2. 安装

使用 MCP Atlassian 的主要方式是通过 IDE 集成:

选项 1:使用 uvx(推荐)

首先安装 uv:

macOS/Linux:

bash 复制代码
# 使用官方安装程序
curl -LsSf https://astral.sh/uv/install.sh | sh

# 或者,在 macOS 上您可以使用 Homebrew
brew install uv

Windows:

powershell 复制代码
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

安装 uv 后,您可以在 IDE 配置中直接使用 uvx mcp-atlassian 而无需单独安装包。

选项 2:使用 pip

bash 复制代码
pip install mcp-atlassian

选项 3:使用 Smithery

bash 复制代码
npx -y @smithery/cli install mcp-atlassian --client claude

选项 4:使用 Docker

  1. 克隆仓库:
    bash 复制代码
    git clone https://github.com/sooperset/mcp-atlassian.git
    cd mcp-atlassian
  2. 构建 Docker 镜像:
    bash 复制代码
    docker build -t mcp/atlassian .

3. 关键配置选项

在 IDE 中配置时,您可以使用这些可选的环境变量:

  • CONFLUENCE_SPACES_FILTER: 按空间键过滤(例如,“DEV,TEAM,DOC”)
  • JIRA_PROJECTS_FILTER: 按项目键过滤(例如,“PROJ,DEV,SUPPORT”)
  • READ_ONLY_MODE: 设置为 "true" 以禁用写操作
  • MCP_VERBOSE: 设置为 "true" 以获得更详细的日志

注意: 您可以通过仅包含所需服务的变量来配置仅 Confluence、仅 Jira 或两者。

有关所有可用选项,请参见 .env.example 文件。

IDE 集成

MCP Atlassian 旨在通过 IDE 集成与 AI 助手一起使用。

注意: 在 Claude Desktop 中应用配置:

方法 1(推荐): 单击汉堡菜单(☰)> 设置 > 开发者 > “编辑配置”按钮

方法 2: 直接定位和编辑配置文件:

  • Windows: %APPDATA%\Claude\claude_desktop_config.json
  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Linux: ~/.config/Claude/claude_desktop_config.json

对于 Cursor: 打开设置 → 功能 → MCP 服务器 → + 添加新的全局 MCP 服务器

以下是根据您的安装方法进行设置的方法:

使用 uvx(推荐)

json 复制代码
{
  "mcpServers": {
    "mcp-atlassian": {
      "command": "uvx",
      "args": ["mcp-atlassian"],
      "env": {
        "CONFLUENCE_URL": "https://your-company.atlassian.net/wiki",
        "CONFLUENCE_USERNAME": "your.email@company.com",
        "CONFLUENCE_API_TOKEN": "your_api_token",
        "JIRA_URL": "https://your-company.atlassian.net",
        "JIRA_USERNAME": "your.email@company.com",
        "JIRA_API_TOKEN": "your_api_token"
      }
    }
  }
}
Server/Data Center 配置

对于 Server/Data Center 部署,请改用以下环境变量:

json 复制代码
{
  "mcpServers": {
    "mcp-atlassian": {
      "command": "uvx",
      "args": ["mcp-atlassian"],
      "env": {
        "CONFLUENCE_URL": "https://confluence.your-company.com",
        "CONFLUENCE_PERSONAL_TOKEN": "your_token",
        "JIRA_URL": "https://jira.your-company.com",
        "JIRA_PERSONAL_TOKEN": "your_token"
      }
    }
  }
}
单服务配置

仅针对 Confluence:

json 复制代码
{
  "mcpServers": {
    "mcp-atlassian": {
      "command": "uvx",
      "args": ["mcp-atlassian"],
      "env": {
        "CONFLUENCE_URL": "https://your-company.atlassian.net/wiki",
        "CONFLUENCE_USERNAME": "your.email@company.com",
        "CONFLUENCE_API_TOKEN": "your_api_token"
      }
    }
  }
}

仅针对 Jira:

json 复制代码
{
  "mcpServers": {
    "mcp-atlassian": {
      "command": "uvx",
      "args": ["mcp-atlassian"],
      "env": {
        "JIRA_URL": "https://your-company.atlassian.net",
        "JIRA_USERNAME": "your.email@company.com",
        "JIRA_API_TOKEN": "your_api_token"
      }
    }
  }
}
替代方案:使用 CLI 参数

您也可以使用命令行参数代替环境变量:

json 复制代码
{
  "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"
      ]
    }
  }
}
使用 pip

如果您已使用 pip 安装了 mcp-atlassian,请改用此配置:

json 复制代码
{
  "mcpServers": {
    "mcp-atlassian": {
      "command": "mcp-atlassian",
      "env": {
        "CONFLUENCE_URL": "https://your-company.atlassian.net/wiki",
        "CONFLUENCE_USERNAME": "your.email@company.com",
        "CONFLUENCE_API_TOKEN": "your_api_token",
        "JIRA_URL": "https://your-company.atlassian.net",
        "JIRA_USERNAME": "your.email@company.com",
        "JIRA_API_TOKEN": "your_api_token"
      }
    }
  }
}
使用 Docker

如果您已构建了 Docker 镜像,请使用此配置:

方法 1:使用环境变量

json 复制代码
{
  "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"
      ]
    }
  }
}

方法 2:使用环境文件

根据仓库中的 .env.example 模板创建一个 .env 文件,并填充您的变量,然后使用:

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

SSE 传输配置

使用 SSE 而非 stdio
  1. 启动服务器:
bash 复制代码
uvx mcp-atlassian --transport sse --port 9000 \
  --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
  1. 在您的 IDE 中配置:
json 复制代码
{
  "mcpServers": {
    "mcp-atlassian-sse": {
      "url": "http://localhost:9000/sse"
    }
  }
}

资源和工具

资源

  • confluence://{space_key}: 访问 Confluence 空间
  • jira://{project_key}: 访问 Jira 项目

注意: MCP 服务器会根据用户的贡献和分配情况过滤资源,只显示用户正在积极互动的 Confluence 空间和 Jira 项目。

主要工具

Confluence 工具

  • confluence_search: 使用 CQL 搜索 Confluence 内容
  • confluence_get_page: 获取特定页面的内容
  • confluence_create_page: 创建新页面
  • confluence_update_page: 更新现有页面

Jira 工具

  • jira_get_issue: 获取特定问题的详细信息
  • jira_search: 使用 JQL 搜索问题
  • jira_create_issue: 创建新问题
  • jira_update_issue: 更新现有问题
  • jira_transition_issue: 将问题转换为新状态
  • jira_add_comment: 向问题添加评论
查看所有工具
Confluence 工具 Jira 工具
confluence_search jira_get_issue
confluence_get_page jira_search
confluence_get_page_children jira_get_project_issues
confluence_get_page_ancestors jira_get_epic_issues
confluence_get_comments jira_create_issue
confluence_create_page jira_batch_create_issues
confluence_update_page jira_update_issue
confluence_delete_page jira_delete_issue
jira_get_transitions
jira_transition_issue
jira_add_comment
jira_add_worklog
jira_get_worklog
jira_download_attachments
jira_link_to_epic
jira_get_agile_boards
jira_get_board_issues
jira_get_sprints_from_board
jira_get_sprint_issues
jira_create_issue_link
jira_remove_issue_link

故障排除与调试

常见问题

  • 认证失败:
    • 对于 Cloud:检查您的 API 令牌(不是您的账户密码)
    • 对于 Server/Data Center:验证您的个人访问令牌是否有效且未过期
    • 对于较旧的 Confluence 服务器:某些旧版本需要基本认证,使用 CONFLUENCE_USERNAMECONFLUENCE_API_TOKEN(其中令牌是您的密码)
  • SSL 证书问题:如果使用 Server/Data Center 并遇到 SSL 错误,请设置 CONFLUENCE_SSL_VERIFY=falseJIRA_SSL_VERIFY=false
  • 权限错误:确保您的 Atlassian 账户有足够的权限访问相关空间/项目

调试工具

bash 复制代码
# 使用 MCP Inspector 进行测试
npx @modelcontextprotocol/inspector uvx mcp-atlassian ...

# 对于本地开发版本
npx @modelcontextprotocol/inspector uv --directory /path/to/your/mcp-atlassian run mcp-atlassian ...

# 查看日志
# macOS
tail -n 20 -f ~/Library/Logs/Claude/mcp*.log
# Windows
type %APPDATA%\Claude\logs\mcp*.log | more

安全

  • 切勿共享 API 令牌
  • 保持 .env 文件安全和私密
  • 参阅 SECURITY.md 了解最佳实践

贡献

我们欢迎对 MCP Atlassian 的贡献!如果您想贡献:

  1. 查看我们的 CONTRIBUTING.md 指南
  2. 设置您的开发环境:
    bash 复制代码
    uv sync --frozen --all-extras --dev
    pre-commit install
  3. 进行更改并提交拉取请求

我们使用预提交钩子进行代码质量检查,并遵循语义化版本控制进行发布。

许可证

根据 MIT 许可证授权 - 请参阅 LICENSE 文件。这不是官方的 Atlassian 产品。