PRD Creator MCP Server

Um servidor MCP especializado para criar Documentos de Requisitos de Produto (PRDs).

GitHub
36

Documentação

PRD Creator MCP Server

Build Status npm version License: MIT GitHub issues

Um servidor especializado do Model Context Protocol (MCP) dedicado à criação de Documentos de Requisitos de Produto. Este servidor MCP permite que sistemas de IA conectados a clientes MCP gerem documentos de requisitos de produto detalhados e bem estruturados por meio de uma interface de protocolo padronizada.

Início Rápido

Via NPX (recomendado):

npx -y prd-creator-mcp

Via Docker:

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

Configurar Provedores:

  • Copie .env.example para .env e defina suas chaves de API e modelos preferidos.
  • Opcionalmente, atualize as credenciais do provedor em tempo de execução usando a ferramenta MCP update_provider_config.

Obter Ajuda:

npx prd-creator-mcp --help

Recursos

  • Gerador de PRD: Crie PRDs completos com base em descrições de produtos, histórias de usuário e requisitos
  • Geração Impulsionada por IA: Gere PRDs de alta qualidade usando múltiplos provedores de IA
  • Suporte a Múltiplos Provedores: Escolha entre OpenAI, Google Gemini, Anthropic Claude ou modelos locais
  • Configuração do Provedor: Personalize as opções do provedor para cada geração de PRD
  • Mecanismo de Fallback: Alterna graciosamente para geração baseada em modelos quando a IA não está disponível
  • Validador de PRD: Valide a completude do PRD em relação aos padrões da indústria e conjuntos de regras personalizáveis
  • Recursos de Modelos: Acesse uma biblioteca de modelos de PRD para diferentes tipos de produto
  • Suporte ao Protocolo MCP: Implementa o Model Context Protocol para integração perfeita com clientes MCP

Instalação

Pré-requisitos

  • Node.js v16 ou superior
  • npm ou yarn

Instalar a partir do código-fonte

  1. Clone o repositório:
git clone https://github.com/Saml1211/prd-mcp-server.git
cd prd-mcp-server
  1. Instale as dependências:
npm install
  1. Compile o projeto:
npm run build
  1. Execute localmente:
npm start
  1. Para desenvolvimento com recarga automática:
npm run dev

Referência da API

O PRD Creator MCP Server fornece as seguintes ferramentas:

generate_prd

Gere um documento de PRD completo usando IA ou geração baseada em modelos.

Parâmetros:

  • productName: O nome do produto
  • productDescription: Descrição do produto
  • targetAudience: Descrição do público-alvo
  • coreFeatures: Matriz de descrições dos recursos principais
  • constraints (opcional): Matriz de restrições ou limitações
  • templateName (opcional): Nome do modelo a ser usado (padrão: "standard")
  • providerId (opcional): Provedor de IA específico a ser usado (openai, anthropic, gemini, local, template)
  • additionalContext (opcional): Contexto adicional ou instruções para o provedor de IA
  • providerOptions (opcional): Opções específicas do provedor, como temperatura, maxTokens, etc.

Exemplo:

{
  "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

Valide um documento de PRD em relação às melhores práticas.

Parâmetros:

  • prdContent: O conteúdo do PRD a ser validado
  • validationRules (opcional): Matriz de IDs de regras de validação a serem verificadas

Exemplo:

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

list_validation_rules

Liste todas as regras de validação disponíveis.

list_ai_providers

Liste todos os provedores de IA disponíveis e seu status de disponibilidade.

Exemplo de resposta:

[
  {
    "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
  }
]

Gerenciamento de Modelos

O servidor fornece ferramentas adicionais para gerenciamento de modelos:

  • create_template: Crie um novo modelo de PRD
  • list_templates: Liste todos os modelos disponíveis
  • get_template: Obtenha um modelo específico
  • update_template: Atualize um modelo existente
  • delete_template: Exclua um modelo
  • export_templates: Exporte modelos para JSON
  • import_templates: Importe modelos de JSON
  • render_template: Renderize um modelo com espaços reservados

Gerenciamento do Sistema

  • get_provider_config: Obtenha a configuração atual do provedor
  • update_provider_config: Atualize a configuração do provedor
  • health_check: Verifique a saúde do sistema e a disponibilidade do provedor
  • get_logs: Obtenha logs recentes do sistema
  • stats: Obtenha estatísticas de uso

Configuração do Provedor e Recarga Automática

Configurando Provedores de IA

Você pode configurar credenciais e modelos de provedores de duas maneiras:

  • Arquivo .env: Coloque um arquivo .env no seu projeto ou diretório de trabalho. Use .env.example como modelo. Todas as variáveis padrão de provedores de IA (por exemplo, OPENAI_API_KEY, OPENAI_MODEL, etc.) são suportadas.
  • Ferramentas de protocolo ao vivo: Atualize a configuração do provedor em tempo de execução usando a ferramenta update_provider_config via seu cliente MCP. Essas alterações são persistidas e entram em vigor imediatamente—sem necessidade de reiniciar o servidor.

O servidor sempre mesclará a configuração persistente (das ferramentas de protocolo) com as variáveis de ambiente, dando precedência às atualizações de protocolo/ferramentas.

Recarga Automática e Automação

Quando você atualiza as configurações do provedor usando qualquer um dos métodos, as alterações entram em vigor instantaneamente para todas as novas solicitações. Isso permite:

  • Automação e script sem interrupções por meio de interfaces de ferramentas MCP
  • Rotação de credenciais e troca de modelos sem complicações
  • Suporte a ambientes dinâmicos para CI/CD e implantações em nuvem

Integrações

Claude Desktop

Adicione a claude_desktop_config.json:

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

Glama.ai

Disponível em: https://glama.ai/mcp/servers/@Saml1211/PRD-MCP-Server

Cursor

Adicione à configuração do seu cliente MCP do Cursor:

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

Roo Code

Adicione a .roo/mcp.json:

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

Cline

Referencie prd-creator-mcp nas suas definições de fluxo de trabalho MCP.

Uso via CLI

Instalar Globalmente (opcional)

Você também pode instalar o servidor MCP globalmente para expor a CLI:

npm install -g prd-creator-mcp

Em seguida, execute:

prd-creator-mcp

Referência de Comandos

  • prd-creator-mcp Executa o servidor MCP (transporte STDIO). Use diretamente via npx ou como uma CLI instalada globalmente para integração com clientes e ferramentas MCP.

Desinstalar

Para remover a CLI global:

npm uninstall -g prd-creator-mcp

Opções da CLI

Visualize as opções disponíveis da linha de comando:

npx prd-creator-mcp --help

Docker

Construindo a imagem Docker

docker build -t prd-creator-mcp .

Executando com Docker

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

Com variáveis de ambiente

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

Contribuição

Leia CONTRIBUTING.md e CODE_OF_CONDUCT.md antes de enviar issues ou pull requests.

Changelog

Todas as alterações notáveis neste projeto estão documentadas em CHANGELOG.md.

Apêndice

Links Úteis