gitlab-mcp-setup 1.0.0

package/README.md

@@ -0,0 +1,92 @@
+# u-frontend-skills
+
+
+
+## Getting started
+
+To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+
+Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+
+## Add your files
+
+- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
+- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+
+```
+cd existing_repo
+git remote add origin https://git.ucloudadmin.com/Leo/u-frontend-skills.git
+git branch -M main
+git push -uf origin main
+```
+
+## Integrate with your tools
+
+- [ ] [Set up project integrations](https://git.ucloudadmin.com/Leo/u-frontend-skills/-/settings/integrations)
+
+## Collaborate with your team
+
+- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
+- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
+- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
+- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
+- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+
+## Test and Deploy
+
+Use the built-in continuous integration in GitLab.
+
+- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
+- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
+- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
+- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
+- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+
+***
+
+# Editing this README
+
+When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
+
+## Suggestions for a good README
+Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+
+## Name
+Choose a self-explaining name for your project.
+
+## Description
+Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+
+## Badges
+On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+
+## Visuals
+Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+
+## Installation
+Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+
+## Usage
+Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+
+## Support
+Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+
+## Roadmap
+If you have ideas for releases in the future, it is a good idea to list them in the README.
+
+## Contributing
+State if you are open to contributions and what your requirements are for accepting them.
+
+For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+
+You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+
+## Authors and acknowledgment
+Show your appreciation to those who have contributed to the project.
+
+## License
+For open source projects, say how it is licensed.
+
+## Project status
+If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,163 @@
+#!/usr/bin/env node
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const readline = __importStar(require("readline"));
+const detector_1 = require("./detector");
+const writer_1 = require("./writer");
+const GREEN = '\x1b[32m';
+const YELLOW = '\x1b[33m';
+const RED = '\x1b[31m';
+const CYAN = '\x1b[36m';
+const BOLD = '\x1b[1m';
+const RESET = '\x1b[0m';
+function log(message) {
+    console.log(message);
+}
+function success(message) {
+    console.log(`${GREEN}✓${RESET} ${message}`);
+}
+function warn(message) {
+    console.log(`${YELLOW}⚠${RESET} ${message}`);
+}
+function error(message) {
+    console.log(`${RED}✗${RESET} ${message}`);
+}
+function header(message) {
+    console.log(`\n${CYAN}${BOLD}${message}${RESET}`);
+}
+function checkNodeVersion() {
+    const version = process.version;
+    const major = parseInt(version.slice(1).split('.')[0], 10);
+    if (major < 14) {
+        error(`Node.js 版本过低: ${version}`);
+        log('  请升级到 Node.js 14.0.0 或更高版本');
+        return false;
+    }
+    success(`Node.js ${version}`);
+    return true;
+}
+async function prompt(question) {
+    const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout,
+    });
+    return new Promise((resolve) => {
+        rl.question(question, (answer) => {
+            rl.close();
+            resolve(answer.trim());
+        });
+    });
+}
+function displayTools(tools) {
+    tools.forEach((tool, index) => {
+        const status = tool.exists ? `${GREEN}已安装${RESET}` : `${YELLOW}未检测到${RESET}`;
+        log(`  [${index + 1}] ${tool.name} (${status})`);
+        log(`      ${tool.configPath}`);
+    });
+    log(`  [${tools.length + 1}] 全部配置`);
+    log(`  [0] 退出`);
+}
+function displayResults(results) {
+    header('[3/3] 配置结果');
+    const successful = results.filter(r => r.success);
+    const failed = results.filter(r => !r.success);
+    successful.forEach(r => {
+        success(r.message);
+        if (r.backupPath) {
+            log(`      原配置已备份到: ${r.backupPath}`);
+        }
+    });
+    failed.forEach(r => {
+        error(r.message);
+    });
+    if (successful.length > 0) {
+        header('🎉 配置完成！');
+        log('');
+        log('  下一步:');
+        log('  1. 重启你的 AI 工具');
+        log('  2. 首次使用时，浏览器会弹出 GitLab 登录页');
+        log('  3. 使用公司账号登录并点击授权');
+        log('  4. 授权后即可使用，后续无需再次登录');
+        log('');
+    }
+}
+async function main() {
+    log('');
+    log(`${CYAN}${BOLD}🔧 UCloud GitLab MCP 配置工具${RESET}`);
+    log('═'.repeat(40));
+    header('[1/3] 检测环境...');
+    if (!checkNodeVersion()) {
+        process.exit(1);
+    }
+    header('[2/3] 检测 AI 工具...');
+    const tools = (0, detector_1.detectAITools)();
+    const installedTools = tools.filter(t => t.exists);
+    if (installedTools.length === 0) {
+        warn('未检测到已安装的 AI 工具');
+        log('  将显示所有支持的工具，你可以选择手动配置');
+    }
+    else {
+        success(`检测到 ${installedTools.length} 个已安装的 AI 工具`);
+    }
+    log('');
+    log('  请选择要配置的工具:');
+    displayTools(tools);
+    const answer = await prompt('\n  请输入选项: ');
+    const choice = parseInt(answer, 10);
+    if (choice === 0 || isNaN(choice)) {
+        log('\n  已退出');
+        process.exit(0);
+    }
+    let selectedTools;
+    if (choice === tools.length + 1) {
+        selectedTools = tools;
+    }
+    else if (choice >= 1 && choice <= tools.length) {
+        selectedTools = [tools[choice - 1]];
+    }
+    else {
+        error('无效的选项');
+        process.exit(1);
+    }
+    log('');
+    log(`  正在配置 ${selectedTools.length} 个工具...`);
+    const results = (0, writer_1.writeConfigToTools)(selectedTools);
+    displayResults(results);
+}
+main().catch((err) => {
+    error(`发生错误: ${err.message}`);
+    process.exit(1);
+});

package/dist/config.d.ts

@@ -0,0 +1,19 @@
+export declare const GITLAB_CONFIG: {
+    OAUTH_CLIENT_ID: string;
+    OAUTH_REDIRECT_URI: string;
+    API_URL: string;
+};
+export declare const MCP_SERVER_CONFIG: {
+    mcpServers: {
+        'ucloud-gitlab': {
+            command: string;
+            args: string[];
+            env: {
+                GITLAB_USE_OAUTH: string;
+                GITLAB_OAUTH_CLIENT_ID: string;
+                GITLAB_OAUTH_REDIRECT_URI: string;
+                GITLAB_API_URL: string;
+            };
+        };
+    };
+};

package/dist/config.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MCP_SERVER_CONFIG = exports.GITLAB_CONFIG = void 0;
+exports.GITLAB_CONFIG = {
+    OAUTH_CLIENT_ID: '4cc64d7325e8271d5c2425ea02e61199957ddd471f95fc39af951cb19eda1214',
+    OAUTH_REDIRECT_URI: 'http://127.0.0.1:8888/callback',
+    API_URL: 'https://git.ucloudadmin.com/api/v4',
+};
+exports.MCP_SERVER_CONFIG = {
+    mcpServers: {
+        'ucloud-gitlab': {
+            command: 'npx',
+            args: ['-y', '@zereight/mcp-gitlab'],
+            env: {
+                GITLAB_USE_OAUTH: 'true',
+                GITLAB_OAUTH_CLIENT_ID: exports.GITLAB_CONFIG.OAUTH_CLIENT_ID,
+                GITLAB_OAUTH_REDIRECT_URI: exports.GITLAB_CONFIG.OAUTH_REDIRECT_URI,
+                GITLAB_API_URL: exports.GITLAB_CONFIG.API_URL,
+            },
+        },
+    },
+};

package/dist/detector.d.ts

@@ -0,0 +1,14 @@
+export interface AITool {
+    name: string;
+    configPath: string;
+    exists: boolean;
+    configType: 'json' | 'yaml';
+}
+/**
+ * 检测已安装的AI工具
+ */
+export declare function detectAITools(): AITool[];
+/**
+ * 获取已安装的AI工具列表
+ */
+export declare function getInstalledTools(): AITool[];

package/dist/detector.js

@@ -0,0 +1,94 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.detectAITools = detectAITools;
+exports.getInstalledTools = getInstalledTools;
+const os = __importStar(require("os"));
+const path = __importStar(require("path"));
+const fs = __importStar(require("fs"));
+/**
+ * 获取各AI工具的配置文件路径
+ */
+function getConfigPaths() {
+    const home = os.homedir();
+    const platform = os.platform();
+    return {
+        cursor: platform === 'darwin'
+            ? path.join(home, '.cursor', 'mcp.json')
+            : platform === 'win32'
+                ? path.join(home, 'AppData', 'Roaming', 'Cursor', 'mcp.json')
+                : path.join(home, '.config', 'cursor', 'mcp.json'),
+        'claude-code': path.join(home, '.claude', 'settings.json'),
+        'vscode': path.join(home, '.vscode', 'mcp.json'),
+        'opencode': path.join(home, '.config', 'opencode', 'mcp.json'),
+        'claude-desktop': platform === 'darwin'
+            ? path.join(home, 'Library', 'Application Support', 'Claude', 'claude_desktop_config.json')
+            : platform === 'win32'
+                ? path.join(home, 'AppData', 'Roaming', 'Claude', 'claude_desktop_config.json')
+                : path.join(home, '.config', 'claude', 'claude_desktop_config.json'),
+    };
+}
+/**
+ * 检测已安装的AI工具
+ */
+function detectAITools() {
+    const configPaths = getConfigPaths();
+    const tools = [];
+    const toolNames = {
+        'cursor': 'Cursor',
+        'claude-code': 'Claude Code',
+        'vscode': 'VS Code',
+        'opencode': 'OpenCode',
+        'claude-desktop': 'Claude Desktop',
+    };
+    for (const [key, configPath] of Object.entries(configPaths)) {
+        // 检查配置文件是否存在，或者其父目录是否存在（表示工具已安装）
+        const configDir = path.dirname(configPath);
+        const exists = fs.existsSync(configPath) || fs.existsSync(configDir);
+        tools.push({
+            name: toolNames[key] || key,
+            configPath,
+            exists,
+            configType: 'json',
+        });
+    }
+    return tools;
+}
+/**
+ * 获取已安装的AI工具列表
+ */
+function getInstalledTools() {
+    return detectAITools().filter(tool => tool.exists);
+}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { detectAITools, getInstalledTools, AITool } from './detector';
+export { writeConfigToTool, writeConfigToTools, WriteResult } from './writer';
+export { GITLAB_CONFIG, MCP_SERVER_CONFIG } from './config';

package/dist/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MCP_SERVER_CONFIG = exports.GITLAB_CONFIG = exports.writeConfigToTools = exports.writeConfigToTool = exports.getInstalledTools = exports.detectAITools = void 0;
+var detector_1 = require("./detector");
+Object.defineProperty(exports, "detectAITools", { enumerable: true, get: function () { return detector_1.detectAITools; } });
+Object.defineProperty(exports, "getInstalledTools", { enumerable: true, get: function () { return detector_1.getInstalledTools; } });
+var writer_1 = require("./writer");
+Object.defineProperty(exports, "writeConfigToTool", { enumerable: true, get: function () { return writer_1.writeConfigToTool; } });
+Object.defineProperty(exports, "writeConfigToTools", { enumerable: true, get: function () { return writer_1.writeConfigToTools; } });
+var config_1 = require("./config");
+Object.defineProperty(exports, "GITLAB_CONFIG", { enumerable: true, get: function () { return config_1.GITLAB_CONFIG; } });
+Object.defineProperty(exports, "MCP_SERVER_CONFIG", { enumerable: true, get: function () { return config_1.MCP_SERVER_CONFIG; } });

package/dist/writer.d.ts

@@ -0,0 +1,9 @@
+import { AITool } from './detector';
+export interface WriteResult {
+    tool: AITool;
+    success: boolean;
+    message: string;
+    backupPath?: string;
+}
+export declare function writeConfigToTool(tool: AITool): WriteResult;
+export declare function writeConfigToTools(tools: AITool[]): WriteResult[];

package/dist/writer.js

@@ -0,0 +1,103 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeConfigToTool = writeConfigToTool;
+exports.writeConfigToTools = writeConfigToTools;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const config_1 = require("./config");
+function ensureDirectoryExists(filePath) {
+    const dir = path.dirname(filePath);
+    if (!fs.existsSync(dir)) {
+        fs.mkdirSync(dir, { recursive: true });
+    }
+}
+function backupExistingConfig(filePath) {
+    if (fs.existsSync(filePath)) {
+        const backupPath = `${filePath}.backup.${Date.now()}`;
+        fs.copyFileSync(filePath, backupPath);
+        return backupPath;
+    }
+    return undefined;
+}
+function readExistingConfig(filePath) {
+    if (fs.existsSync(filePath)) {
+        try {
+            const content = fs.readFileSync(filePath, 'utf-8');
+            return JSON.parse(content);
+        }
+        catch {
+            return {};
+        }
+    }
+    return {};
+}
+function mergeConfigs(existing, newConfig) {
+    const merged = { ...existing };
+    if (!merged.mcpServers) {
+        merged.mcpServers = {};
+    }
+    const existingServers = merged.mcpServers;
+    const newServers = newConfig.mcpServers;
+    for (const [key, value] of Object.entries(newServers)) {
+        existingServers[key] = value;
+    }
+    return merged;
+}
+function writeConfigToTool(tool) {
+    try {
+        ensureDirectoryExists(tool.configPath);
+        const backupPath = backupExistingConfig(tool.configPath);
+        const existingConfig = readExistingConfig(tool.configPath);
+        const mergedConfig = mergeConfigs(existingConfig, config_1.MCP_SERVER_CONFIG);
+        fs.writeFileSync(tool.configPath, JSON.stringify(mergedConfig, null, 2), 'utf-8');
+        return {
+            tool,
+            success: true,
+            message: `已配置 ${tool.name}`,
+            backupPath,
+        };
+    }
+    catch (error) {
+        return {
+            tool,
+            success: false,
+            message: `配置 ${tool.name} 失败: ${error instanceof Error ? error.message : String(error)}`,
+        };
+    }
+}
+function writeConfigToTools(tools) {
+    return tools.map(writeConfigToTool);
+}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "gitlab-mcp-setup",
+  "version": "1.0.0",
+  "description": "One-click setup tool for GitLab MCP Server - Configure AI tools (Cursor, Claude, VS Code, OpenCode) to work with GitLab",
+  "main": "dist/index.js",
+  "bin": {
+    "gitlab-mcp-setup": "./dist/cli.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "ts-node src/cli.ts",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "gitlab",
+    "mcp",
+    "model-context-protocol",
+    "setup",
+    "ai",
+    "cursor",
+    "claude",
+    "vscode",
+    "opencode"
+  ],
+  "author": "UCloud Frontend Team",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/anthropics/gitlab-mcp-setup"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "inquirer": "^8.2.6"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "files": [
+    "dist"
+  ]
+}