关键词

AI辅助开发代码审查架构设计UI分析Cursor插件

使用说明

项目简介

Awesome Cursor MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为 Cursor 代码编辑器提供增强的 AI 开发辅助功能。它通过集成多种实用工具，如代码架构师、截图助手和代码审查工具，帮助开发者提升编码效率和代码质量。请注意，这是一个教程演示项目，可能不适用于生产环境。

主要功能点

  • 代码架构师 (Code Architect): 利用先进的语言模型，根据任务描述和代码内容，生成代码开发步骤和指导，辅助进行代码架构设计和规划。
  • 截图助手 (Screenshot Buddy): 捕获用户界面截图，并支持在其他工具中（如 Composer Agent）使用截图进行分析和处理，例如分析UI设计稿。
  • 代码审查 (Code Review): 通过 Git diff 命令，对比代码变更，并提供代码审查建议，辅助开发者进行代码质量把控。

安装步骤

  1. 环境准备:

    • 确保已安装 Node.js 和 npm 或 yarn。
    • 在 'src/env/keys.ts' 文件中配置所需的环境变量，主要是 OpenAI API Key。请注意，示例代码直接在代码中存储 API Key，仅用于本地开发和学习目的。生产环境请勿如此操作。
    export const OPENAI_API_KEY = "your_key_here";
// 添加其他需要的 API keys

  2. 安装依赖: 打开终端，导航到项目根目录，运行以下命令安装项目依赖。

    npm install
# 或
yarn install

  3. 构建服务器: 运行以下命令构建项目，将 TypeScript 代码编译为 JavaScript。

    npm run build

服务器配置

要将此 MCP 服务器添加到 Cursor 编辑器，请按照以下步骤操作：

  1. 打开 Cursor 编辑器。

  2. 进入 'Cursor 设置 (Settings) > Features > MCP'。

  3. 点击 '+ Add New MCP Server' 添加新的 MCP 服务器。

  4. 填写以下配置信息：

    {
  "name": "AI Development Assistant",  // MCP 服务器名称，用户自定义，在 Cursor 中显示
  "type": "stdio",                     // 连接类型，本项目使用 stdio
  "command": "node",                   // 启动命令，Node.js 解释器
  "args": [                             // 启动参数
    "/path/to/your/project/dist/index.js" //  指向构建后的 index.js 文件路径，请替换为你的实际路径。例如："/Users/yourname/awesome-cursor-mpc-server/dist/index.js"
  ]
}

    请务必将 '/path/to/your/project/dist/index.js' 替换为你的项目 'dist/index.js' 文件的绝对路径。 你可以在终端中导航到 'dist' 目录并使用 'pwd' 命令获取当前路径。

  5. 添加完成后，你应该能在 "Available Tools" 列表中看到 "screenshot", "architect", "code-review" 这三个工具。如果未显示，请点击 MCP 服务器区域右上角的刷新按钮。

基本使用方法

成功配置 MCP 服务器后，你可以在 Cursor 的 Composer 中直接使用这些工具。

  • 在 Composer 中输入自然语言指令，例如：

    • 'Review this code for best practices' (使用代码审查工具)
    • 'Help me architect a new feature' (使用代码架构师工具)
    • 'Analyze this UI screenshot' (使用截图助手工具)

  • AI 助手会自动识别并建议使用相关工具。你也可以通过名称或描述显式请求调用工具。

  • 在工具执行前，AI 助手会请求你的确认。

你还可以通过更新 '.cursorrules' 文件来预设在特定场景下自动使用哪些工具，以实现更智能的自动化工作流程。

项目结构

src/
├── tools/           # 工具代码目录
│   ├── architect.ts    # 代码架构师工具
│   ├── screenshot.ts   # 截图助手工具
│   └── codeReview.ts   # 代码审查工具
├── env/             # 环境变量配置目录
│   └── keys.ts         # 环境变量配置文件 (存放 API keys)
└── index.ts           # 服务器主入口文件

贡献

欢迎提交 Pull Request 参与项目贡献。

许可证

本项目使用 MIT License 开源许可证。

信息

分类

开发者工具

访问项目