Update code
This commit is contained in:
User
153
dev-assistant-mcp/README.md
Normal file
153
dev-assistant-mcp/README.md
Normal file
@@ -0,0 +1,153 @@
|
||||
# Dev Assistant MCP Server v2.0
|
||||
|
||||
**你的电脑 = 全自动代码开发服务器。** 19 个工具覆盖完整开发生命周期，从项目扫描到 Git 提交，全程自动化。无需外部 API Key，Windsurf (Cascade) 自身模型完成所有智能决策。
|
||||
|
||||
## 工作原理
|
||||
|
||||
```
|
||||
你说一句话 → Cascade 自动编排工具链 → 本地执行全部操作 → 返回结果
|
||||
↑ ↓
|
||||
└──── 自动判断：通过? → 完成 / 有错? → 修复再验证 ←────┘
|
||||
```
|
||||
|
||||
**极致闭环**：Cascade 连续多轮调用工具，自动：扫描 → 编码 → 检查 → 修复 → 构建 → 测试 → 提交，直到完美。
|
||||
|
||||
## 19 个工具
|
||||
|
||||
### 🔍 代码分析（4）
|
||||
|
||||
| 工具 | 功能 |
|
||||
|------|------|
|
||||
| `code_review` | 代码审查（安全/性能/风格模式匹配 + 检查清单） |
|
||||
| `code_write` | 代码编写指引（最佳实践 + 框架骨架模板） |
|
||||
| `code_debug` | 调试分析（7 类错误自动分类 + 修复策略） |
|
||||
| `doc_write` | 文档生成（代码结构提取 + 5 种文档模板） |
|
||||
|
||||
### ⚡ 本地执行（6）
|
||||
|
||||
| 工具 | 功能 |
|
||||
|------|------|
|
||||
| `exec_command` | 执行任意本地 Shell 命令 |
|
||||
| `lint_check` | 代码检查（自动检测 ESLint/tsc/flake8） |
|
||||
| `auto_fix` | 自动修复（Prettier + ESLint --fix + autopep8） |
|
||||
| `run_tests` | 运行测试（自动检测 Jest/Vitest/Pytest） |
|
||||
| `build_project` | 构建项目并捕获编译错误 |
|
||||
| `project_scan` | 扫描项目结构/技术栈/依赖/脚本 |
|
||||
|
||||
### 📁 文件操作（3）
|
||||
|
||||
| 工具 | 功能 |
|
||||
|------|------|
|
||||
| `read_local_file` | 读取本地文件（带行号） |
|
||||
| `write_local_file` | 写入/创建文件（自动创建目录） |
|
||||
| `patch_file` | 精确查找替换（自动纠错修改代码） |
|
||||
|
||||
### 🚀 高级工具（6）
|
||||
|
||||
| 工具 | 功能 |
|
||||
|------|------|
|
||||
| `git_ops` | Git 全套操作（status/diff/add/commit/push/pull/branch/stash/reset） |
|
||||
| `dep_manage` | 依赖管理（安装/更新/删除/安全审计/过时检查） |
|
||||
| `search_code` | 项目内代码搜索（正则/文本/符号/文件名） |
|
||||
| `dev_server` | 开发服务器管理（启动/停止/重启/日志/状态） |
|
||||
| `env_check` | 环境检测（Node/Python/Git 版本/端口/CPU/内存/磁盘） |
|
||||
| `workflow` | 工作流编排（一键执行 CI 流水线，6 种预设 + 自定义） |
|
||||
|
||||
### 📚 资源（3）
|
||||
|
||||
| 资源 | 说明 |
|
||||
|------|------|
|
||||
| 编码规范 | TypeScript / Python 最佳实践 |
|
||||
| 调试指南 | 常见错误模式和排查方法 |
|
||||
| 文档模板 | README、API 文档、CHANGELOG 标准模板 |
|
||||
|
||||
## Workflow 预设流水线
|
||||
|
||||
| 预设 | 步骤 | 适用场景 |
|
||||
|------|------|---------|
|
||||
| `full_check` | scan → lint → build → test | 全量质量检查 |
|
||||
| `fix_and_verify` | fix → lint → build → test | 自动修复后验证 |
|
||||
| `pre_commit` | lint → build → test → git status | 提交前检查 |
|
||||
| `ci_simulate` | install → lint → build → test → audit | 模拟 CI 流程 |
|
||||
| `quick_scan` | scan → lint | 快速扫描 |
|
||||
| `deploy_prep` | lint → build → test → git status | 部署前准备 |
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 1. 安装和构建
|
||||
|
||||
```bash
|
||||
cd dev-assistant-mcp
|
||||
npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
### 2. Windsurf 配置
|
||||
|
||||
编辑 `C:\Users\UI\.codeium\windsurf\mcp_config.json`：
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"dev-assistant": {
|
||||
"command": "D:\\Software\\Node\\node.exe",
|
||||
"args": ["C:\\Users\\UI\\Desktop\\bigwo\\dev-assistant-mcp\\dist\\index.js"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
保存后重启 Windsurf。
|
||||
|
||||
### 3. 使用示例
|
||||
|
||||
```
|
||||
"扫描 test2 项目" → project_scan
|
||||
"检查代码质量并自动修复" → lint_check + auto_fix
|
||||
"构建项目，有错自动修" → build_project + code_debug + patch_file
|
||||
"运行全量 CI 流水线" → workflow preset=ci_simulate
|
||||
"搜索所有用到 fetchData 的地方" → search_code
|
||||
"查看 git 状态并提交" → git_ops status → add_all → commit
|
||||
"启动开发服务器" → dev_server start
|
||||
"检查我的开发环境" → env_check
|
||||
"安装 lodash 并审计安全漏洞" → dep_manage add + audit
|
||||
"提交前检查一遍" → workflow preset=pre_commit
|
||||
```
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
dev-assistant-mcp/
|
||||
├── src/
|
||||
│ ├── index.ts # MCP Server 入口（19 工具 + 3 资源）
|
||||
│ ├── tools/
|
||||
│ │ ├── codeReview.ts # 代码审查
|
||||
│ │ ├── codeWrite.ts # 代码编写指引
|
||||
│ │ ├── codeDebug.ts # 调试分析
|
||||
│ │ ├── docWrite.ts # 文档生成
|
||||
│ │ ├── execCommand.ts # 本地命令执行
|
||||
│ │ ├── lintCheck.ts # 代码质量检查
|
||||
│ │ ├── autoFix.ts # 自动修复
|
||||
│ │ ├── runTests.ts # 运行测试
|
||||
│ │ ├── buildProject.ts # 构建项目
|
||||
│ │ ├── projectScan.ts # 项目扫描
|
||||
│ │ ├── fileOps.ts # 文件读写/修改
|
||||
│ │ ├── gitOps.ts # Git 操作
|
||||
│ │ ├── depManage.ts # 依赖管理
|
||||
│ │ ├── searchCode.ts # 代码搜索
|
||||
│ │ ├── devServer.ts # 开发服务器管理
|
||||
│ │ ├── envCheck.ts # 环境检测
|
||||
│ │ └── workflow.ts # 工作流编排
|
||||
│ └── resources/
|
||||
│ ├── codingStandards.ts # 编码规范
|
||||
│ ├── debugGuide.ts # 调试指南
|
||||
│ └── docTemplates.ts # 文档模板
|
||||
├── dist/ # 编译输出
|
||||
├── package.json
|
||||
├── tsconfig.json
|
||||
└── README.md
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user