Cursor Rules Generators

English | 简体中文

一个智能 MCP Server，能够自动分析项目并生成符合项目特点的 Cursor Rules。

🌟 核心功能

自动化分析

• 智能文件扫描：递归扫描项目目录（最多10层），自动排除无关文件
• 技术栈识别：准确识别 20+ 种主流技术栈和框架
• 依赖分析：解析 package.json、requirements.txt 等配置文件
• 模块检测：支持 monorepo、微服务、前后端分离等架构

代码特征分析

• 组件结构识别：自动发现自定义组件和复用模式
• API 路由分析：识别 RESTful API 和路由结构（支持从依赖和文件结构双重检测）
• 状态管理检测：识别 Redux、Vuex、Pinia、Zustand 等状态管理方案
• 样式方案识别：检测 CSS Modules、Tailwind、styled-components 等
• 测试覆盖分析：统计测试文件和测试框架使用情况
• 数据库集成检测：识别 Prisma、TypeORM、Mongoose 等 ORM

智能规则生成

• 全局规则：基于整体技术栈生成通用开发规范
• 模块规则：为不同模块生成专属规则（前端、后端、共享等）
• 最佳实践集成：整合框架官方推荐和社区最佳实践
• 自定义平衡：在项目实际实现与标准实践间找到平衡
• 规则需求分析：智能分析项目需要哪些规则文件，并说明生成原因
• 生成位置确认：自动检测规则文件生成位置，确保符合项目结构

一致性保障

• 文档对比：检查 README 与实际代码的一致性
• 差异提示：友好地提示发现的不一致
• 自动更新：可选的自动更新描述文档功能（需要用户确认）
• 人工确认：重要变更需要用户确认

🚀 快速开始

第一步：配置 Cursor（无需安装！）

推荐方式：使用 npx（自动下载运行，无需手动安装）

找到 Cursor 的 MCP 配置文件：

• macOS/Linux: ~/Library/Application Support/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
• Windows: %APPDATA%\Cursor\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json

添加以下配置：

{
  "mcpServers": {
    "cursor-rules-generators": {
      "command": "npx",
      "args": ["-y", "cursor-rules-generators"]
    }
  }
}

第二步：重启 Cursor

完全退出并重新打开 Cursor，使配置生效。

第三步：生成规则

在 Cursor 的 AI 聊天窗口中，直接说：

请为当前项目生成 Cursor Rules

或者指定项目路径：

请为 /Users/zhangsan/projects/my-app 生成 Cursor Rules

就这么简单！工具会自动：

1. 扫描项目文件
2. 检测技术栈
3. 分析代码特征
4. 生成合适的规则
5. 保存到 .cursor/rules/ 目录

📖 其他安装方式

方式二：全局安装（可选）

如果你希望全局安装：

npm install -g cursor-rules-generators

然后配置：

{
  "mcpServers": {
    "cursor-rules-generators": {
      "command": "cursor-rules-generators",
      "disabled": false,
      "alwaysAllow": []
    }
  }
}

方式三：本地安装（可选）

在项目中本地安装：

npm install cursor-rules-generators

然后使用完整路径配置：

{
  "mcpServers": {
    "cursor-rules-generators": {
      "command": "node",
      "args": ["/项目路径/node_modules/cursor-rules-generators/dist/index.js"],
      "disabled": false,
      "alwaysAllow": []
    }
  }
}

🛠️ 可用工具

1. generate_cursor_rules - 生成规则

功能：完整分析项目并生成 Cursor Rules

参数：

• projectPath (必需): 项目根目录的绝对路径
• updateDescription (可选): 是否自动更新描述文件，默认 false
• includeModuleRules (可选): 是否生成模块规则，默认 true

使用示例：

请为当前项目生成 Cursor Rules

2. analyze_project - 分析项目

功能：仅分析项目，不生成规则文件，返回详细的项目信息

参数：

• projectPath (必需): 项目根目录的绝对路径

返回信息：

• 文件统计（总数、类型分布）
• 技术栈详情（语言、框架、依赖）
• 模块结构（类型、路径、职责）
• 代码特征（组件、API、状态管理等）

使用示例：

请分析当前项目的结构和技术栈

3. check_consistency - 一致性检查

功能：检查项目描述文档与实际代码的一致性

参数：

• projectPath (必需): 项目根目录的绝对路径

检查内容：

• README 中的技术栈描述是否准确
• 重要功能是否有文档说明
• 是否存在过时的技术栈描述
• package.json 中的描述是否完整

使用示例：

请检查项目文档与代码的一致性

4. update_project_description - 更新描述

功能：根据实际代码自动更新项目描述文档

参数：

• projectPath (必需): 项目根目录的绝对路径
• descriptionFile (可选): 要更新的文件，默认 README.md

使用示例：

请根据实际代码更新 README

5. validate_rules - 验证规则

功能：验证 Cursor Rules 文件的格式和内容是否正确

参数：

• projectPath (必需): 项目根目录的绝对路径
• validateModules (可选): 是否验证模块目录中的规则文件，默认 true

使用示例：

请验证当前项目的 Cursor Rules 文件

6. preview_rules_generation - 预览生成

功能：预览规则生成过程，列出所有任务、分析结果和需要确认的决策点，不实际生成文件

参数：

• projectPath (必需): 项目根目录的绝对路径

使用示例：

请预览规则生成过程

7. info - 显示信息

功能：显示 MCP 工具信息，包括版本号、日志配置状态、环境变量配置和任何检测到的配置问题

参数：无

使用示例：

显示工具信息

🔄 完整工作流程

1. 收集项目文件（最多10层深度）
   ↓
2. 检测技术栈和依赖
   ↓
3. 识别多模块结构
   ↓
4. 分析代码特征
   ↓
5. 识别路由系统（从依赖和文件结构双重检测）
   ↓
6. 获取最佳实践（通过 Context7，如已配置）
   ↓
7. 分析规则需求（根据依赖、文件结构、配置决定需要哪些规则）
   ↓
8. 检查描述与实现的一致性
   ↓
9. （可选）提示用户更新描述文件
   ↓
10. 确认生成位置（检查目录结构和文件组织）
   ↓
11. 生成全局 + 模块规则（基于需求分析结果）
   ↓
12. 写入 .cursor/rules/*.mdc 文件
   ↓
13. 返回结构化摘要

📁 生成的文件结构

单体项目

你的项目/
├── .cursor/
│   └── rules/
│       ├── global-rules.mdc      # 全局规则
│       ├── code-style.mdc        # 代码风格规则
│       └── architecture.mdc       # 架构规则
├── src/
├── package.json
└── README.md

多模块项目

你的多模块项目/
├── .cursor/
│   └── rules/
│       └── global-rules.mdc      # 全局通用规则
├── frontend/
│   ├── .cursor/
│   │   └── rules/
│   │       └── frontend-rules.mdc   # 前端模块规则
│   └── src/
├── backend/
│   ├── .cursor/
│   │   └── rules/
│   │       └── backend-rules.mdc    # 后端模块规则
│   └── src/
└── shared/
    ├── .cursor/
    │   └── rules/
    │       └── shared-rules.mdc     # 共享模块规则
    └── src/

智能特性：

• ✅ 全局规则放在项目根目录，影响整个项目
• ✅ 模块规则放在各自模块目录，只影响该模块
• ✅ Cursor 根据当前文件位置自动加载相应规则
• ✅ 模块规则可以覆盖全局规则的配置

🎯 支持的技术栈

前端框架

• React, Vue, Angular, Svelte
• Next.js, Nuxt, SvelteKit

后端框架

• Express, Fastify, NestJS, Koa, Hapi
• Django, Flask, FastAPI

编程语言

• JavaScript, TypeScript
• Python, Go, Rust, Java
• PHP, Ruby

状态管理

• Redux / Redux Toolkit
• MobX, Zustand
• Pinia, Vuex
• Recoil, Jotai

UI 库

• Material-UI (@mui)
• Ant Design
• Chakra UI
• Tailwind CSS
• styled-components
• Emotion

测试框架

• Jest, Vitest
• Mocha, Chai
• Cypress, Playwright
• Testing Library

🔧 高级配置

Context7 集成

如果您配置了 Context7 MCP Server，本工具会自动获取最新的官方文档和最佳实践。

配置方法：

1. 安装并配置 Context7 MCP Server
2. 在 Cursor 的 MCP 配置中添加 Context7
3. 重启 Cursor

注意：Context7 是可选的，未配置不影响基本功能。

环境变量配置

日志级别

控制日志详细程度：

# 设置日志级别（DEBUG, INFO, WARN, ERROR, NONE）
export CURSOR_RULES_GENERATOR_LOG_LEVEL=DEBUG

或在 Cursor 配置中设置：

{
  "mcpServers": {
    "cursor-rules-generators": {
      "command": "npx",
      "args": ["-y", "cursor-rules-generators"],
      "env": {
        "CURSOR_RULES_GENERATOR_LOG_LEVEL": "INFO"
      }
    }
  }
}

自定义日志文件位置

export CURSOR_RULES_GENERATOR_LOG_FILE=/path/to/your/logfile.log

调试模式

# 启用调试模式（自动将日志级别设为 DEBUG）
export CURSOR_RULES_GENERATOR_DEBUG=true

日志级别说明：

• DEBUG: 输出所有日志，包括详细的调试信息
• INFO: 输出信息性日志（默认）
• WARN: 仅输出警告和错误
• ERROR: 仅输出错误
• NONE: 不输出任何日志

查看日志

日志会写入文件（不使用 stdout/stderr），以避免干扰 MCP 协议通信。

默认日志位置：

• macOS: ~/Library/Logs/cursor-rules-generators.log
• Windows: %USERPROFILE%\AppData\Local\cursor-rules-generators.log
• Linux/Unix: ~/.local/log/cursor-rules-generators.log

查看日志：

# macOS/Linux
tail -f ~/Library/Logs/cursor-rules-generators.log

# 查看最后 100 行
tail -n 100 ~/Library/Logs/cursor-rules-generators.log

# Windows
Get-Content $env:USERPROFILE\AppData\Local\cursor-rules-generators.log -Tail 100

或使用 info 工具查看日志文件路径：

显示工具信息

🔍 排除的目录

以下目录会被自动排除：

• node_modules, .git
• dist, build, out
• .next, .nuxt
• coverage, .cache
• .vscode, .idea
• __pycache__, .pytest_cache
• venv, env
• target, bin, obj

❓ 常见问题

1. 为什么检测不到某个框架？

可能原因：

• 框架依赖未在 package.json 中声明
• 使用了非标准的项目结构
• 框架名称不在支持列表中

解决方法：

• 确保依赖正确安装
• 手动编辑生成的规则文件
• 提交 Issue 请求支持新框架

2. 生成的规则不符合项目实际情况？

可能原因：

• 项目使用了非常规的架构
• 某些代码特征未被识别

解决方法：

• 使用 analyze_project 查看分析结果
• 手动创建自定义规则文件补充
• 提供反馈帮助改进检测算法

3. 如何处理一致性检查的提示？

建议流程：

1. 先运行 check_consistency 查看具体问题
2. 评估是否真的需要更新文档
3. 如果需要更新，运行 update_project_description
4. 或者手动编辑文档使其准确

4. 规则文件可以提交到版本控制吗？

建议：

• ✅ 提交自定义规则文件

• ❌ 不要提交自动生成的文件

• 在 .gitignore 中添加：

  .cursor/rules/*-rules.mdc
  !.cursor/rules/99-custom-rules.mdc

5. 如何查看日志文件？

使用 info 工具可以查看日志文件路径和状态：

显示工具信息

或者直接查看默认位置的日志文件（见上方"查看日志"部分）。

⚠️ 注意事项

1. 首次生成：首次生成可能需要几秒钟，取决于项目大小
2. 大型项目：超大型项目（10000+ 文件）可能需要更长时间
3. 覆盖规则：再次生成会覆盖现有的规则文件
4. 手动编辑：建议将自定义规则放在独立文件中，避免被覆盖
5. Context7：Context7 集成是可选的，未配置不影响基本功能
6. 日志输出：日志会写入文件，不会干扰 MCP 协议通信

🤝 贡献指南

我们欢迎所有形式的贡献！

报告问题

• 使用 GitHub Issues 报告问题
• 提供详细的复现步骤
• 附上项目的 package.json（脱敏后）

提交代码

1. Fork 项目
2. 创建特性分支 (git checkout -b feature/amazing-feature)
3. 提交更改 (git commit -m 'Add amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 开启 Pull Request

开发环境设置

# 克隆仓库
git clone https://github.com/ALvinCode/cursor-rules-generators.git
cd cursor-rules-generators

# 安装依赖
pnpm install

# 开发模式（自动重新编译）
pnpm run watch

# 运行测试
pnpm test

📄 许可证

MIT License - 详见 LICENSE 文件

🙏 致谢

• Cursor 团队提供的 MCP 框架
• Context7 提供的文档集成方案
• 所有贡献者和使用者

📮 联系方式

• Issues: GitHub Issues
• 仓库: GitHub Repository

如果这个工具对您有帮助，请给我们一个 ⭐️！