# 📋 Trae Rules Generator MCP
一个用于自动生成和管理 Trae AI 项目规则文件的 MCP (Model Context Protocol) 服务。
## ✨ 功能特性
- 🔍 **读取现有规则**: 扫描和分析现有的规则文件结构
- 🎯 **智能生成规则**: 根据项目类型和功能特性生成定制化规则
- 💾 **规则文件管理**: 保存、更新和备份规则文件
- 🌐 **多语言支持**: 支持中文和英文规则生成
- 🔧 **灵活配置**: 支持自定义规则路径和文件名
## 🚀 快速开始
### 环境要求
- Python 3.8+
- pip 或 uv 包管理器
### 安装依赖
```bash
# 使用 uv (推荐)
uv sync
# 或使用 pip
pip install -e .
```
### 启动服务
```bash
# 方式一：直接运行 Python 脚本
python main.py
# 方式二：使用 uvicorn
uvicorn main:app --host 0.0.0.0 --port 8080 --reload
```
## 🛠️ MCP 工具
### 1. read_existing_rules
读取现有的规则文件内容和结构信息。
**参数:**
- `rules_path` (str, 可选): 规则文件目录路径，默认为 `.trae/rules`
**返回:**
- 规则文件的详细信息，包括文件列表、内容预览等
### 2. generate_project_rules
根据项目类型和功能特性生成新的项目规则文件。
**参数:**
- `project_type` (str): 项目类型 (如: web, mobile, ai, backend, frontend)
- `features` (List[str]): 项目功能特性列表 (如: ["authentication", "database", "api"])
- `language` (str, 可选): 规则文件语言，默认为中文
**返回:**
- 生成的规则文件内容 (Markdown 格式)
### 3. save_rules_file
保存规则文件到指定目录。
**参数:**
- `content` (str): 规则文件内容
- `filename` (str, 可选): 文件名，默认为 `project_rules.md`
- `rules_path` (str, 可选): 规则文件目录路径，默认为 `.trae/rules`
**返回:**
- 保存操作的结果信息
### 4. update_existing_rules
更新现有的规则文件内容。
**参数:**
- `file_path` (str): 要更新的规则文件路径
- `updates` (Dict[str, Any]): 更新内容的字典
**返回:**
- 更新操作的结果信息
## 📁 项目结构
```
trae-rules-mcp/
├── main.py # MCP 服务主文件
├── pyproject.toml # 项目配置文件
├── README.md # 项目说明文档
└── .gitignore # Git 忽略文件
```
## 🔧 配置说明
### 默认规则路径
服务默认在 `.trae/rules` 目录下查找和保存规则文件。你可以通过工具参数自定义路径。
### 支持的项目类型
- `web` / `frontend`: 前端 Web 项目
- `backend` / `api`: 后端 API 项目
- `ai`: AI/机器学习项目
- `mobile`: 移动应用项目
- 其他自定义类型
### 支持的功能特性
- `authentication`: 用户认证
- `database`: 数据库操作
- `api`: API 接口
- 其他自定义特性
## 🤝 贡献指南
1. Fork 本仓库
2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 打开 Pull Request
## 📄 许可证
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
## 🆘 支持
如果你遇到任何问题或有功能建议，请在 [Issues](https://github.com/trae-ai/trae-rules-mcp/issues) 中提出。
Raw data
{
"_id": null,
"home_page": null,
"name": "trae-rules-mcp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "ai, development, generator, mcp, rules, trae",
"author": null,
"author_email": "Trae AI <support@trae.ai>",
"download_url": "https://files.pythonhosted.org/packages/6f/08/8d592684c444b801539219db3cd47d7a5e490f04bb03a858d18f0d666162/trae_rules_mcp-1.0.1.tar.gz",
"platform": null,
"description": "# \ud83d\udccb Trae Rules Generator MCP\n\n\u4e00\u4e2a\u7528\u4e8e\u81ea\u52a8\u751f\u6210\u548c\u7ba1\u7406 Trae AI \u9879\u76ee\u89c4\u5219\u6587\u4ef6\u7684 MCP (Model Context Protocol) \u670d\u52a1\u3002\n\n## \u2728 \u529f\u80fd\u7279\u6027\n\n- \ud83d\udd0d **\u8bfb\u53d6\u73b0\u6709\u89c4\u5219**: \u626b\u63cf\u548c\u5206\u6790\u73b0\u6709\u7684\u89c4\u5219\u6587\u4ef6\u7ed3\u6784\n- \ud83c\udfaf **\u667a\u80fd\u751f\u6210\u89c4\u5219**: \u6839\u636e\u9879\u76ee\u7c7b\u578b\u548c\u529f\u80fd\u7279\u6027\u751f\u6210\u5b9a\u5236\u5316\u89c4\u5219\n- \ud83d\udcbe **\u89c4\u5219\u6587\u4ef6\u7ba1\u7406**: \u4fdd\u5b58\u3001\u66f4\u65b0\u548c\u5907\u4efd\u89c4\u5219\u6587\u4ef6\n- \ud83c\udf10 **\u591a\u8bed\u8a00\u652f\u6301**: \u652f\u6301\u4e2d\u6587\u548c\u82f1\u6587\u89c4\u5219\u751f\u6210\n- \ud83d\udd27 **\u7075\u6d3b\u914d\u7f6e**: \u652f\u6301\u81ea\u5b9a\u4e49\u89c4\u5219\u8def\u5f84\u548c\u6587\u4ef6\u540d\n\n## \ud83d\ude80 \u5feb\u901f\u5f00\u59cb\n\n### \u73af\u5883\u8981\u6c42\n\n- Python 3.8+\n- pip \u6216 uv \u5305\u7ba1\u7406\u5668\n\n### \u5b89\u88c5\u4f9d\u8d56\n\n```bash\n# \u4f7f\u7528 uv (\u63a8\u8350)\nuv sync\n\n# \u6216\u4f7f\u7528 pip\npip install -e .\n```\n\n### \u542f\u52a8\u670d\u52a1\n\n```bash\n# \u65b9\u5f0f\u4e00\uff1a\u76f4\u63a5\u8fd0\u884c Python \u811a\u672c\npython main.py\n\n# \u65b9\u5f0f\u4e8c\uff1a\u4f7f\u7528 uvicorn\nuvicorn main:app --host 0.0.0.0 --port 8080 --reload\n```\n\n## \ud83d\udee0\ufe0f MCP \u5de5\u5177\n\n### 1. read_existing_rules\n\n\u8bfb\u53d6\u73b0\u6709\u7684\u89c4\u5219\u6587\u4ef6\u5185\u5bb9\u548c\u7ed3\u6784\u4fe1\u606f\u3002\n\n**\u53c2\u6570:**\n- `rules_path` (str, \u53ef\u9009): \u89c4\u5219\u6587\u4ef6\u76ee\u5f55\u8def\u5f84\uff0c\u9ed8\u8ba4\u4e3a `.trae/rules`\n\n**\u8fd4\u56de:**\n- \u89c4\u5219\u6587\u4ef6\u7684\u8be6\u7ec6\u4fe1\u606f\uff0c\u5305\u62ec\u6587\u4ef6\u5217\u8868\u3001\u5185\u5bb9\u9884\u89c8\u7b49\n\n### 2. generate_project_rules\n\n\u6839\u636e\u9879\u76ee\u7c7b\u578b\u548c\u529f\u80fd\u7279\u6027\u751f\u6210\u65b0\u7684\u9879\u76ee\u89c4\u5219\u6587\u4ef6\u3002\n\n**\u53c2\u6570:**\n- `project_type` (str): \u9879\u76ee\u7c7b\u578b (\u5982: web, mobile, ai, backend, frontend)\n- `features` (List[str]): \u9879\u76ee\u529f\u80fd\u7279\u6027\u5217\u8868 (\u5982: [\"authentication\", \"database\", \"api\"])\n- `language` (str, \u53ef\u9009): \u89c4\u5219\u6587\u4ef6\u8bed\u8a00\uff0c\u9ed8\u8ba4\u4e3a\u4e2d\u6587\n\n**\u8fd4\u56de:**\n- \u751f\u6210\u7684\u89c4\u5219\u6587\u4ef6\u5185\u5bb9 (Markdown \u683c\u5f0f)\n\n### 3. save_rules_file\n\n\u4fdd\u5b58\u89c4\u5219\u6587\u4ef6\u5230\u6307\u5b9a\u76ee\u5f55\u3002\n\n**\u53c2\u6570:**\n- `content` (str): \u89c4\u5219\u6587\u4ef6\u5185\u5bb9\n- `filename` (str, \u53ef\u9009): \u6587\u4ef6\u540d\uff0c\u9ed8\u8ba4\u4e3a `project_rules.md`\n- `rules_path` (str, \u53ef\u9009): \u89c4\u5219\u6587\u4ef6\u76ee\u5f55\u8def\u5f84\uff0c\u9ed8\u8ba4\u4e3a `.trae/rules`\n\n**\u8fd4\u56de:**\n- \u4fdd\u5b58\u64cd\u4f5c\u7684\u7ed3\u679c\u4fe1\u606f\n\n### 4. update_existing_rules\n\n\u66f4\u65b0\u73b0\u6709\u7684\u89c4\u5219\u6587\u4ef6\u5185\u5bb9\u3002\n\n**\u53c2\u6570:**\n- `file_path` (str): \u8981\u66f4\u65b0\u7684\u89c4\u5219\u6587\u4ef6\u8def\u5f84\n- `updates` (Dict[str, Any]): \u66f4\u65b0\u5185\u5bb9\u7684\u5b57\u5178\n\n**\u8fd4\u56de:**\n- \u66f4\u65b0\u64cd\u4f5c\u7684\u7ed3\u679c\u4fe1\u606f\n\n## \ud83d\udcc1 \u9879\u76ee\u7ed3\u6784\n\n```\ntrae-rules-mcp/\n\u251c\u2500\u2500 main.py # MCP \u670d\u52a1\u4e3b\u6587\u4ef6\n\u251c\u2500\u2500 pyproject.toml # \u9879\u76ee\u914d\u7f6e\u6587\u4ef6\n\u251c\u2500\u2500 README.md # \u9879\u76ee\u8bf4\u660e\u6587\u6863\n\u2514\u2500\u2500 .gitignore # Git \u5ffd\u7565\u6587\u4ef6\n```\n\n## \ud83d\udd27 \u914d\u7f6e\u8bf4\u660e\n\n### \u9ed8\u8ba4\u89c4\u5219\u8def\u5f84\n\n\u670d\u52a1\u9ed8\u8ba4\u5728 `.trae/rules` \u76ee\u5f55\u4e0b\u67e5\u627e\u548c\u4fdd\u5b58\u89c4\u5219\u6587\u4ef6\u3002\u4f60\u53ef\u4ee5\u901a\u8fc7\u5de5\u5177\u53c2\u6570\u81ea\u5b9a\u4e49\u8def\u5f84\u3002\n\n### \u652f\u6301\u7684\u9879\u76ee\u7c7b\u578b\n\n- `web` / `frontend`: \u524d\u7aef Web \u9879\u76ee\n- `backend` / `api`: \u540e\u7aef API \u9879\u76ee\n- `ai`: AI/\u673a\u5668\u5b66\u4e60\u9879\u76ee\n- `mobile`: \u79fb\u52a8\u5e94\u7528\u9879\u76ee\n- \u5176\u4ed6\u81ea\u5b9a\u4e49\u7c7b\u578b\n\n### \u652f\u6301\u7684\u529f\u80fd\u7279\u6027\n\n- `authentication`: \u7528\u6237\u8ba4\u8bc1\n- `database`: \u6570\u636e\u5e93\u64cd\u4f5c\n- `api`: API \u63a5\u53e3\n- \u5176\u4ed6\u81ea\u5b9a\u4e49\u7279\u6027\n\n## \ud83e\udd1d \u8d21\u732e\u6307\u5357\n\n1. Fork \u672c\u4ed3\u5e93\n2. \u521b\u5efa\u529f\u80fd\u5206\u652f (`git checkout -b feature/AmazingFeature`)\n3. \u63d0\u4ea4\u66f4\u6539 (`git commit -m 'Add some AmazingFeature'`)\n4. \u63a8\u9001\u5230\u5206\u652f (`git push origin feature/AmazingFeature`)\n5. \u6253\u5f00 Pull Request\n\n## \ud83d\udcc4 \u8bb8\u53ef\u8bc1\n\n\u672c\u9879\u76ee\u91c7\u7528 MIT \u8bb8\u53ef\u8bc1 - \u67e5\u770b [LICENSE](LICENSE) \u6587\u4ef6\u4e86\u89e3\u8be6\u60c5\u3002\n\n## \ud83c\udd98 \u652f\u6301\n\n\u5982\u679c\u4f60\u9047\u5230\u4efb\u4f55\u95ee\u9898\u6216\u6709\u529f\u80fd\u5efa\u8bae\uff0c\u8bf7\u5728 [Issues](https://github.com/trae-ai/trae-rules-mcp/issues) \u4e2d\u63d0\u51fa\u3002",
"bugtrack_url": null,
"license": "MIT",
"summary": "Trae AI \u89c4\u5219\u6587\u4ef6\u751f\u6210\u5668 MCP \u670d\u52a1 - \u667a\u80fd\u751f\u6210\u9879\u76ee\u5f00\u53d1\u89c4\u5219",
"version": "1.0.1",
"project_urls": {
"Documentation": "https://github.com/trae-ai/trae-rules-mcp#readme",
"Homepage": "https://github.com/trae-ai/trae-rules-mcp",
"Issues": "https://github.com/trae-ai/trae-rules-mcp/issues",
"Repository": "https://github.com/trae-ai/trae-rules-mcp"
},
"split_keywords": [
"ai",
" development",
" generator",
" mcp",
" rules",
" trae"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "659a39c2d2dda824ccedaee397449bdab9e0db969fa79e87e3d139ea5fe4eb88",
"md5": "b36c7befe6d89f8acc5fe0b2502139ef",
"sha256": "fa097da5efc57325bf1cdf67aeffe0d9e07edb4124591856cf26e2850dedfd5a"
},
"downloads": -1,
"filename": "trae_rules_mcp-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b36c7befe6d89f8acc5fe0b2502139ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7146,
"upload_time": "2025-07-17T00:22:59",
"upload_time_iso_8601": "2025-07-17T00:22:59.750110Z",
"url": "https://files.pythonhosted.org/packages/65/9a/39c2d2dda824ccedaee397449bdab9e0db969fa79e87e3d139ea5fe4eb88/trae_rules_mcp-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6f088d592684c444b801539219db3cd47d7a5e490f04bb03a858d18f0d666162",
"md5": "566bba5264033d5e670e14b19df59c3d",
"sha256": "2d33799699d03e61f67efa6ae602d5f220df5c6372bc77595d0087f77fdab334"
},
"downloads": -1,
"filename": "trae_rules_mcp-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "566bba5264033d5e670e14b19df59c3d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 16806,
"upload_time": "2025-07-17T00:23:01",
"upload_time_iso_8601": "2025-07-17T00:23:01.034827Z",
"url": "https://files.pythonhosted.org/packages/6f/08/8d592684c444b801539219db3cd47d7a5e490f04bb03a858d18f0d666162/trae_rules_mcp-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-17 00:23:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "trae-ai",
"github_project": "trae-rules-mcp#readme",
"github_not_found": true,
"lcname": "trae-rules-mcp"
}
JSON
