README
🚀 🤖 AI 开发助手 MCP 服务器
本项目是一个专为 Cursor 设计的 Model Context Protocol (MCP) 服务器,属于 AI 驱动的开发工具包。它借助自定义 AI 工具,为开发者提供智能编码辅助。不过要注意,这主要是一个教程演示项目,并非可用于生产环境的工具。
🚀 快速开始
环境设置
首先,你需要设置环境变量。创建一个文件 src/env/keys.ts:
export const OPENAI_API_KEY = "your_key_here";
// 添加其他任何所需的密钥
⚠️ 安全注意:直接在源代码中存储 API 密钥在生产环境中不推荐使用。这只是用于本地开发和学习目的。您也可以直接在 Cursor MCP 界面中设置环境变量。
安装
npm install
# 或者
yarn install
构建服务器
npm run build
添加到 Cursor
该项目设计用于作为 Cursor 中的 MCP 服务器。以下是设置方法:
- 打开 Cursor
- 转到
Cursor 设置 > 功能 > MCP - 点击
+ 添加新的 MCP 服务器 - 填写表单:
- 名称:AI 开发助手
- 类型:stdio
- 命令:
node /path/to/your/project/dist/index.js
📘 技巧:您可能需要使用项目构建文件的完整路径。
添加服务器后,您应该会在“可用工具”下看到工具列表。如果没有,请尝试点击 MCP 服务器部分右上角的刷新按钮。
有关更多 MCP 设置的详细信息,请参阅 Cursor MCP 文档。
✨ 主要特性
🎨 代码架构师
调用高级推理 LLM 来生成计划和指令,用于编码代理。
📸 截图 buddy
拍摄 UI 设计截图并将其与作曲家代理一起使用。
🔍 代码审查
使用 git 差分来触发代码审查。
💻 使用示例
配置完成后,您可以直接在 Cursor 的 Composer 中使用这些工具。AI 将会自动建议使用相关工具,或者您可以明确请求工具名称或描述。
例如,在 Composer 中尝试输入:
- “审查此代码的最佳实践”
- “帮助我架构新功能”
- “分析此 UI 截图”
代理将在执行任何工具调用之前询问您的批准。
📘 技巧:您可以在
.cursorrules文件中添加指令,说明在某些情况下如何使用工具,并且代理会自动使用这些工具。
📚 详细文档
项目结构
src/
├── tools/
│ ├── architect.ts # 代码结构生成器
│ ├── screenshot.ts # 截图分析工具
│ └── codeReview.ts # 代码审查工具
├── env/
│ └── keys.ts # 环境配置(在此处添加您的 API 密钥!)
└── index.ts # 入口点
🤝 贡献
欢迎贡献!请随意提交 Pull Request。
📄 许可证
该项目在 MIT 许可证下分发 - 有关详细信息,请参阅 LICENSE 文件。
🐛 问题与支持
发现错误或需要帮助?打开一个 Issues 时,请提供以下信息:
- 您试图完成的操作
- 发生的情况
- 复现步骤
- 环境细节
我必须诚实地说,这是一个教程演示,而不是生产就绪工具,因此我可能不会修复问题。但请随意 Fork 并自行开发!
由开发者为开发者制作,❤️
Scan to contact