MCP Atlassian

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

概述

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

• Confluence ：搜索内容、获取空间、检索内容和列出页面

• Jira ：搜索问题、获取问题详细信息、列出项目等

Related MCP server: MCP Atlassian

先决条件

• Node.js（v16 或更高版本）

• npm 或 yarn

• 带有 API 令牌的 Atlassian 帐户

• Docker（可选，用于容器化部署）

安装

标准安装

1. 克隆存储库：

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

2. 安装依赖项：

   npm install
   # or using make
   make install

3. 使用您的 Atlassian 凭据在根目录中创建一个.env文件：

   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 容器：

   # Build the Docker image
   make docker-build
   
   # Run the Docker container
   make docker-run
   
   # Or use Docker Compose
   make docker-compose

用法

启动服务器

# Using npm
npm start

# Using make
make start

# Using 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/         # Configuration files
├── examples/       # Example usage
├── services/       # Service classes for Atlassian APIs
│   ├── confluence.ts
│   └── jira.ts
├── tools/          # MCP tools
│   ├── 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        # Main entry point

建筑

# Using npm
npm run build

# Using make
make build

测试

# Using npm
npm test

# Using make
make test

Makefile 命令

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

# Display available commands
make help

执照

麻省理工学院

贡献

1. 分叉存储库

2. 创建你的功能分支（ git checkout -b feature/amazing-feature ）

3. 提交您的更改（ git commit -m 'Add some amazing feature' ）

4. 推送到分支（ git push origin feature/amazing-feature ）

5. 打开拉取请求