MCP Atlassian

一个模型上下文协议 (MCP) 服务器，提供与 Atlassian 产品（Confluence 和 Jira）交互的工具。

概述

此 MCP 服务器允许 AI 代理通过标准化接口与 Atlassian 产品交互。它提供以下工具：

• Confluence: 搜索内容、获取空间、检索内容和列出页面
• Jira: 搜索问题、获取问题详情、列出项目等

前提条件

• Node.js (v16 或更高版本)
• npm 或 yarn
• 具有 API 令牌的 Atlassian 帐户
• 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 服务器，该服务器将侦听 stdin 上的请求并在 stdout 上响应。

可用工具

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-issue-types: 获取所有问题类型

  • 参数：无

开发

项目结构

src/
├── config/         # 配置文件
├── examples/       # 使用示例
├── services/       # Atlassian API 的服务类
│   ├── confluence.ts
│   └── jira.ts
├── tools/          # MCP 工具
│   ├── search-confluence.ts
│   ├── get-confluence-space.ts
│   ├── get-confluence-content.ts
│   ├── get-confluence-pages.ts
│   ├── search-jira-issues.ts
│   ├── get-jira-issue.ts
│   ├── get-jira-projects.ts
│   ├── get-jira-project.ts
│   ├── get-jira-issue-types.ts
│   ├── utils.ts
│   └── index.ts
└── index.ts        # 主要入口点

构建

# 使用 npm
npm run build

# 使用 make
make build

测试

# 使用 npm
npm test

# 使用 make
make test

Makefile 命令

该项目包含一个 Makefile，以简化常见操作：

# 显示可用命令
make help

许可证

MIT

贡献

1. Fork 存储库
2. 创建您的功能分支 (git checkout -b feature/amazing-feature)
3. 提交您的更改 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打开一个 Pull Request