使用说明

项目简介

Pipulate 是一个本地优先、单租户的桌面应用程序框架,旨在帮助用户构建和运行由本地大型语言模型(LLM)驱动的AI辅助工作流。它集成了FastHTML、MiniDataAPI和Ollama等技术,提供了一个简单、可观察且可复现的开发和运行环境。虽然Pipulate并非严格意义上的企业级MCP服务器,但其架构和功能使其能够有效地充当一个功能完善的上下文服务后端,符合MCP服务器的核心理念。

主要功能点

  • 本地优先与单租户: 完全在用户本地机器上运行,确保数据隐私和充分利用本地硬件资源,无需云服务依赖。
  • AI辅助工作流: 内置AI辅助的逐步工作流,简化复杂任务,用户无需编写Python代码即可使用。
  • 资源管理: 通过MiniDataAPI和SQLite数据库管理本地资源,支持数据的持久化存储和访问。
  • 工具集成 (通过Ollama): 集成本地Ollama服务器,支持本地LLM的调用,实现工具注册和执行的功能,例如,可以使用本地LLM进行聊天互动和任务自动化。
  • Prompt模板 (工作流): 工作流本身可以被视为Prompt模板的一种形式,通过预定义的步骤和逻辑,定制与LLM的交互模式。
  • 服务器渲染UI: 使用FastHTML和HTMX构建服务器渲染的用户界面,提供动态交互体验,并通过WebSockets和SSE实现实时通信。
  • 可扩展性与可定制性: 插件式架构,允许用户扩展和定制工作流,满足不同的应用需求。
  • 会话管理: 服务器端管理应用程序状态,通过DictLikeDB和JSON blobs实现透明且易于调试的状态管理。
  • 多种传输协议支持: 通过HTTP、WebSockets和SSE等协议与客户端通信。

安装步骤

  1. 安装 Nix 包管理器:

    • macOS 或 Windows (WSL2) 用户,打开终端并运行以下命令:
      curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
    • 按照屏幕提示完成 Nix 的安装。安装完成后,务必关闭并重新打开终端
  2. 克隆 Pipulate 仓库:

    git clone https://github.com/miklevin/pipulate.git
    cd pipulate
  3. 进入开发环境:

    nix develop

    此命令将设置一个包含 Python 和所有必要工具的完整、可复现的开发环境。

  4. 启动 Pipulate 应用: 在 'nix develop' 环境中,运行:

    python server.py

    应用将在浏览器中自动打开 http://localhost:5001

服务器配置

Pipulate 服务器是一个本地应用程序,无需额外的服务器配置

对于 MCP 客户端,您需要配置服务器的启动命令和参数,以便客户端能够连接到 Pipulate 服务器。 由于 Pipulate 是本地运行的,因此客户端配置应指向本地服务器地址。

以下是一个示例 MCP 客户端配置(JSON 格式),用于连接到本地运行的 Pipulate 服务器:

{
  "serverName": "Pipulate Server",
  "command": "python",
  "args": [
    "server.py"
  ],
  "protocol": "ws",
  "host": "localhost",
  "port": 5001,
  "description": "连接到本地 Pipulate 服务器"
}

配置参数说明:

  • 'serverName': MCP 服务器的名称,可以自定义。 (例如: "Pipulate Server")
  • 'command': 启动服务器的命令,这里是 'python'。
  • 'args': 启动命令的参数,这里是 'server.py',表示运行 'server.py' 文件。
  • 'protocol': 使用的通信协议,Pipulate 默认支持 'ws' (WebSocket)。
  • 'host': 服务器主机地址,由于是本地运行,所以设置为 'localhost'。
  • 'port': 服务器端口号,Pipulate 默认端口是 '5001'。
  • 'description': 对该服务器配置的描述,方便用户识别。

请注意:

  • 确保 MCP 客户端和 Pipulate 服务器在同一台机器上运行,或者 MCP 客户端能够访问到运行 Pipulate 服务器的机器。
  • 启动 Pipulate 服务器前,请先按照安装步骤进入 'nix develop' 环境。

基本使用方法

  1. 启动 Pipulate 服务器后,通过浏览器访问 http://localhost:5001 即可使用 Pipulate 的 Web 界面。
  2. 在 Web 界面中,您可以体验预置的工作流,例如 SEO 相关的工作流。
  3. 您可以通过修改 'workflows' 目录下的 Python 文件来定制或扩展工作流。
  4. Pipulate 还集成了聊天界面,可以与本地 Ollama LLM 进行交互,体验 LLM 的上下文感知能力。
  5. 开发者可以参考 README 文档和示例代码,基于 Pipulate 框架构建自己的 AI 辅助桌面应用程序和 MCP 服务器。

对于 MCP 客户端用户:

  • 配置 MCP 客户端连接到 Pipulate 服务器后,客户端可以通过 MCP 协议与 Pipulate 服务器进行通信,利用服务器提供的资源、工具和 Prompt 模板功能。
  • 具体 MCP 客户端的操作方式,请参考 MCP 客户端的文档。

信息

分类

桌面与硬件