项目简介

PDD (Prompt-Driven Development) 是一个强大的命令行工具,旨在通过利用 AI 模型来简化软件开发流程。它将提示词(prompt)视为开发的核心,能够根据提示词自动生成代码、创建示例、运行单元测试,并管理提示文件。PDD 核心命令 'sync' 可自动化执行整个工作流程,包括依赖注入、代码生成、测试和验证,支持本地或云端执行。

此外,PDD 仓库中包含了一个名为 'pdd-mcp-server' 的 MCP (Model Context Protocol) 服务器组件,允许其他遵循 MCP 协议的 LLM 客户端(如 Cursor, Claude Desktop, Continue.dev)以标准化的方式与 PDD 交互,调用其提供的各项功能和上下文。

主要功能点

  • 提示词驱动开发: 将提示词作为代码的“真相来源”,通过修改提示词而非直接编辑代码来驱动开发和更新。
  • 代码生成与管理: 根据提示词生成多种编程语言的代码,并支持增量更新和代码回溯。
  • 自动化测试与修复: 自动生成单元测试、检测代码缺陷、修复运行时崩溃和逻辑错误。
  • 上下文管理: 自动分析和注入提示词所需的依赖,帮助 LLM 理解项目上下文。
  • 多语言支持: 支持 Python, JavaScript, Java, C++, Ruby, Go 等多种编程语言。
  • 灵活的配置: 支持 '.pddrc' 项目配置和环境变量,满足不同团队和项目的需求。
  • MCP 服务器集成: 提供 JSON-RPC 接口,使 LLM 客户端能够程序化地访问 PDD 的资源、工具和提示词模板。

安装步骤

PDD 是一个命令行工具,推荐使用 'uv' 包管理器安装,或通过 'pip' 安装。

  1. 前置条件 (macOS):

    • 安装 Xcode Command Line Tools: 'xcode-select --install'
    • 安装 Homebrew (推荐): '/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"'
    • 确保 Python 3.8+ 已安装 (通过 Homebrew 安装: 'brew install python')
  2. 推荐方法 (使用 'uv'):

    • 安装 'uv' (如果尚未安装): 'curl -LsSf https://astral.sh/uv/install.sh | sh'
    • 使用 'uv' 安装 PDD CLI: 'uv tool install pdd-cli'
  3. 替代方法 (使用 'pip'):

    • 'pip install pdd-cli'
  4. 验证安装:

    • 'pdd --version'

MCP 服务器配置 (供 MCP 客户端使用)

PDD 仓库中包含了一个名为 'pdd-mcp-server' 的 MCP 服务器组件,位于 'utils/mcp' 目录下。该服务器允许 LLM 客户端通过 JSON-RPC 协议调用 PDD CLI 的各项功能。

MCP 客户端通常需要配置服务器的启动命令和参数才能建立连接。以下是一个示例 JSON 配置,用于指示 MCP 客户端如何启动和连接到 PDD MCP 服务器:

{
  "server_name": "PDD MCP Server",
  "command": "python",
  "args": [
    "path/to/your/pdd/utils/mcp/pdd_mcp_server.py"
  ],
  "description": "启动 PDD MCP 服务器,使 LLM 客户端能够访问 PDD CLI 的功能,例如代码生成、测试和提示词管理。"
}

配置说明:

  • 'server_name': 服务器的显示名称。
  • 'command': 启动 MCP 服务器所需的可执行程序(例如 'python')。
  • 'args': 传递给 'command' 的参数列表。其中 'path/to/your/pdd/utils/mcp/pdd_mcp_server.py' 需要替换为您的系统中 'pdd-cli' 安装目录下 'pdd_mcp_server.py' 脚本的实际路径。
  • 'description': 服务器的简要描述。

注意: MCP 客户端会根据此配置自动启动 PDD MCP 服务器进程,并使用 JSON-RPC 协议与 'pdd_mcp_server.py' 建立通信。您无需手动运行此服务器,只需确保 'pdd_mcp_server.py' 脚本路径正确即可。

基本使用方法

  1. 创建提示文件:

    • 在项目目录下创建 'calculator_python.prompt' 文件,内容例如:
      Create a Python function to add two numbers.
  2. 执行全流程同步 (推荐):

    • 使用 'sync' 命令自动化执行从代码生成到测试的所有步骤。首次运行时可能需要 GitHub 认证。
    • 'pdd --force sync calculator'
  3. 单独生成代码:

    • 'pdd generate --output src/calculator.py prompts/calculator_python.prompt'
  4. 生成示例:

    • 'pdd example --output examples/calculator_example.py prompts/calculator_python.prompt src/calculator.py'
  5. 生成单元测试:

    • 'pdd test --output tests/test_calculator.py prompts/calculator_python.prompt src/calculator.py'
  6. 更新提示文件 (根据代码修改):

    • 如果手动修改了 'src/calculator.py',可以使用 'update' 命令将这些修改同步回 'prompts/calculator_python.prompt'。
    • 'pdd update prompts/calculator_python.prompt src/calculator.py'

信息

分类

开发者工具