@utopian426/redmine-figma-mcp 1.0.0

package/.env.example

@@ -0,0 +1,6 @@
+# Redmine Configuration
+REDMINE_URL=https://your-redmine.com
+REDMINE_API_KEY=your_redmine_api_key
+
+# Figma Configuration
+FIGMA_API_KEY=your_figma_api_key

package/README.md

@@ -0,0 +1,170 @@
+# Redmine + Figma MCP Server
+
+一个集成了 Redmine 需求管理和 Figma 设计分析的 MCP (Model Context Protocol) Server。
+
+## 功能
+
+- **redmine_get_issue**: 获取 Redmine 需求的详细信息
+- **figma_get_file**: 获取 Figma 设计文件信息
+- **figma_analyze_design**: 分析 Figma 设计文档结构
+- **redmine_figma_analyze**: 综合分析需求和设计
+- **extract_figma_key**: 从 Figma URL 提取文件 key
+- **generate_figma_design**: 根据需求生成 Figma 设计结构
+- **generate_vue_frontend**: 根据需求生成前端开发提示
+
+## 快速开始
+
+### 1. 安装依赖
+
+```bash
+cd mcp-server
+npm install
+```
+
+### 2. 配置环境变量
+
+复制 `.env.example` 为 `.env` 并填写你的 API Key：
+
+```env
+REDMINE_URL=https://your-redmine.com
+REDMINE_API_KEY=your_redmine_api_key
+FIGMA_API_KEY=your_figma_api_key
+```
+
+### 3. 构建
+
+```bash
+npm run build
+```
+
+### 4. 配置 MCP 客户端
+
+#### Claude Desktop 配置
+
+在 `claude_desktop_config.json` 中添加：
+
+```json
+{
+  "mcpServers": {
+    "redmine-figma": {
+      "command": "node",
+      "args": ["/path/to/mcp-server/dist/index.js"],
+      "env": {
+        "REDMINE_URL": "https://your-redmine.com",
+        "REDMINE_API_KEY": "your_redmine_api_key",
+        "FIGMA_API_KEY": "your_figma_api_key"
+      }
+    }
+  }
+}
+```
+
+#### Qoder 配置
+
+在 `.qoder/mcp.json` 中添加：
+
+```json
+{
+  "servers": [
+    {
+      "name": "redmine-figma",
+      "command": "node",
+      "args": ["/path/to/mcp-server/dist/index.js"],
+      "env": {
+        "REDMINE_URL": "https://your-redmine.com",
+        "REDMINE_API_KEY": "your_redmine_api_key",
+        "FIGMA_API_KEY": "your_figma_api_key"
+      }
+    }
+  ]
+}
+```
+
+## 使用示例
+
+### 获取 Redmine 需求
+
+```
+请帮我查看 Redmine 需求 #12345
+```
+
+### 分析 Figma 设计
+
+```
+请分析这个 Figma 设计: https://www.figma.com/file/ABC123/FileName
+```
+
+### 生成前端开发提示
+
+```
+帮我查看 Redmine 需求 #12762，生成前端开发提示
+```
+
+## 分享给他人使用
+
+### 方式一：直接分享代码
+
+1. 将整个 `mcp-server` 文件夹打包分享
+2. 对方解压后执行：
+   ```bash
+   cd mcp-server
+   npm install
+   npm run build
+   ```
+3. 修改 `.env` 文件中的 API Key
+4. 配置到对方的 MCP 客户端
+
+### 方式二：Git 仓库分享
+
+1. 将代码推送到 Git 仓库
+2. 他人克隆后安装依赖：
+   ```bash
+   git clone <your-repo-url>
+   cd mcp-server
+   npm install
+   npm run build
+   ```
+
+### 方式三：npm 包分享（高级）
+
+1. 发布到 npm：
+   ```bash
+   npm publish
+   ```
+2. 他人全局安装：
+   ```bash
+   npm install -g your-mcp-server
+   ```
+3. 配置时使用命令路径：
+   ```json
+   {
+     "command": "your-mcp-server"
+   }
+   ```
+
+## 开发
+
+```bash
+# 安装依赖
+npm install
+
+# 构建
+npm run build
+
+# 开发模式
+npm run dev
+```
+
+## 项目结构
+
+```
+mcp-server/
+├── src/
+│   ├── index.ts          # MCP Server 入口
+│   ├── redmine-client.ts # Redmine API 客户端
+│   └── figma-client.ts   # Figma API 客户端
+├── dist/                 # 编译输出
+├── .env                  # 环境变量
+├── package.json
+└── tsconfig.json
+```

package/dist/figma-client.d.ts

@@ -0,0 +1,248 @@
+/**
+ * Figma API Client
+ * 用于获取、创建和分析 Figma 设计文档
+ */
+export interface FigmaPluginNode {
+    id: string;
+    name: string;
+    type: 'FRAME' | 'TEXT' | 'RECTANGLE' | 'COMPONENT' | 'INSTANCE' | 'GROUP';
+    x?: number;
+    y?: number;
+    width?: number;
+    height?: number;
+    fills?: Array<{
+        type: 'SOLID' | 'GRADIENT_LINEAR' | 'IMAGE';
+        color?: {
+            r: number;
+            g: number;
+            b: number;
+            a?: number;
+        };
+    }>;
+    characters?: string;
+    fontSize?: number;
+    fontName?: {
+        family: string;
+        style: string;
+    };
+    children?: FigmaPluginNode[];
+    layoutMode?: 'NONE' | 'HORIZONTAL' | 'VERTICAL';
+    primaryAxisAlignItems?: 'MIN' | 'CENTER' | 'MAX' | 'SPACE_BETWEEN';
+    counterAxisAlignItems?: 'MIN' | 'CENTER' | 'MAX';
+    itemSpacing?: number;
+    paddingLeft?: number;
+    paddingRight?: number;
+    paddingTop?: number;
+    paddingBottom?: number;
+    cornerRadius?: number;
+    strokes?: Array<{
+        type: 'SOLID';
+        color: {
+            r: number;
+            g: number;
+            b: number;
+            a?: number;
+        };
+    }>;
+    strokeWeight?: number;
+}
+export interface FigmaFile {
+    key: string;
+    name: string;
+    lastModified: string;
+    thumbnailUrl: string;
+    version: string;
+    document: FigmaNode;
+}
+export interface FigmaNode {
+    id: string;
+    name: string;
+    type: string;
+    children?: FigmaNode[];
+    fills?: Array<{
+        type: string;
+        color?: {
+            r: number;
+            g: number;
+            b: number;
+            a: number;
+        };
+        opacity?: number;
+    }>;
+    strokes?: unknown[];
+    strokeWeight?: number;
+    strokeAlign?: string;
+    cornerRadius?: number;
+    characters?: string;
+    style?: {
+        fontFamily?: string;
+        fontPostScriptName?: string;
+        fontWeight?: number;
+        fontSize?: number;
+        textAlignHorizontal?: string;
+        textAlignVertical?: string;
+        letterSpacing?: number;
+        lineHeightPx?: number;
+        lineHeightPercent?: number;
+        fills?: Array<{
+            type: string;
+            color?: {
+                r: number;
+                g: number;
+                b: number;
+                a: number;
+            };
+        }>;
+    };
+    absoluteBoundingBox?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    constraints?: {
+        vertical: string;
+        horizontal: string;
+    };
+    componentId?: string;
+    componentPropertyDefinitions?: Record<string, unknown>;
+}
+export interface FigmaFileResponse {
+    document: FigmaNode;
+    components: Record<string, {
+        key: string;
+        name: string;
+        description: string;
+    }>;
+    schemaVersion: number;
+    styles: Record<string, {
+        key: string;
+        name: string;
+        styleType: string;
+        description: string;
+    }>;
+    name: string;
+    lastModified: string;
+    thumbnailUrl: string;
+    version: string;
+    role: string;
+    editorType: string;
+    linkAccess: string;
+}
+export interface FigmaComment {
+    id: string;
+    file_key: string;
+    parent_id?: string;
+    user: {
+        id: string;
+        handle: string;
+        img_url: string;
+    };
+    created_at: string;
+    resolved_at?: string;
+    message: string;
+    client_meta?: {
+        x: number;
+        y: number;
+        node_id?: string;
+        node_offset?: {
+            x: number;
+            y: number;
+        };
+    };
+    order_id: number;
+}
+export interface FigmaCommentsResponse {
+    comments: FigmaComment[];
+}
+export declare class FigmaClient {
+    private apiKey;
+    private baseUrl;
+    constructor(apiKey: string);
+    /**
+     * 获取 Figma 文件信息
+     * @param fileKey 文件 key（从 Figma URL 中提取）
+     * @returns 文件信息
+     */
+    getFile(fileKey: string): Promise<FigmaFileResponse>;
+    /**
+     * 获取 Figma 文件评论
+     * @param fileKey 文件 key
+     * @returns 评论列表
+     */
+    getComments(fileKey: string): Promise<FigmaComment[]>;
+    /**
+     * 从 Figma URL 中提取文件 key
+     * @param url Figma URL，如 https://www.figma.com/file/ABC123/FileName
+     * @returns 文件 key
+     */
+    extractFileKey(url: string): string | null;
+    /**
+     * 遍历节点树，收集所有文本内容
+     * @param node 节点
+     * @param texts 文本数组
+     */
+    private collectTextNodes;
+    /**
+     * 遍历节点树，收集所有组件
+     * @param node 节点
+     * @param components 组件数组
+     */
+    private collectComponents;
+    /**
+     * 遍历节点树，收集所有 frame/page 信息
+     * @param node 节点
+     * @param frames frame 数组
+     */
+    private collectFrames;
+    /**
+     * 分析 Figma 文件结构
+     * @param file 文件响应
+     * @returns 分析结果
+     */
+    analyzeFile(file: FigmaFileResponse): {
+        summary: string;
+        pages: Array<{
+            name: string;
+            nodeCount: number;
+            texts: string[];
+        }>;
+        components: string[];
+        styles: string[];
+        allTexts: string[];
+    };
+    /**
+     * 统计节点数量
+     * @param node 节点
+     * @returns 数量
+     */
+    private countNodes;
+    /**
+     * 格式化文件分析结果为字符串
+     * @param analysis 分析结果
+     * @returns 格式化字符串
+     */
+    formatAnalysisForPrompt(analysis: ReturnType<FigmaClient['analyzeFile']>): string;
+    /**
+     * 生成 Figma 设计节点结构（用于创建设计稿）
+     * @param requirementTitle 需求标题
+     * @param requirementDesc 需求描述
+     * @returns Figma 节点结构
+     */
+    generateDesignFromRequirement(requirementTitle: string, requirementDesc: string): FigmaPluginNode;
+    /**
+     * 解析需求描述，提取功能点
+     */
+    private parseFeatures;
+    /**
+     * 创建功能点设计框架
+     */
+    private createFeatureFrame;
+    /**
+     * 将设计节点转换为 Vue 组件代码建议
+     */
+    generateVueCodeSuggestion(node: FigmaPluginNode): string;
+    private generateVueElement;
+    private kebabCase;
+}
+//# sourceMappingURL=figma-client.d.ts.map

package/dist/figma-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"figma-client.d.ts","sourceRoot":"","sources":["../src/figma-client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,WAAW,GAAG,WAAW,GAAG,UAAU,GAAG,OAAO,CAAC;IAC1E,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,KAAK,CAAC;QACZ,IAAI,EAAE,OAAO,GAAG,iBAAiB,GAAG,OAAO,CAAC;QAC5C,KAAK,CAAC,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KACzD,CAAC,CAAC;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7C,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,UAAU,CAAC;IAChD,qBAAqB,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,KAAK,GAAG,eAAe,CAAC;IACnE,qBAAqB,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,KAAK,CAAC;IACjD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,KAAK,CAAC;QACd,IAAI,EAAE,OAAO,CAAC;QACd,KAAK,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KACxD,CAAC,CAAC;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC;IAEvB,KAAK,CAAC,EAAE,KAAK,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;QACvD,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC,CAAC;IACH,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE;QACN,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,KAAK,CAAC,EAAE,KAAK,CAAC;YACZ,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,CAAC,EAAE;gBAAE,CAAC,EAAE,MAAM,CAAC;gBAAC,CAAC,EAAE,MAAM,CAAC;gBAAC,CAAC,EAAE,MAAM,CAAC;gBAAC,CAAC,EAAE,MAAM,CAAA;aAAE,CAAC;SACxD,CAAC,CAAC;KACJ,CAAC;IAEF,mBAAmB,CAAC,EAAE;QACpB,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,WAAW,CAAC,EAAE;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;IAEF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4BAA4B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxD;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,SAAS,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE;QACzB,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC,CAAC;IACH,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;QACrB,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC,CAAC;IACH,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE;QACZ,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KACxC,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED,qBAAa,WAAW;IACtB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAA8B;gBAEjC,MAAM,EAAE,MAAM;IAI1B;;;;OAIG;IACG,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAuB1D;;;;OAIG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAkB3D;;;;OAIG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAM1C;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAWxB;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAWzB;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAWrB;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG;QACpC,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC,CAAC;QACnE,UAAU,EAAE,MAAM,EAAE,CAAC;QACrB,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;KACpB;IAuCD;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAUlB;;;;OAIG;IACH,uBAAuB,CAAC,QAAQ,EAAE,UAAU,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,GAAG,MAAM;IAsCjF;;;;;OAKG;IACH,6BAA6B,CAC3B,gBAAgB,EAAE,MAAM,EACxB,eAAe,EAAE,MAAM,GACtB,eAAe;IAmDlB;;OAEG;IACH,OAAO,CAAC,aAAa;IAiDrB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA4E1B;;OAEG;IACH,yBAAyB,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM;IA0BxD,OAAO,CAAC,kBAAkB;IA2B1B,OAAO,CAAC,SAAS;CAMlB"}