使用说明

项目简介

Cursor Checklist MCP Server 是一个基于 Model Context Protocol (MCP) 实现的服务器，专门为 Cursor 代码编辑器设计。它通过 OpenAI API 提供强大的检查清单生成能力，帮助开发者将复杂任务分解为可执行的步骤，提升 LLM 智能体在代码开发流程中的效率和准确性。

主要功能点

检查清单生成：根据用户提供的任务描述，利用 OpenAI 模型智能生成详细的任务检查清单。
Cursor IDE 集成：无缝集成到 Cursor 编辑器，作为 MCP 服务器扩展 LLM 的能力。
灵活的任务描述：支持自然语言的任务描述，让用户轻松表达需求。
可配置的服务器：提供多种服务器启动方式，适应不同的开发环境和部署需求。

安装步骤

安装 npm 包: 推荐全局安装，方便在任何地方使用 'cursor-mcp-checklist' 命令。

npm install -g cursor-mcp-checklist

或者使用 npx 直接运行：

npx cursor-mcp-checklist

配置 OpenAI API 密钥: 本工具依赖 OpenAI API，您需要设置 API 密钥。可以通过以下方式提供：
- 环境变量 'OPENAI_API_KEY'
- 命令行参数 '--key <YOUR_OPENAI_API_KEY>'
- 首次运行时交互式输入并选择保存到 '.env' 文件

服务器配置

要将此 MCP 服务器集成到 Cursor IDE 中，您需要在 Cursor 的设置中添加新的 MCP 服务器。配置信息如下：

{
  "mcp": {
    "servers": [
      {
        "name": "checklist",  // MCP 服务器名称，可以自定义
        "type": "command",   // 服务器类型，必须设置为 "command"
        "command": "npx -y cursor-mcp-checklist-server" // MCP 服务器启动命令，推荐使用 npx 方式，确保使用最新版本
        // 如果全局安装，可以使用更简洁的命令:
        // "command": "cursor-mcp-checklist-server"
        // 或者指定 Node.js 路径 (如果全局安装位置不在 PATH 中):
        // "command": "node /path/to/global/node_modules/cursor-mcp-checklist/src/mcp-server.js"
      }
    ]
  }
}

配置步骤:

打开 Cursor IDE。
进入 'Settings > Features' 设置页面。
找到 'MCP Servers' 部分，点击 'Add New MCP Server'。
按照上述 JSON 配置信息填写 'Name', 'Type', 和 'Command' 字段。
保存设置并重启 Cursor IDE 使配置生效。

基本使用方法

配置完成后，在 Cursor IDE 的聊天窗口中，可以使用自然语言提示词来触发检查清单生成，例如：

"Create a checklist for implementing authentication in my app"
"Break down the steps to deploy this React application"
"I need a checklist for refactoring this component"
"What steps should I follow to optimize this database query?"

Cursor 的 LLM 智能体会识别出需要生成检查清单的意图，并自动调用配置的 MCP 服务器生成相应的检查清单。

关键词