article
README
🚀 模式 MCP 服务器
模式 MCP 服务器用于管理 Roo 的自定义操作模式,能提供对模式配置和管理的程序化控制,可有效提升模式管理的效率和灵活性。
🚀 快速开始
模式 MCP 服务器为 Roo 的自定义操作模式管理提供了便捷的程序化控制方式。你可以按照以下步骤快速搭建并使用该服务器。
✨ 主要特性
- 支持完整的 CRUD 操作(创建、读取、更新、删除)自定义模式,方便对模式进行全面管理。
- 使用 Zod 进行架构验证,确保数据的准确性和一致性。
- 具备文件系统监控功能,可实时检测配置更改。
- 采用标准 MCP 错误代码处理,便于快速定位和解决问题。
- 支持原子文件操作,保证文件操作的完整性。
📦 安装指南
# 克隆仓库
git clone https://github.com/mkc909/modes-mcp-server.git
cd modes-mcp-server
# 安装依赖项
npm install
# 构建项目
npm run build
📚 详细文档
配置说明
1. 环境变量
复制 .env.example 到 .env 并根据需要进行调整:
cp .env.example .env
可用的环境变量:
MODES_CONFIG_PATH:自定义模式配置文件路径(默认值:%APPDATA%/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_custom_modes.json)
2. 自定义模式配置
创建一个 JSON 文件用于您的自定义模式配置。查看 examples/modes.example.json 以获取格式:
{
"customModes": [
{
"slug": "example-mode",
"name": "示例模式",
"roleDefinition": "描述该模式的能力和职责的角色定义。",
"groups": [
"read",
["edit", {
"fileRegex": "\\.md$",
"description": "只能编辑 Markdown 文件"
}],
"command",
"other"
],
"customInstructions?: string; // 可选的额外说明
}
]
}
3. MCP 配置
在 MCP 中配置此服务器:
{
"servers": {
"modes-server": {
"url": "http://localhost:3000",
"plugins": ["custom-modes"]
}
},
"tools": {
"custom-modes": {
"server": "modes-server",
"configFile": "%APPDATA%/Code/User/globalStorage/rooveteraryinc.custom-modes/config.json"
}
}
}
开发流程
- 修改
src/中的源代码 - 构建项目:
npm run build
- 启动服务器:
npm start
最佳实践
1. 模式选择
- 根据任务选择合适的模式
- 遵循特定于模式的工作流程
- 使用指定的工具组
2. 模式转换
- 按照自然转换流程进行操作
- 完成当前模式的任务
- 在模式之间保留上下文
3. 配置管理
- 在保存前验证更改
- 保持清晰的角色定义
- 文档记录模式的能力
错误处理
该服务器使用标准 MCP 错误代码:
InvalidParams:输入参数无效或未找到模式MethodNotFound:请求的工具未知InternalError:文件系统错误或其他内部问题
测试说明
参见 TESTING.md 了解全面的测试用例和验证程序。
贡献指南
- 叉克隆仓库
- 创建功能分支
- 提交拉取请求
- 遵循编码标准
📄 许可证
本项目采用 MIT License,详情请参阅 LICENSE。
微信扫一扫