AI导哈

Confluence MCP服务器

一个提供通过REST API安全访问Atlassian Confluence的模型上下文协议(MCP)服务器。

  • by Olson3R
  • TypeScript
  • 本地部署
  • 3 星标
  • 更新于
在 GitHub 查看 Olson3R/confluence-mcp

使用说明

汇流MCP服务器

模型上下文协议（MCP）服务器，通过其REST API提供对Atlassian Confluence的安全访问。

使用Claude代码

要将此MCP服务器与Claude Code一起使用，请将其添加到MCP配置文件中：

选项1：使用claude mcp添加json（推荐）

添加此服务器的最简单方法是使用 claude mcp add-json 命令：

# First, build the server
npm run build

# Then add it using claude mcp add-json
claude mcp add-json confluence

出现提示时，粘贴以下JSON配置：

{
  "command": "node",
  "args": ["/path/to/confluence_mcp/dist/index.js"],
  "env": {
    "CONFLUENCE_BASE_URL": "https://your-domain.atlassian.net",
    "CONFLUENCE_USERNAME": "your-email@domain.com",
    "CONFLUENCE_API_TOKEN": "your-api-token",
    "ALLOWED_SPACES": "SPACE1,SPACE2,SPACE3"
  }
}

选项2：手动配置

或者，您可以手动编辑MCP配置文件(~/.config/claude-code/mcp_servers_config.json):

{
  "mcpServers": {
    "confluence": {
      "command": "node",
      "args": ["/path/to/confluence_mcp/dist/index.js"],
      "env": {
        "CONFLUENCE_BASE_URL": "https://your-domain.atlassian.net",
        "CONFLUENCE_USERNAME": "your-email@domain.com",
        "CONFLUENCE_API_TOKEN": "your-api-token",
        "ALLOWED_SPACES": "SPACE1,SPACE2,SPACE3"
      }
    }
  }
}

选项3：使用tsx进行开发

对于开发，或者如果你更喜欢直接运行TypeScript：

{
  "command": "npx",
  "args": ["tsx", "/path/to/confluence_mcp/src/index.ts"],
  "env": {
    "CONFLUENCE_BASE_URL": "https://your-domain.atlassian.net",
    "CONFLUENCE_USERNAME": "your-email@domain.com",
    "CONFLUENCE_API_TOKEN": "your-api-token",
    "ALLOWED_SPACES": "SPACE1,SPACE2,SPACE3"
  }
}

配置说明

  • 用您的实际Confluence凭据替换环境变量
  • 这 ALLOWED_SPACES 应该是您要允许访问的逗号分隔的空格键列表
  • 更新配置后重新启动Claude Code
  • 确保您首先使用以下工具构建了项目 npm run build 如果使用选项1

配置后，您可以使用以下命令：

  • “在Confluence中搜索API文档”
  • “在开发空间中创建新页面”
  • “显示PROJ空间中的所有页面”

快速开始

  1. 安装依赖项：

    npm install

  2. 配置环境：

    cp .env.example .env
# Edit .env with your Confluence credentials

  3. 构建并运行：

    npm run build
npm start

    或用于开发：

    npm run dev

配置

创建一个 .env 使用您的Confluence凭据文件：

CONFLUENCE_BASE_URL=https://your-domain.atlassian.net
CONFLUENCE_USERNAME=your-email@domain.com
CONFLUENCE_API_TOKEN=your-api-token
ALLOWED_SPACES=SPACE1,SPACE2,SPACE3
DEBUG=false

获取API令牌

  1. 首选 Atlassian帐户设置
  2. 点击“创建API令牌”
  3. 给它一个描述性的标签
  4. 复制生成的令牌（安全保存！）

可用工具

  • 搜索影响 -在允许的空间内搜索内容
  • get_page -按ID检索特定页面
  • 创建页面 -创建新页面
  • update_page -更新现有页面
  • 删除_页 -删除页面
  • list_space -列出可访问的空间
  • get_space_content -从特定空间获取页面

安全功能

  • API令牌身份验证 -使用Atlassian API令牌进行安全访问
  • 空间限制 -可配置的允许空间列表
  • 权限验证 -尊重Confluence权限
  • 请求验证 -输入验证和净化

发展

# Type checking
npm run typecheck

# Linting
npm run lint

# Testing
npm test

# Build
npm run build

相关 MCP