ai-rule-mcp-server
v0.6.0
Published
AI规则遵守MCP工具服务器 - 64个AI工具:38个编码规范 + 7个监督指导 + 14个智能搜索 + 5个控制台调试工具
Downloads
29
Maintainers
Readme
AI规则遵守MCP工具
为所有支持MCP协议的AI工具设计的规则遵守工具集,提供64个工具函数:38个基础工具 + 7个监督指导工具 + 14个智能搜索工具 + 5个控制台调试工具,让Claude Code在专业指导下生成高质量规则书、开发计划、PR审查和功能请求,并快速检索技术资料和诊断前端问题。
🎯 主要功能
📋 规则遵守提醒(基础功能)
- 智能提醒 - 根据上下文自动提醒相关规则
- 代码检查 - 检测常见的代码问题和规范违反
- 规则管理 - 查看和管理各类编码规范
- 自定义规则 - 添加项目特定的规则
🔍 智能监督指导(核心功能)
- 项目规则书指导 - 监督Claude Code生成专业的开发规范
- 开发计划指导 - 指导创建详细的项目开发计划
- PR审查指导 - 根据风险级别生成针对性审查清单
- 功能请求指导 - 创建结构化的功能需求文档
- 内容质量检查 - 验证文档完整性和准确性
- 改进建议 - 分析现有内容并提出优化建议
- 项目健康检查 - 全面评估项目状况
🔎 智能搜索工具(14个搜索工具)
国际平台(6个):
- 网络搜索 - 支持Google、Bing、百度、搜狗等多引擎搜索
- GitHub搜索 - 搜索代码仓库、Issues、用户等
- StackOverflow搜索 - 快速查找技术问题解决方案
- NPM包搜索 - 搜索和评估NPM包
- 技术文档搜索 - 搜索React、Vue、Node.js等官方文档
- API参考搜索 - 快速查找API文档和使用示例
国内平台(8个):
- 微信开发者文档 - 搜索小程序、公众号、开放平台文档
- CSDN搜索 - 搜索技术博客和问答
- 掘金搜索 - 搜索高质量技术文章
- SegmentFault搜索 - 专业技术问答社区
- 博客园搜索 - 深度技术文章和教程
- 开源中国搜索 - 开源项目和技术资讯
- 阿里云文档 - 阿里云产品和API文档
- 腾讯云文档 - 腾讯云产品和API文档
🐛 控制台调试工具(最新功能)
- 错误监控 - 分析浏览器控制台报错信息,提供解决方案
- 警告检查 - 检查控制台警告,建议修复方案
- 网络诊断 - 诊断HTTP请求错误(404、500等)
- 日志分析 - 智能分析控制台日志模式和潜在问题
- 调试建议 - 根据错误生成系统化调试方案
🤝 AI协作通信(可选功能)
- 协作开关 - 用户可选择开启/关闭协作功能
- 消息通信 - AI之间可以发送协作消息
- 状态同步 - 查看协作伙伴的工作状态
🚀 快速开始
⚡ 一键安装 (推荐)
# 🎯 官方安装方式 (申请中)
claude mcp add ai-rule-mcp
# 🔧 临时安装方式
# 方法1: Python包安装
pip install ai-rule-mcp-server
ai-rule-mcp install
# 方法2: 一键脚本
curl -sSL https://raw.githubusercontent.com/adminhuan/Claude-code-codex/main/install.sh | bash
# 方法3: npm包安装
npx ai-rule-mcp-server@latest📋 注意: 我们正在申请加入Anthropic官方MCP目录,届时可以直接使用
claude mcp add ai-rule-mcp安装
🔧 手动安装
# 1. 克隆项目
git clone https://github.com/adminhuan/Claude-code-codex.git
cd Claude-code-codex
# 2. 安装依赖
pip install -r requirements.txt
# 3. 安装到系统
pip install -e .
# 4. 配置MCP
ai-rule-mcp install🎉 开始使用
安装完成后,重启Claude Code即可使用64个AI工具:
🔧 基础工具(38个):
- 规则提醒:
ai_rule_reminder()- 智能规则提醒 - 模式切换:
ai_switch_mode()- 切换工作模式 - 计划管理:
ai_create_plan()- 创建开发计划 - 代码审查:
ai_create_pr()- 创建PR审查 - 合规检查:
ai_check_compliance()- 代码合规检查 - 还有33个其他基础工具...
🎯 监督指导工具(7个):
- 项目规则指导:
ai_guide_project_rules()- 指导生成项目规则书 - 开发计划指导:
ai_guide_development_plan()- 指导创建开发计划 - PR审查指导:
ai_guide_pr_review()- 指导创建PR审查 - 功能请求指导:
ai_guide_feature_request()- 指导创建功能请求 - 内容质量检查:
ai_validate_content()- 验证内容质量 - 改进建议:
ai_suggest_improvements()- 提出改进建议 - 项目健康检查:
ai_project_health_check()- 全面项目评估
🔎 智能搜索工具(14个):
- 网络搜索:
ai_search_web()- 多引擎网络搜索(百度/Google/Bing/搜狗) - GitHub搜索:
ai_search_github()- 搜索GitHub仓库、代码、Issues - StackOverflow搜索:
ai_search_stackoverflow()- 搜索技术问答 - NPM包搜索:
ai_search_npm()- 搜索NPM包和文档 - 技术文档搜索:
ai_search_docs()- 搜索框架官方文档 - API参考搜索:
ai_search_api_reference()- 查找API使用文档 - 微信开发者文档:
ai_search_wechat_docs()- 搜索小程序/公众号文档 - CSDN搜索:
ai_search_csdn()- 搜索CSDN博客和问答 - 掘金搜索:
ai_search_juejin()- 搜索掘金技术文章 - SegmentFault搜索:
ai_search_segmentfault()- 搜索技术问答 - 博客园搜索:
ai_search_cnblogs()- 搜索博客园文章 - 开源中国搜索:
ai_search_oschina()- 搜索开源项目和资讯 - 阿里云文档:
ai_search_aliyun_docs()- 搜索阿里云文档 - 腾讯云文档:
ai_search_tencent_docs()- 搜索腾讯云文档
🐛 控制台调试工具(5个):
- 错误监控:
ai_console_error_monitor()- 分析浏览器控制台错误 - 警告检查:
ai_console_warning_check()- 检查控制台警告 - 网络诊断:
ai_network_error_diagnosis()- 诊断HTTP请求错误 - 日志分析:
ai_console_log_analyzer()- 分析控制台日志 - 调试建议:
ai_debug_suggestion()- 生成调试建议
🛠️ 可用工具
| 工具函数 | 功能说明 | 类型 |
|---------|---------|------|
| ai_rule_reminder() | 智能规则提醒 | 基础功能 |
| ai_check_compliance() | 代码合规检查 | 基础功能 |
| ai_get_rules() | 获取规则清单 | 基础功能 |
| ai_add_custom_rule() | 添加自定义规则 | 基础功能 |
| ai_guide_project_rules() | 项目规则书指导 | 监督指导 |
| ai_guide_development_plan() | 开发计划指导 | 监督指导 |
| ai_guide_pr_review() | PR审查指导 | 监督指导 |
| ai_guide_feature_request() | 功能请求指导 | 监督指导 |
| ai_validate_content() | 内容质量检查 | 监督指导 |
| ai_suggest_improvements() | 改进建议 | 监督指导 |
| ai_project_health_check() | 项目健康检查 | 监督指导 |
| ai_search_web() | 网络搜索 | 搜索工具 |
| ai_search_github() | GitHub搜索 | 搜索工具 |
| ai_search_stackoverflow() | StackOverflow搜索 | 搜索工具 |
| ai_search_npm() | NPM包搜索 | 搜索工具 |
| ai_search_docs() | 技术文档搜索 | 搜索工具 |
| ai_search_api_reference() | API参考搜索 | 搜索工具 |
| ai_enable_collaboration() | 启用协作功能 | 可选功能 |
| ai_send_message() | 发送协作消息 | 可选功能 |
| ai_read_messages() | 读取协作消息 | 可选功能 |
| ai_collaboration_status() | 查看协作状态 | 可选功能 |
📖 使用方式
配置完成后,在支持MCP的AI工具中你可以:
基础功能使用
- 规则提醒: "请提醒我关于Python编码规范"
- 切换工作模式: "切换到Plan模式","切换到PR模式"
- 创建开发计划: "创建一个用户认证功能的开发计划"
- 管理代码审查: "创建一个PR来审查这个功能"
- 提交功能请求: "我建议增加代码格式化规则"
智能搜索使用
国际平台:
- 网络搜索: "搜索React Hooks最佳实践"(默认使用百度)
- GitHub搜索: "在GitHub上搜索Vue3相关的仓库"
- 技术问答: "在StackOverflow上搜索如何解决CORS错误"
- 包管理: "搜索NPM上的日期处理库"
- 文档查询: "搜索React官方文档中关于useEffect的说明"
- API参考: "查找axios的请求配置API文档"
国内平台: 7. 微信文档: "搜索微信小程序一键登录功能" 8. CSDN: "在CSDN上搜索HBuilder开发教程" 9. 掘金: "在掘金上搜索Vue3组合式API最佳实践" 10. SegmentFault: "在SegmentFault上搜索React性能优化" 11. 博客园: "在博客园搜索.NET Core教程" 12. 开源中国: "搜索开源中国的前端开源项目" 13. 阿里云: "搜索阿里云OSS对象存储文档" 14. 腾讯云: "搜索腾讯云COS使用指南"
控制台调试使用
- 错误分析: "分析这个错误:Uncaught TypeError: Cannot read property 'map' of undefined"
- 网络错误: "诊断这个404错误:https://api.example.com/users"
- 警告检查: "帮我看看这个React警告怎么解决"
- 日志分析: "分析我的控制台日志,找出性能问题"
- 调试建议: "我的代码报错了,给我调试建议"
AI工具会自动使用相应的MCP工具来响应你的请求,并提供搜索链接、使用建议和国内镜像站点推荐。
🛠️ 管理命令
# 查看安装状态
ai-rule-mcp status
# 手动启动服务器
ai-rule-mcp start
# 卸载MCP工具
ai-rule-mcp uninstall
# 重新安装
ai-rule-mcp install📁 数据存储
工具会在工作目录创建 .ai_rules/ 目录:
config.yaml- 规则配置文件mode_config.json- 模式配置plans.json- 开发计划数据pull_requests.json- PR数据feature_requests/- 功能请求数据collaboration/- 协作消息存储(如果启用)
🎯 设计特点
- 🎯 主功能突出 - 规则遵守提醒是核心功能
- 🔄 模式化工作 - Normal/Plan/PR/FR四种专门模式
- 🔎 智能搜索 - 6种搜索工具,支持国内外主流平台,特别优化国内网络访问
- 🐛 调试助手 - 5个控制台调试工具,快速诊断和解决前端问题
- 📁 文件化存储 - 轻量级实现,无需数据库
- 🔧 高度可定制 - 支持项目特定的自定义规则
- 🤖 智能化 - AI主动发现问题并提出改进建议
- 🌏 国内优化 - 默认使用百度搜索,提供国内镜像站推荐
- 📚 全面覆盖 - 从开发规范到错误调试,全流程AI辅助
📄 许可证
MIT License - 详见 LICENSE 文件
