@ai-partner/ai-partner-prd/README.md

PRD MCP Server for Cursor - 为 Cursor 终端大模型提供 PRD 相关提示词的 MCP Server

# PRD MCP Server

这是一个为 Cursor 终端大模型提供 PRD 相关提示词的 MCP Server。

## 安装

从 npm 安装：

```bash
npm install -g @ai-partner/ai-partner-prd
```

或者本地开发安装：

```bash
npm install
```

或者直接使用 npx（无需安装）：

```bash
npx @ai-partner/ai-partner-prd
```

## 使用

### 作为全局命令使用

```bash
ai-partner-prd
```

### 使用 npx 运行

```bash
npx @ai-partner/ai-partner-prd
```

### 本地开发启动

```bash
npm start
```

## 功能

MCP Server 提供以下 8 个工具：

### 1. init_prompt
- **描述**: 获取初始化提示词
- **参数**: 无
- **文件路径**: `.cursor/rules/prd/initialization.mdc`
- **功能**: 从服务端获取初始化相关的提示词内容

### 2. prd_document_prompt
- **描述**: 获取产品PRD文档编写的提示词
- **参数**: filePath (文件路径)
- **功能**: 根据传入的文件路径获取对应的PRD文档编写提示词

### 3. diagram_prompt
- **描述**: 获取图形类的提示词
- **参数**: filePath (文件路径)
- **功能**: 根据传入的文件路径获取对应的图形类提示词

### 4. quality_check_prompt
- **描述**: 获取质量检查提示词
- **参数**: 无
- **文件路径**: `.cursor/rules/prd/prd-quality-check-report.mdc`
- **功能**: 获取质量检查相关的提示词内容

### 5. summary_prompt
- **描述**: 获取总结提示词
- **参数**: 无
- **文件路径**: `.cursor/rules/prd/prd-progress-summary-report.mdc`
- **功能**: 获取总结相关的提示词内容

### 6. next_step_prompt
- **描述**: 获取下一步建议的提示词
- **参数**: 无
- **文件路径**: `.cursor/rules/prd/prd-design-thinking-methods.mdc`
- **功能**: 获取下一步建议的提示词内容

### 7. generate_spec_doc_command
- **描述**: 获取生成功能规格说明书的指令内容
- **参数**: 无
- **文件路径**: `.cursor/rules/prd/prd-design-thinking-methods.mdc`
- **触发条件**: 用户输入 `/生成功能规格说明书` 时调用
- **功能**: 先查看指令内容，再根据指令获取对应的提示词进行生成

### 8. help_guide
- **描述**: 获取 PRD MCP 工具使用指南
- **参数**: 无
- **文件路径**: `.cursor/rules/prd/prd-help-guide.mdc`
- **功能**: 帮助大模型了解如何正确使用这个 MCP 的各种工具

## 依赖

- Node.js 环境
- 需要设置环境变量 `API_KEY`
- 远程服务运行在 `http://218.244.139.170:8080`

## 配置

### mcp-server.json 配置文件
```json
{
  "baseUrl": "http://218.244.139.170:8080",
  "toolFilePaths": {
    "init_prompt": ".cursor/rules/prd/initialization.mdc",
    "next_step_prompt": ".cursor/rules/prd/prd-design-thinking-methods.mdc",
    "generate_spec_doc_command": ".cursor/rules/prd/prd-design-thinking-methods.mdc",
    "quality_check_prompt": ".cursor/rules/prd/prd-quality-check-report.mdc",
    "summary_prompt": ".cursor/rules/prd/prd-progress-summary-report.mdc",
    "help_guide": ".cursor/rules/prd/prd-help-guide.mdc"
  }
}
```

## MCP Server 配置

### 在 Cursor 中配置 MCP Server

在 Cursor 的配置文件中添加以下配置。配置文件通常位于：
- **Windows**: `%APPDATA%\Cursor\User\settings.json`
- **macOS**: `~/Library/Application Support/Cursor/User/settings.json`
- **Linux**: `~/.config/Cursor/User/settings.json`

或者在 Cursor 中按 `Ctrl/Cmd + ,` 打开设置，搜索 "mcp" 找到 MCP 配置选项。

#### 方式一：使用全局安装的包

首先全局安装包：
```bash
npm install -g @ai-partner/ai-partner-prd
```

然后在 Cursor 配置中添加：
```json
{
  "mcpServers": {
    "ai-partner-prd": {
      "command": "ai-partner-prd",
      "env": {
        "API_KEY": "your_api_key_here"
      }
    }
  }
}
```

#### 方式二：使用 npx（推荐，无需全局安装）

```json
{
  "mcpServers": {
    "ai-partner-prd": {
      "command": "npx",
      "args": ["@ai-partner/ai-partner-prd@latest"],
      "env": {
        "API_KEY": "your_api_key_here"
      }
    }
  }
}
```

#### 方式三：使用本地开发版本
```json
{
  "mcpServers": {
    "ai-partner-prd": {
      "command": "node",
      "args": ["server.js"],
      "cwd": "/path/to/your/project",
      "env": {
        "API_KEY": "your_api_key_here"
      }
    }
  }
}
```

#### Windows 系统配置示例

```json
{
  "mcpServers": {
    "ai-partner-prd": {
      "command": "cmd",
      "args": ["/c", "npx", "@ai-partner/ai-partner-prd"],
      "env": {
        "API_KEY": "your_api_key_here"
      }
    }
  }
}
```

## 快速开始

### 1. 安装包

选择以下任一方式：

```bash
# 全局安装
npm install -g @ai-partner/ai-partner-prd

# 或者使用 npx（推荐，无需安装）
npx @ai-partner/ai-partner-prd
```

### 2. 配置 Cursor

在 Cursor 的设置中添加 MCP Server 配置。**推荐使用 npx 方式**，无需全局安装：

```json
{
  "mcpServers": {
    "ai-partner-prd": {
      "command": "npx",
      "args": ["@ai-partner/ai-partner-prd"],
      "env": {
        "API_KEY": "your_api_key_here"
      }
    }
  }
}
```

更多配置方式请参见下方的详细配置说明。

### 3. 设置 API Key

确保在配置中设置了正确的 `API_KEY` 环境变量

### 4. 重启 Cursor

重启 Cursor 使配置生效

### 5. 开始使用

在 Cursor 中使用相应的工具获取 PRD 相关提示词内容

## 本地开发

如果要进行本地开发：

1. 克隆项目：`git clone [repository-url]`
2. 安装依赖：`npm install`
3. 配置环境变量：设置 `API_KEY`
4. 启动服务：`npm start` 或 `npm run dev`