ryOS开发辅助工具

一个TypeScript MCP服务器,用于在Cursor IDE中辅助ryOS开发,提供代码验证、设计检查和哲学指导等功能。

  • by brunocezarl
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 brunocezarl/ryos-cursor-agent

使用说明

ryOS MCP 代理 🚀

TypeScript MCP 服务器,用于在 Cursor 中辅助 ryOS 开发。

概述

ryOS将怀旧美学(如Mac System 7、Aqua、Windows XP/98)与现代体验相结合。 这个代理提供了关于哲学、模式和应用的综合知识,以及 用于验证代码和设计是否遵循ryOS原则的工具。

要求

  • 本地机器上安装 Node.js 18 或更高版本
  • 使用 npm 或 pnpm 来安装依赖项
  • 带有MCP支持的Cursor集成开发环境(IDE)

安装

git clone https://github.com/brunocezarl/ryos-cursor-agent.git
cd ryos-cursor-agent
npm install
npm run build

发展

npm run dev

生产

npm start

光标连接

  1. 找到MCP配置文件:

    • Windows: %LOCALAPPDATA%\Cursor\User\mcp_servers.json
    • macOS: ~/Library/Application Support/Cursor/User/mcp_servers.json
    • Linux: ~/.config/Cursor/User/mcp_servers.json
  2. 添加 ryOS Agent 配置:

    {
      "mcpServers": {
        "ryos-agent": {
          "command": "node",
          "args": ["/path/to/ryos-mcp-agent/dist/index.js"],
          "env": {}
        }
      }
    }
    

    重要提示: 替换 /path/to/ryos-mcp-agent/ 替换为您的项目的实际路径。

  3. 重启光标 完全加载到新服务器上。

如何使用

配置完成后,在Cursor聊天中使用该代理:

@ryos-agent validate_ryos_code
@ryos-agent get_ryos_philosophy
@ryos-agent check_ryos_design

可用工具

工具 描述
validate_ryos_code 分析TS/TSX/CSS代码片段,并指出其是否遵循ryOS模式
check_ryos_design 验证组件是否符合极简美学原则
get_ryos_philosophy 返回完整的ryOS理念
get_ryos_patterns 列出技术模式和设计模式
get_ryos_apps_guide 描述官方应用及互动方式
get_ryos_example 提供包含最佳实践的示例组件
get_ryos_best_practices 亮点总结建议

使用示例

验证代码

@ryos-agent validate_ryos_code

粘贴您的TSX/TS/CSS代码以进行自动分析。

咨询哲学

@ryos-agent get_ryos_philosophy

视图组件示例

@ryos-agent get_ryos_example

ryOS 哲学

  • 怀旧 + 现代经典美学(Mac System 7、Windows XP风格)与现代技术的结合
  • **全面隐私(或:完全隐私)**100%客户端侧,仅使用localStorage,零服务器存储
  • 相互关联的应用程序应用程序间的状态共享
  • 仅使用Tailwind仅使用 Tailwind CSS 进行样式设置,不使用内联 CSS
  • 流畅的动画响应式过渡效果和微交互

技术栈

  • 前端React + TypeScript
  • 风格Tailwind CSS
  • 坚持不懈localStorage
  • 建筑学单页应用,无专用后端
  • 构建Vite + ESBuild

做出贡献

  1. 为该项目创建分支
  2. 为你的功能创建一个分支git checkout -b feature/new-feature)
  3. 提交您的更改(git commit -m 'Add new feature')
  4. 推送到分支(git push origin feature/new-feature)
  5. 提交一个拉取请求

故障排除

代理未出现在光标中

  • 检查路径是否在 mcp_servers.json 是正确的
  • 确认 npm run build 执行无误
  • 完全重启光标(或:重新启动光标功能)
  • 验证以下内容 dist/index.js 文件已存在

连接错误

  • 检查是否已安装 Node.js 18 或更高版本
  • 确认所有依赖项都已安装(npm install)

下一步

  • [ ] 扩展指南,增加更多示例
  • [ ] 包含对特定主题(system7、macosx、xp、win98)的特定检查
  • [ ] 添加与主项目代码检查工具的集成
  • [ ] 支持更多文件类型(JSX、Vue 等)

许可证

MIT 许可证 - 参见 许可证 详情如下。


设计旨在保持ryOS在怀旧与创新之间的平衡。 🎨✨(这个表情符号组合可以翻译为:“🎨”代表艺术或绘画,“✨”代表闪亮或闪耀,但单独翻译时,它们通常不直接转化为中文词汇,而是保留原样以表达特定的情感或氛围。若要简单描述,可以是:“🎨 闪亮的艺术/绘画✨”)