congmao-cli 1.0.0

package/src/mcp/README.md

@@ -0,0 +1,134 @@
+# CM CLI MCP 服务器
+
+CM CLI 的 Model Context Protocol (MCP) 服务器，为 AI 助手提供快速创建项目和查看项目结构的能力。
+
+## 功能
+
+### 1. 快速创建项目 (`create-project`)
+
+支持创建以下类型的项目：
+- **移动端** (mobile): 使用 Uni-app 模板
+- **小程序** (miniprogram): 使用 Uni-app 模板
+- **后台管理系统** (admin): 使用 Vue2 或 Vue3 模板
+
+#### 参数
+
+- `projectName` (必需): 项目名称，只能包含小写字母、数字和连字符
+- `projectType` (必需): 项目类型，可选值：`mobile`、`miniprogram`、`admin`
+- `vueVersion` (可选): Vue 版本，当 `projectType` 为 `admin` 时必需，可选值：`Vue2`、`Vue3`
+- `needESLint` (可选): 是否配置 ESLint，默认为 `true`
+- `targetPath` (可选): 目标路径，默认为当前工作目录
+
+#### 示例
+
+```json
+{
+  "projectName": "my-admin-project",
+  "projectType": "admin",
+  "vueVersion": "Vue2",
+  "needESLint": true
+}
+```
+
+### 2. 查看项目结构树 (`show-project-tree`)
+
+显示指定项目的目录结构树。
+
+#### 参数
+
+- `projectPath` (必需): 项目路径，可以是相对路径或绝对路径
+- `maxDepth` (可选): 最大深度，默认为 `3`
+- `ignorePatterns` (可选): 忽略的目录模式，默认为 `["node_modules", ".git", "dist", "build"]`
+
+#### 示例
+
+```json
+{
+  "projectPath": "./my-project",
+  "maxDepth": 2,
+  "ignorePatterns": ["node_modules", ".git"]
+}
+```
+
+## 使用方法
+
+### 安装依赖（首次使用必需）
+
+```bash
+cd src/mcp
+pnpm install
+```
+
+### 作为 MCP 服务器运行
+
+```bash
+cd src/mcp
+node src/index.js
+```
+
+### 在 Cursor 中配置
+
+**详细配置指南请查看 [CURSOR_SETUP.md](./CURSOR_SETUP.md)**
+
+快速配置步骤：
+
+1. 打开 Cursor 设置（`Ctrl+,` 或 `Cmd+,`）
+2. 搜索 "MCP" 或 "Model Context Protocol"
+3. 添加以下配置（替换为你的实际路径）：
+
+```json
+{
+  "mcpServers": {
+    "cm-cli": {
+      "command": "node",
+      "args": [
+        "/absolute/path/to/cm-cli/src/mcp/src/index.js"
+      ]
+    }
+  }
+}
+```
+
+4. 重启 Cursor
+
+### 在 Claude Desktop 中配置
+
+在 Claude Desktop 的配置文件中添加：
+
+```json
+{
+  "mcpServers": {
+    "cm-cli": {
+      "command": "node",
+      "args": ["/path/to/cm-cli/src/mcp/src/index.js"]
+    }
+  }
+}
+```
+
+## 测试
+
+运行测试脚本：
+
+```bash
+cd src/mcp
+node test-mcp.js
+```
+
+## 使用示例
+
+详细的使用示例请查看 [USAGE_EXAMPLES.md](./USAGE_EXAMPLES.md)
+
+## 项目结构
+
+```
+src/mcp/
+├── src/
+│   ├── index.js      # MCP 服务器主文件
+│   ├── handlers.js   # 工具处理逻辑
+│   └── schemas.js    # 输入验证
+├── package.json
+├── README.md
+└── test-mcp.js      # 测试脚本
+```
+

package/src/mcp/USAGE_EXAMPLES.md

@@ -0,0 +1,181 @@
+# create-project 工具使用示例
+
+## 工具说明
+
+`create-project` 是 CM CLI MCP 服务器提供的工具，用于快速创建项目。
+
+## 支持的项目类型
+
+1. **移动端 (mobile)**: 使用 Uni-app 模板
+2. **小程序 (miniprogram)**: 使用 Uni-app 模板
+3. **后台管理系统 (admin)**: 使用 Vue2 或 Vue3 模板
+
+## 参数说明
+
+| 参数 | 类型 | 必需 | 说明 |
+|------|------|------|------|
+| `projectName` | string | ✅ | 项目名称，只能包含小写字母、数字和连字符 |
+| `projectType` | string | ✅ | 项目类型：`mobile`、`miniprogram`、`admin` |
+| `vueVersion` | string | ⚠️ | Vue 版本：`Vue2` 或 `Vue3`（仅当 `projectType` 为 `admin` 时必需） |
+| `needESLint` | boolean | ❌ | 是否配置 ESLint，默认为 `true` |
+| `targetPath` | string | ❌ | 目标路径，默认为当前工作目录 |
+
+## 使用示例
+
+### 示例 1: 创建 Vue2 后台管理系统
+
+```json
+{
+  "projectName": "my-admin-app",
+  "projectType": "admin",
+  "vueVersion": "Vue2",
+  "needESLint": true
+}
+```
+
+**在 Cursor 中使用**:
+```
+请使用 create-project 工具创建一个名为 "my-admin-app" 的后台管理系统项目，
+使用 Vue2，并配置 ESLint。
+```
+
+### 示例 2: 创建 Vue3 后台管理系统（不配置 ESLint）
+
+```json
+{
+  "projectName": "my-vue3-app",
+  "projectType": "admin",
+  "vueVersion": "Vue3",
+  "needESLint": false
+}
+```
+
+**在 Cursor 中使用**:
+```
+请创建一个名为 "my-vue3-app" 的 Vue3 后台管理系统项目，不配置 ESLint。
+```
+
+### 示例 3: 创建移动端项目
+
+```json
+{
+  "projectName": "my-mobile-app",
+  "projectType": "mobile",
+  "needESLint": true
+}
+```
+
+**在 Cursor 中使用**:
+```
+请创建一个名为 "my-mobile-app" 的移动端项目。
+```
+
+### 示例 4: 创建小程序项目
+
+```json
+{
+  "projectName": "my-miniprogram",
+  "projectType": "miniprogram",
+  "needESLint": false
+}
+```
+
+**在 Cursor 中使用**:
+```
+请创建一个名为 "my-miniprogram" 的小程序项目，不配置 ESLint。
+```
+
+### 示例 5: 指定目标路径
+
+```json
+{
+  "projectName": "my-project",
+  "projectType": "admin",
+  "vueVersion": "Vue2",
+  "targetPath": "/path/to/projects"
+}
+```
+
+## 返回结果
+
+成功创建项目后，会返回：
+
+```json
+{
+  "success": true,
+  "message": "项目创建成功！\n\ncd my-project\npnpm install\npnpm run lint\npnpm run dev",
+  "projectPath": "/absolute/path/to/my-project",
+  "templateName": "Vue2",
+  "startCommands": "cd my-project\npnpm install\npnpm run lint\npnpm run dev"
+}
+```
+
+## 错误处理
+
+### 错误 1: 项目名称格式不正确
+
+```json
+{
+  "success": false,
+  "error": "项目名称只能包含小写字母、数字和连字符"
+}
+```
+
+**解决方案**: 确保项目名称只包含小写字母、数字和连字符（如：`my-project-123`）
+
+### 错误 2: 后台管理系统缺少 Vue 版本
+
+```json
+{
+  "success": false,
+  "error": "后台管理系统需要指定Vue版本"
+}
+```
+
+**解决方案**: 当 `projectType` 为 `admin` 时，必须提供 `vueVersion` 参数
+
+### 错误 3: 目录已存在
+
+```json
+{
+  "success": false,
+  "error": "目录已存在: /path/to/project"
+}
+```
+
+**解决方案**: 选择不同的项目名称或删除已存在的目录
+
+### 错误 4: 模板不存在
+
+```json
+{
+  "success": false,
+  "error": "模板不存在: /path/to/template"
+}
+```
+
+**解决方案**: 检查模板目录是否存在，或联系管理员
+
+## 常见问题
+
+### Q: 项目名称可以使用大写字母吗？
+A: 不可以。项目名称只能包含小写字母、数字和连字符。
+
+### Q: 可以在已存在的目录中创建项目吗？
+A: 不可以。目标目录必须不存在，否则会返回错误。
+
+### Q: ESLint 配置是必需的吗？
+A: 不是。可以通过设置 `needESLint: false` 来跳过 ESLint 配置。
+
+### Q: 创建的项目在哪里？
+A: 默认在当前工作目录下创建。可以通过 `targetPath` 参数指定其他路径。
+
+## 下一步
+
+项目创建成功后，按照返回的启动命令操作：
+
+1. 进入项目目录：`cd project-name`
+2. 安装依赖：`pnpm install`
+3. （如果配置了 ESLint）运行代码检查：`pnpm run lint`
+4. 启动开发服务器：`pnpm run dev` 或 `pnpm run dev:h5`
+

package/src/mcp/get-cursor-config.js

@@ -0,0 +1,58 @@
+#!/usr/bin/env node
+
+/**
+ * 生成 Cursor MCP 配置脚本
+ * 运行此脚本可以获取当前项目的 MCP 配置
+ */
+
+import { fileURLToPath } from "url";
+import { dirname, resolve } from "path";
+import fs from "fs";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+// 获取 MCP 服务器的绝对路径
+const mcpServerPath = resolve(__dirname, "src/index.js");
+
+// 生成配置
+const config = {
+  mcpServers: {
+    "cm-cli": {
+      command: "node",
+      args: [mcpServerPath],
+    },
+  },
+};
+
+console.log("\n=== Cursor MCP 配置 ===\n");
+console.log("请将以下配置添加到 Cursor 的 MCP 设置中：\n");
+console.log(JSON.stringify(config, null, 2));
+console.log("\n=== 配置路径信息 ===\n");
+console.log(`MCP 服务器路径: ${mcpServerPath}`);
+console.log(`\n验证路径是否存在: ${fs.existsSync(mcpServerPath) ? "✓ 存在" : "✗ 不存在"}`);
+
+// 检查依赖是否已安装
+const nodeModulesPath = resolve(__dirname, "node_modules", "@modelcontextprotocol", "sdk");
+const depsInstalled = fs.existsSync(nodeModulesPath);
+console.log(`\n依赖是否已安装: ${depsInstalled ? "✓ 已安装" : "✗ 未安装"}`);
+
+if (!depsInstalled) {
+  console.log("\n⚠️  警告: 依赖未安装，请先运行: pnpm install");
+}
+
+// 根据操作系统显示配置文件位置
+const os = process.platform;
+let configPath = "";
+
+if (os === "win32") {
+  configPath = "%APPDATA%\\Cursor\\User\\globalStorage\\cursor.mcp\\settings.json";
+} else if (os === "darwin") {
+  configPath = "~/Library/Application Support/Cursor/User/globalStorage/cursor.mcp/settings.json";
+} else {
+  configPath = "~/.config/Cursor/User/globalStorage/cursor.mcp/settings.json";
+}
+
+console.log(`\n配置文件位置: ${configPath}`);
+console.log("\n详细配置说明请查看: src/mcp/CURSOR_SETUP.md\n");
+

package/src/mcp/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "cm-cli-mcp",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "src/index.js",
+  "bin": {
+    "cm-mcp": "./src/index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "get-config": "node get-cursor-config.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "CM CLI MCP server - 提供快速创建项目和查看项目结构的能力",
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.17.5"
+  },
+  "devDependencies": {
+    "@modelcontextprotocol/inspector": "^0.16.6"
+  }
+}