使用说明
Atlassian MCP服务器
用于与Atlassian JIRA和Confluence集成的模型上下文协议(MCP)服务器。该服务器提供通过MCP协议与JIRA票证和Confluence页面交互的工具。
特性
- 获取JIRA门票详细信息
- 使用JQL搜索JIRA门票
- 创建新的JIRA票证
- 为JIRA门票添加评论
- 获取Confluence页面内容
- 在Confluence中搜索内容
先决条件
- Node.js 16或更高版本
- Atlassian Cloud帐户
- Atlassian API令牌
安装
选项1:从Cline Marketplace安装(推荐)
- 开放式诊所
- 前往“设置”>“MCP服务器”
- 选择“市场”选项卡
- 搜索“Atlassian”
- 点击“安装”
- 在系统提示时配置Atlassian凭据
选项2:从npm安装
npm install -g atlassian-mcp-server
选项3:从源代码安装
- 克隆存储库
- 运行安装脚本:
./install.sh
或手动:
- 安装依赖项
npm install
- 构建项目
npm run build
- 全局安装
npm install -g .
- 运行安装程序
atlassian-mcp-setup
配置
您可以使用安装脚本、配置文件或环境变量配置服务器。
使用安装脚本(推荐)
运行安装脚本以创建配置文件:
npx atlassian-mcp-setup
或者,如果在本地安装:
npm run setup
该脚本将指导您完成配置过程,并创建 config.json 文件在 config 目录。
手动使用配置文件
- 创建一个
config.json文件在config目录(您可以从以下位置复制config.sample.json) - 填写您的Atlassian详细信息:
{
"atlassian": {
"baseUrl": "https://your-instance.atlassian.net",
"email": "your-email@example.com",
"token": "your-api-token-here"
},
"server": {
"name": "atlassian-server",
"version": "0.1.0"
}
}
使用环境变量
设置以下环境变量:
ATLASSIAN_BASE_URL:您的Atlassian实例URL(例如。,https://your-instance.atlassian.net)ATLASSIAN_EMAIL:您的Atlassian帐户电子邮件ATLASSIAN_TOKEN:您的Atlassian API代币ATLASSIAN_CONFIG_PATH:(可选)自定义配置文件位置的路径
获取Atlassian API代币
- 登录您的Atlassian帐户https://id.atlassian.com/manage-profile/security/api-tokens
- 点击“创建API令牌”
- 为您的令牌命名(例如“MCP服务器”)
- 复制生成的令牌(您将无法再次看到它)
用法
运行服务器
atlassian-mcp-server
或者,如果从源代码安装:
npm start
与Cline整合
选项1:从市场安装(推荐)
- 开放式诊所
- 前往“设置”>“MCP服务器”
- 选择“市场”选项卡
- 搜索“Atlassian”
- 点击“安装”
- 在系统提示时配置Atlassian凭据
选项2:手动配置
如果您已手动安装服务器,请将以下内容添加到MCP设置中:
{
"mcpServers": {
"atlassian": {
"command": "atlassian-mcp-server",
"args": [],
"env": {
"ATLASSIAN_CONFIG_PATH": "/path/to/your/config.json"
},
"disabled": false
}
}
}
或者,您可以直接在设置中提供凭据:
{
"mcpServers": {
"atlassian": {
"command": "atlassian-mcp-server",
"args": [],
"env": {
"ATLASSIAN_BASE_URL": "https://your-instance.atlassian.net",
"ATLASSIAN_EMAIL": "your-email@example.com",
"ATLASSIAN_TOKEN": "your-api-token-here"
},
"disabled": false
}
}
}
可用工具
获取jira_ticket
按密钥获取JIRA票证的详细信息。
参数:
ticket_key:JIRA票证密钥(例如“PROJ-123”)
搜索门票
使用JQL搜索JIRA票。
参数:
jql:JQL查询字符串max_results:要返回的最大结果数(默认值:10)
创建jira_ticket
创建新的JIRA票证。
参数:
project_key:项目密钥(例如“PROJ”)summary:门票摘要/标题description:门票描述issue_type:问题类型(例如,“Bug”、“任务”、“故事”)(默认值:“任务”)
添加通知单
在JIRA工单上添加评论。
参数:
ticket_key:JIRA票证密钥(例如“PROJ-123”)comment:评论文本
get_conference_page
按ID获取Confluence页面。
参数:
page_id:汇流页ID
搜索影响
在Confluence中搜索内容。
参数:
query:搜索查询limit:最大结果数(默认值:10)
向市场发布
此服务器配置为使用GitHub存储库发布到Cline MCP Marketplace: https://github.com/kompallik/ATLASSIAN-MCP
要发布更新,请执行以下操作:
- 使用提供的脚本将您的更改推送到GitHub存储库:
npm run push-github
- 添加一个
icon.png文件在assets目录(如果尚未存在) - 运行发布脚本:
npm run publish-mcp
- 按照提示发布到npm和/或创建分发包
- 将您的存储库URL提交给Cline MCP Marketplace团队
许可证
麻省理工学院
