MCP Atlassian 说明文档

概述

此MCP服务器允许AI代理通过标准接口与Atlassian产品（包括Confluence和Jira）交互。它提供了以下功能：

• Confluence：搜索内容、获取空间信息、检索具体页面
• Jira：搜索问题、获取问题详情、列出项目等

先决条件

• Node.js (v16或更高版本)
• npm 或 yarn
• Atlassian账户及API令牌
• Docker（可选，用于容器化部署）

安装指南

标准安装步骤

1. 克隆仓库：

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

2. 安装依赖项：

   npm install
   # 或使用make命令
   make install
   

3. 创建根目录下的.env文件，添加你的Atlassian凭证信息：

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

Docker 安装步骤

1. 克隆仓库：

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

2. 创建.env文件，如上所述。

3. 使用Docker构建和运行容器：

   # 构建Docker镜像
   make docker-build
   
   # 运行Docker容器
   make docker-run
   
   # 或使用Docker Compose
   make docker-compose
   

使用说明

启动服务器

# 使用npm启动
npm start

# 使用make命令
make start

# 使用Docker运行
make docker-run

启动后，MCP服务器将监听标准输入，并在标准输出上响应请求。

可用工具列表

Confluence 工具集

• search-confluence：使用CQL搜索Confluence中的内容

  • 参数：query（字符串）

• get-confluence-space：获取特定Confluence空间的信息

  • 参数：spaceKey（字符串）

• get-confluence-content：通过ID获取具体内容

  • 参数：contentId（字符串）

• get-confluence-pages：获取某空间下的所有页面

  • 参数：spaceKey（字符串）、limit（数字，可选）

Jira 工具集

• search-jira-issues：使用JQL搜索问题

  • 参数：jql（字符串）、maxResults（数字，可选）

• get-jira-issue：通过关键字段获取特定问题

  • 参数：issueKey（字符串）

• get-jira-projects：获取所有项目

  • 参数：无

• get-jira-project：通过项目关键字段获取特定项目

  • 参数：projectKey（字符串）

• get-jira-issues：获取问题列表

  • 参数：无

开发指南

项目结构

项目的目录结构如下：

mcp-atlassian/
├── src/          # 源代码目录
│   ├── confluence.js    # Confluence相关功能实现
│   └── jira.js         # Jira相关功能实现
├── Makefile        # 工程构建文件
└── .env.example    # .env文件示例

构建与测试

1. 使用npm进行开发：

   npm run dev
   

2. 测试项目：

   npm test
   

3. 打包项目：

   npm run build
   

Makefile 使用说明

Makefile 提供了以下命令：

• make install：安装依赖项
• make dev：启动开发服务器
• make build：构建生产环境
• make test：运行测试用例
• make docker-build：构建Docker镜像
• make docker-run：运行Docker容器

许可证信息

项目遵循[许可证名称]协议，具体内容请参考[许可文件路径]。

贡献指南

欢迎社区贡献！如果你有任何问题或建议，请通过以下方式联系：

• 提交Issue到GitHub仓库
• 发送邮件至联系邮箱
• 叉仓库并提交Pull Request

在进行任何修改前，请仔细阅读我们的贡献规范文档。