使用说明

项目简介

Piddie 是一个开源的 AI 驱动开发环境,旨在革新软件开发工作流程。它基于 Model Context Protocol (MCP) 构建,充当 MCP 服务器,核心目标是为大型语言模型(LLM)客户端提供标准化的上下文信息和功能,从而创建一个无缝、上下文感知的编码助手,提升开发者生产力。

主要功能点

  • 资源管理: Piddie 托管和管理开发环境中的各种资源,例如项目文件、代码片段等,为 LLM 提供数据访问能力。
  • 工具执行: 注册并执行各种工具,例如文件系统操作、代码构建工具等,允许 LLM 通过标准接口调用外部功能,实现与开发环境的交互。
  • Prompt 模板: 支持定义和渲染 Prompt 模板,允许开发者定制与 LLM 的交互模式,优化 Prompt 效果。
  • 开放、可定制、可扩展: Piddie 致力于构建开源工具,允许用户自定义和扩展其功能,支持从项目构思到持续开发的完整流程。
  • 多种传输协议支持: Piddie 的 MCP 服务器支持多种传输协议,例如 Stdio,为不同的 LLM 客户端提供灵活的连接方式。

安装步骤

  1. 克隆仓库

    git clone https://github.com/mrsimpson/piddie.git
    cd piddie
  2. 安装依赖

    确保已安装 Node.js (v18+) 和 pnpm。然后运行:

    pnpm install
  3. 运行开发模式

    启动 Piddie 开发服务器:

    pnpm dev

服务器配置

Piddie 本身即为 MCP 服务器,无需额外配置服务器端。对于需要连接到 Piddie MCP 服务器的 MCP 客户端,您需要配置客户端以连接到 Piddie 的开发环境。以下是一个典型的 MCP 客户端配置示例 (JSON 格式),用于连接到本地运行的 Piddie 开发服务器:

{
  "serverName": "piddie-server",  // MCP 服务器名称,可自定义
  "command": "pnpm",             // 启动 MCP 服务器的命令,这里使用 pnpm
  "args": ["dev"]                // 启动命令的参数,这里使用 pnpm dev 启动 Piddie 的开发服务器
  // "transport": "stdio"        // (可选) 指定传输协议,如果 Piddie 使用 Stdio 协议,可以显式指定,默认可能为 Stdio 或 WebSocket,具体取决于 Piddie 的实现和客户端支持
}

基本使用方法

  1. 启动 Piddie 开发环境 ('pnpm dev') 后,MCP 服务器将在后台运行。
  2. 配置您的 MCP 客户端,使用上述提供的服务器配置信息连接到 Piddie 服务器。
  3. 您可以通过 MCP 客户端与 Piddie 服务器进行交互,利用 Piddie 提供的资源、工具和 Prompt 模板进行 AI 辅助的软件开发。
  4. 详细的架构文档和项目组件信息请参考仓库中的 'README.md' 和 'docs' 目录。

注意: Piddie 尚处于开发早期阶段,具体功能和使用方式可能会有所变化,请参考仓库的最新文档。

信息

分类

开发者工具