PRD生成服务

一个基于模型上下文协议(MCP)的服务器,用于通过标准化协议接口生成详细、结构化的产品需求文档。

  • by Saml1211
  • TypeScript
  • 本地部署
  • 36 星标
  • 更新于
在 GitHub 查看 Saml1211/PRD-MCP-Server

使用说明

PRD Creator MCP服务器

专用于创建产品需求文档的专用模型上下文协议(MCP)服务器。该MCP服务器使连接到MCP客户端的AI系统能够通过标准化的协议接口生成详细、结构良好的产品需求文档。


快速开始

通过NPX(推荐):

npx -y prd-creator-mcp

通过Docker:

docker pull saml1211/prd-creator-mcp
docker run -i --rm saml1211/prd-creator-mcp

配置提供程序:

  • 复制 .env.example 向 .env 并设置您的API密钥和首选模型。
  • (可选)在运行时使用更新提供程序凭据 update_provider_config MCP工具。

获取帮助:

npx prd-creator-mcp --help

特性

  • PRD发电机:根据产品描述、用户故事和要求创建完整的PRD
  • 人工智能驱动的一代:使用多个AI提供商生成高质量的PRD
  • 多提供商支持:从OpenAI、Google Gemini、Anthropic Claude或本地模型中选择
  • 提供程序配置:为每一代PRD定制供应商选项
  • 回退机制:当人工智能不可用时,优雅地回归到基于模板的生成
  • PRD验证器:根据行业标准和可定制的规则集验证PRD的完整性
  • 模板资源:访问不同产品类型的PRD模板库
  • MCP协议支持:实现与MCP客户端无缝集成的模型上下文协议

安装

先决条件

  • Node.js v16或更高版本
  • npm或纱线

从源代码安装

  1. 克隆存储库:
git clone https://github.com/Saml1211/prd-mcp-server.git
cd prd-mcp-server
  1. 安装依赖项:
npm install
  1. 构建项目:
npm run build
  1. 在本地运行:
npm start
  1. 对于热重载开发:
npm run dev

api参考

PRD Creator MCP服务器提供以下工具:

generate_prd

使用AI或基于模板的生成生成生成完整的PRD文档。

参数:

  • productName:产品名称
  • productDescription:产品描述
  • targetAudience:目标受众描述
  • coreFeatures:核心特征描述数组
  • constraints (可选):约束或限制数组
  • templateName (可选):要使用的模板名称(默认为“标准”)
  • providerId (可选):要使用的特定AI提供者(openai、anthropic、gemini、local、模板)
  • additionalContext (可选):AI提供者的其他上下文或说明
  • providerOptions (可选):特定于提供商的选项,如温度、maxTokens等。

例子:

{
  "productName": "TaskMaster Pro",
  "productDescription": "A task management application that helps users organize and prioritize their work efficiently.",
  "targetAudience": "Busy professionals and teams who need to manage multiple projects and deadlines.",
  "coreFeatures": [
    "Task creation and management",
    "Priority setting",
    "Due date tracking",
    "Team collaboration"
  ],
  "constraints": [
    "Must work offline",
    "Must support mobile and desktop platforms"
  ],
  "templateName": "comprehensive",
  "providerId": "openai",
  "additionalContext": "Focus on enterprise features and security",
  "providerOptions": {
    "temperature": 0.5,
    "maxTokens": 4000
  }
}

validate_prd

根据最佳实践验证PRD文档。

参数:

  • prdContent:要验证的PRD内容
  • validationRules (可选):要检查的验证规则ID数组

例子:

{
  "prdContent": "# My Product\n\n## Introduction\n...",
  "validationRules": ["has-introduction", "minimum-length"]
}

list_validation_rules

列出所有可用的验证规则。

list_ai_providers

列出所有可用的AI提供商及其可用性状态。

示例响应:

[
  {
    "id": "openai",
    "name": "OpenAI",
    "available": true
  },
  {
    "id": "anthropic",
    "name": "Anthropic Claude",
    "available": false
  },
  {
    "id": "gemini",
    "name": "Google Gemini",
    "available": false
  },
  {
    "id": "local",
    "name": "Local Model",
    "available": false
  },
  {
    "id": "template",
    "name": "Template-based (No AI)",
    "available": true
  }
]

模板管理

服务器提供了用于模板管理的其他工具:

  • create_template:创建新的PRD模板
  • list_templates:列出所有可用模板
  • get_template:获取特定模板
  • update_template:更新现有模板
  • delete_template:删除模板
  • export_templates:将模板导出为JSON
  • import_templates:从JSON导入模板
  • render_template:渲染带有占位符的模板

系统管理

  • get_provider_config:获取当前提供程序配置
  • update_provider_config:更新提供程序配置
  • health_check:检查系统运行状况和提供商可用性
  • get_logs:获取最近的系统日志
  • stats:获取使用统计信息

提供商配置和热重新加载

配置AI提供者

您可以通过两种方式配置提供程序凭据和模型:

  • .env文件: 地点a .env 项目或工作目录中的文件。使用 .env.example 作为模板。所有标准AI提供者变量(例如。, OPENAI_API_KEY, OPENAI_MODEL等等)。
  • 实时协议工具: 在运行时使用更新提供程序配置 update_provider_config 通过您的MCP客户端使用该工具。这些更改将被持久化并立即生效,无需重新启动服务器。

服务器将始终将持久配置(来自协议工具)与环境变量合并,优先进行协议/工具更新。

热重载和自动化

当您使用任一方法更新提供程序设置时,所有新请求的更改都会立即生效。这使得:

  • 通过MCP工具接口实现无缝自动化和脚本编写
  • 无忧的凭证轮换和模型切换
  • 对CI/CD和云部署的动态环境支持

集成

克劳德桌面

增添 claude_desktop_config.json:

{
  "mcpServers": {
    "prd-creator": {
      "command": "npx",
      "args": ["-y", "prd-creator-mcp"]
    }
  }
}

Glama.ai

可用网址:https://glama.ai/mcp/servers/@Saml1211/PRD MCP服务器

光标

添加到您的Cursor MCP客户端配置中:

{
  "mcpServers": {
    "prd-creator": {
      "command": "npx",
      "args": ["-y", "prd-creator-mcp"]
    }
  }
}

Roo代码

增添 .roo/mcp.json:

{
  "mcpServers": {
    "prd-creator-mcp": {
      "command": "npx",
      "args": ["-y", "prd-creator-mcp"]
    }
  }
}

克莱恩

参考 prd-creator-mcp 在您的MCP工作流定义中。

CLI使用情况

全局安装(可选)

您还可以全局安装MCP服务器以公开CLI:

npm install -g prd-creator-mcp

然后运行:

prd-creator-mcp

命令参考

  • prd-creator-mcp 运行MCP服务器(STDIO传输)。 直接通过npx或作为全局安装的CLI使用,以与MCP客户端和工具集成。

卸载

要删除全局CLI,请执行以下操作:

npm uninstall -g prd-creator-mcp

CLI选项

查看可用的命令行选项:

npx prd-creator-mcp --help

码头工人

构建Docker镜像

docker build -t prd-creator-mcp .

使用Docker运行

docker run -i --rm prd-creator-mcp

有环境变量

docker run -i --rm -e OPENAI_API_KEY=your_key_here prd-creator-mcp

贡献

请阅读 贡献.md 和 代码_OF_CONDUCT.md 在提交问题或拉取请求之前。

更新日志

该项目的所有显著变化都记录在 更改日志.md.

附录

实用链接