MCP Server for Cursor Integration

Cursor 集成 MCP 服务

目录

• 设置
• 可用工具
  • Jira 工具
    • get_ticket_by_key
    • transition_ticket
    • list_tickets_by_team_and_status
    • add_code_reviewer
    • list_tickets_by_sprint_and_team
  • Confluence 工具
    • test_confluence_connection
    • get_confluence_page
    • update_confluence_page
  • 图表工具
    • generate_diagram
    • add_diagram_to_confluence
• 项目结构
• 开发
• 故障排除
• 参与贡献
• 许可证

此 MCP（Model Context Protocol）服务提供 Jira、Confluence 集成和图表生成功能，可与 Cursor IDE 搭配使用。

设置

1. 克隆此仓库

2. 安装依赖项：

   npm install
   

3. 复制示例配置：

   cp .cursor/mcp.json.example .cursor/mcp.json
   

4. 使用你的凭据更新 .cursor/mcp.json：

   • Jira API 令牌
   • Confluence API 令牌
   • 两项服务的基础 URL

5. 在 Cursor 中启动服务：

   • 打开 Cursor IDE
   • 前往 Settings (⌘,)
   • 进入“Cursor Settings”
   • 在“MCP Server”下，点击“Start Server”
   • 选择此项目的目录

可用工具

Jira 工具

get_ticket_by_key

根据 Jira 工单键（例如 STK-1234）获取工单。

{
  key: string  // Jira ticket key
}

示例提示词：

• “显示 STK-1234 工单的详细信息”
• “STOCK-5678 的状态是什么？”
• “获取 STK-9012 工单的信息”

transition_ticket

将 Jira 工单转换到新的状态。

{
  key: string,    // Jira ticket key
  status: string  // Target status
}

示例提示词：

• “将 STK-1234 工单移至 Code Review”
• “将 STOCK-5678 转换为 Done”
• “将 STK-9012 的状态更新为 In Progress”

list_tickets_by_team_and_status

列出特定团队和状态的工单。

{
  team: string,   // Team name (e.g., "EComm Demand")
  status: string  // Ticket status (e.g., "Code Review")
}

示例提示词：

• “显示 EComm Demand 团队的所有 Code Review 工单”
• “列出 EComm LTV 团队的 In Progress 工单”
• “Stock 团队有哪些工单处于 QA 状态？”

add_code_reviewer

为一个或多个工单添加代码审查人员。

{
  keys: string[],  // Array of Jira ticket keys
  username: string // Username to add as reviewer
}

示例提示词：

• “将 adelmann 添加为 STK-1234 的审查人员”
• “将 jsmith 设为 STOCK-5678 和 STOCK-5679 的代码审查人员”
• “将 mmiller 添加为这些工单的代码审查人员：STK-1234、STK-1235”

list_tickets_by_sprint_and_team

列出特定冲刺和团队的工单。

{
  sprint: string, // Sprint name (e.g., "STK Sprint 253")
  team: string    // Team name (e.g., "EComm LTV")
}

示例提示词：

• “显示 STK Sprint 253 中 EComm LTV 的工单”
• “列出当前冲刺中 EComm Demand 的所有工单”
• “Stock 团队在 Sprint 254 中有哪些工单？”

Confluence 工具

test_confluence_connection

测试与 Confluence 的连接。

示例提示词：

• “测试 Confluence 连接”
• “检查 Confluence 是否正常运行”
• “验证 Confluence 凭据”

get_confluence_page

根据 ID 获取 Confluence 页面。

{
  pageId: string,           // Confluence page ID
  format?: "markdown" | "html" | "both" // Output format (default: "markdown")
}

示例提示词：

• “显示 Confluence 页面 3506530385”
• “获取 wiki 页面 1234567890 的内容”
• “以 HTML 格式获取 Confluence 页面 9876543210”

update_confluence_page

使用新内容更新 Confluence 页面。

{
  pageId: string,    // Confluence page ID
  content: string,   // HTML content to update the page with
  minorEdit?: boolean // Whether this is a minor edit (default: false)
}

示例提示词：

• “使用新内容更新 Confluence 页面 3506530385”
• “用这段 HTML 编辑 wiki 页面 1234567890”
• “更新页面 9876543210 上的文档”

注意：如需在 Confluence 页面中包含 Mermaid 图表，请将 Mermaid 内容包裹在 HTML 宏中：

<ac:structured-macro ac:name="html">
<ac:plain-text-body><![CDATA[<div>
    <script type="module" src="https://cdn.jsdelivr.net/npm/[email protected]/+esm"></script>
    <pre class="mermaid">
        [Your Mermaid diagram code here]
    </pre>
</div>]]></ac:plain-text-body>
</ac:structured-macro>

图表工具

generate_diagram

使用 Mermaid 语法生成图表，并将其保存为图像。

{
  code: string,     // Mermaid diagram code
  filename?: string // Optional filename for the diagram
}

示例提示词：

• “创建一个展示用户身份验证流程的时序图”
• “为 Cart 系统生成一个类图”
• “绘制一个展示结账流程的流程图”
• “根据此代码文件创建图表”
• “分析此类并创建图表”

Mermaid 代码示例：

sequenceDiagram
    User->>+Server: Login Request
    Server->>+Database: Validate Credentials
    Database-->>-Server: Valid
    Server-->>-User: Success

add_diagram_to_confluence

将 Mermaid 图表添加到 Confluence 页面。

{
  pageId: string,      // Confluence page ID
  mermaidCode: string, // Mermaid diagram code
  position?: string    // Where to add the diagram (top or bottom)
}

示例提示词：

• “将此图表添加到 Confluence 页面 3506530385”
• “将时序图插入页面 1234567890 的顶部”
• “使用此架构图更新 Wiki 页面 9876543210”

项目结构

.
├── .cursor/              # Cursor configuration
│   ├── mcp.json         # Your configuration (not in git)
│   └── mcp.json.example # Example configuration
├── diagrams/            # Generated diagrams (contents not in git)
├── services/           # Service implementations
├── utils/             # Utility functions
├── middleware/        # Middleware components
└── server.js         # Main server file

开发

• 生成的图表存储在 diagrams/ 目录中，但不会纳入 git 跟踪
• 此服务使用 Node.js 和 MCP SDK
• 所有工具均在 server.js 中注册

故障排除

1. 如果服务无法启动：

   • 检查 .cursor/mcp.json 是否存在且凭据有效
   • 确保没有其他 MCP 服务正在运行
   • 检查 Cursor 控制台中的错误消息

2. 如果 Cursor 中未显示工具：

   • 在 Cursor 设置中重启 MCP 服务
   • 检查工具是否已在 server.js 中正确注册

3. 如果图表生成失败：

   • 确保已全局安装 @mermaid-js/mermaid-cli：

     npm install -g @mermaid-js/mermaid-cli
     

贡献

1. Fork 此仓库
2. 创建功能分支
3. 进行更改
4. 提交拉取请求

许可证

本项目为专有机密项目。© Adobe Systems Incorporated。