Saleshandy Confluence MCP Server

Confluence API Docs MCP服务器

一种MCP（模型上下文协议）服务器，用于从以下内容生成Confluence中的API文档：

• Swagger/OpenAPI规范 （JSON文件或URL）
• NestJS控制器文件 （TypeScript装饰器）

自动生成Postman收藏并将其嵌入文档页面。

安装

npm install
npm run build

配置

1. 复制 .env.example 到 .env

1. 填写您的Confluence Cloud凭据：

- CONFLUENCE_BASE_URL：您的Atlassian Cloud URL（例如。，https://mycompany.atlassian.net) - CONFLUENCE_EMAIL：您的电子邮件地址 - CONFLUENCE_API_TOKEN：来自的API令牌https://id.atlassian.com/manage-profile/security/api-tokens

1. 增添 ~/.claude.json:

{
  "mcpServers": {
    "confluence-api-docs": {
      "command": "node",
      "args": ["/home/harsh-vaghela/saleshandy/confluence-api-docs-mcp/dist/index.js"],
    }
  }
}

用法

可用工具

空间管理：

• list_spaces -列出所有汇流空间
• search_pages -搜索现有页面
• get_page -获取页面内容
• delete_page -删除页面

Swagger/OpenAPI文档：

• create_api_doc -从Swagger/OpenAPI规范（URL或文件）创建API文档
• update_api_doc -根据规范更新现有API文档
• sync_swagger_to_confluence -与可配置的分组（标签、路径或单页）完全同步

NestJS控制器文档：

• create_api_doc_from_controller -从NestJS控制器文件创建文档
• update_api_doc_from_controller -从控制器文件更新文档

注： 所有工具都会自动生成嵌入在文档中的Postman集合。

例子

列出可用空间：

Show me available Confluence spaces

从Swagger创建API文档：

Create API documentation in space DEV from http://localhost:3000/swagger.json

从NestJS控制器创建API文档：

Create API documentation from src/controllers/dialer.controller.ts in space DEV with base URL https://api.example.com

从控制器目录创建文档：

Create API documentation from src/controllers in space DEV

更新API文档：

Update page 12345678 with latest API spec from /path/to/swagger.json

来自控制器的更新：

Update page 12345678 from src/controllers/dialer.controller.ts

发展

npm run dev          # Run with ts-node
npm run build        # Build to dist/
npm start            # Run compiled version
npm run clean        # Remove dist/

建筑

MCP Server
  ├── Parsers
  │   ├── Swagger Parser Service
  │   │   └── Parses OpenAPI specs from URLs or files
  │   └── Controller Parser Service
  │       └── Parses NestJS TypeScript controller files
  ├── Generators
  │   ├── Doc Generator Service
  │   │   └── Converts parsed specs to Confluence storage format
  │   └── Postman Generator Service
  │       └── Generates Postman Collection v2.1 JSON
  ├── Confluence Client Service
  │   └── Handles Confluence REST API v2 calls
  └── Tools
      ├── Space Management
      ├── Swagger-based Documentation
      ├── Controller-based Documentation
      └── Maintenance

双模流水线

Swagger和Controller的输入都收敛到相同的值 ParsedSwagger 格式，确保输出文档一致：

Swagger JSON/URL → Swagger Parser → ParsedSwagger ─┐
                                                    ├→ Doc Generator → Confluence HTML + Postman JSON
NestJS Controller → Controller Parser → ParsedSwagger ┘

支持的Swagger/OpenAPI版本

• OpenAPI 3.0.x
• OpenAPI 3.1.x
• Swagger 2.0

许可证

麻省理工学院