README
🚀 PRD 创建器 MCP 服务器
PRD 创建器 MCP 服务器是专门用于创建产品需求文档(PRD)的 Model Context Protocol (MCP) 服务器。它能让连接到 MCP 客户端的 AI 系统,通过标准化协议接口生成详细且结构化的 PRD。
🚀 快速开始
PRD 创建器 MCP 服务器允许与 MCP 客户端集成,用于生成和验证 PRD 文档。通过提供的工具和模板,用户可以高效地创建和管理产品需求。
✨ 主要特性
- PRD 生成器:根据产品描述、用户故事和需求创建完整的 PRD。
- PRD 验证器:根据行业标准和自定义规则集验证 PRD 的完整性。
- 模板资源:访问不同产品类型的 PRD 模板库。
- MCP 协议支持:实现 Model Context Protocol 以与 MCP 客户端无缝集成。
📦 安装指南
先决条件
- Node.js v16 或更高版本
- npm 或 yarn
从源代码安装
- 克隆仓库:
git clone https://github.com/yourusername/prd-creator-mcp.git
cd prd-creator-mcp
- 安装依赖项:
npm install
- 构建项目:
npm run build
💻 使用示例
运行服务器
使用以下命令运行服务器:
npm start
服务器将默认使用 STDIO 传输,这使其与 MCP 客户端兼容。
添加到 MCP 客户端配置
要将 PRD 创建器 MCP 服务器与 MCP 客户端(如 Claude Desktop 或 Cursor)一起使用,请在 MCP 设置中添加它:
对于 macOS 上的 Claude Desktop,在 ~/Library/Application Support/Claude/claude_desktop_config.json 中添加:
{
"mcpServers": {
"prd-creator": {
"command": "node",
"args": ["/path/to/prd-creator-mcp/dist/index.js"],
"disabled": false
}
}
}
可用工具
基础用法
generate_prd
从模板生成完整的 PRD 文档。 参数:
productName:产品名称productDescription:产品的描述targetAudience:目标受众的描述coreFeatures:核心功能描述数组constraints(可选):约束或限制条件数组templateName(可选):要使用的模板名称(默认为“标准”)
{
"productName": "TaskMaster Pro",
"productDescription": "一个任务管理应用程序,帮助用户高效地组织和优先处理工作。",
"targetAudience": "忙碌的专业人士和团队,他们需要管理多个项目和截止日期。",
"coreFeatures": [
"任务创建和管理",
"优先级设置",
"截止日期跟踪",
"团队协作"
],
"constraints": [
"必须支持离线使用",
"必须支持移动和桌面平台"
],
"templateName": "全面"
}
validate_prd
根据最佳实践验证 PRD 文档。 参数:
prdContent:要验证的 PRD 内容validationRules(可选):要检查的有效规则 ID 数组
{
"prdContent": "# 我的产品\n\n## 引言\n...",
"validationRules": ["has-introduction", "minimum-length"]
}
list_validation_rules
列出所有可用的验证规则。
可用资源
服务器通过以下 URI 模式提供对 PRD 模板的访问:
prd://templates/{templateName}可用模板:standard:一个基本的 PRD 模板,包含必要的部分comprehensive:一个详细的 PRD 模板,包含扩展的部分
📚 详细文档
项目结构
prd-creator-mcp/
├── src/
│ ├── config/ # 配置管理
│ ├── storage/ # 数据库和缓存
│ ├── tools/ # 工具实现
│ ├── resources/ # 资源实现
│ └── index.js # 入口文件
├── package.json # 包配置文件
└── README.md # 说明文档
运行测试
在项目根目录中运行以下命令以执行测试:
npm test
📄 许可证
[在此处添加许可证信息]
Scan to contact