使用说明

项目简介

Prompt Decorators 是一个框架,旨在标准化 Prompt 工程,通过使用装饰器来增强和结构化 LLM 的 Prompt。该仓库不仅提供了 Prompt 装饰器规范和 Python 参考实现,还包含了 MCP 服务器实现,以便在支持 Model Context Protocol (MCP) 协议的客户端中使用。

主要功能点

  • Prompt 装饰器规范:定义了一套标准化的 Prompt 装饰器语法和行为,使得 Prompt 工程更加一致和可复用。
  • Python 参考实现:提供了一个完整的 Python 参考实现和工具库,方便开发者快速上手和使用 Prompt 装饰器。
  • MCP 服务器:集成了 Model Context Protocol (MCP) 服务器,允许用户在支持 MCP 协议的桌面 AI 应用(如 Claude Desktop)中使用 Prompt 装饰器,实现上下文增强和功能扩展。
  • 预构建装饰器库:包含 140 多个预构建的装饰器,涵盖推理、格式化、风格控制等多种功能,开箱即用。

安装步骤

  1. 确保已安装 Python 3.11 或更高版本。

  2. 使用 pip 安装 'prompt-decorators' 包:

    pip install prompt-decorators
  3. 如果需要 MCP 服务器功能,安装带有 'mcp' 扩展的包:

    pip install "prompt-decorators[mcp]"

服务器配置

MCP 服务器需要 MCP 客户端进行连接和配置才能使用。以下是 Claude Desktop 等 MCP 客户端的典型配置信息(JSON 格式):

{
  "server name": "Prompt Decorators MCP Server",
  "command": "python",
  "args": ["-m", "prompt_decorators.integrations.mcp"]
  // "server name":  MCP 服务器的名称,可自定义
  // "command": 启动 MCP 服务器的命令,这里使用 python 运行模块
  // "args":  启动命令的参数,指定运行 prompt_decorators.integrations.mcp 模块
}

请将以上 JSON 配置信息填入您的 MCP 客户端(例如 Claude Desktop)的 Context Sources 设置中,以连接到 Prompt Decorators MCP 服务器。

基本使用方法

  1. 启动 MCP 服务器:在安装了 'prompt-decorators[mcp]' 的环境中,运行以下命令启动 MCP 服务器:

    python -m prompt_decorators.integrations.mcp
  2. 配置 MCP 客户端:在支持 MCP 协议的客户端(如 Claude Desktop)中,导入上面生成的 JSON 配置文件,客户端将自动连接到 MCP 服务器。

  3. 使用 Prompt 装饰器:在 MCP 客户端中,即可利用 Prompt Decorators 提供的各种装饰器来增强您的 Prompt,例如使用 '+++Reasoning' 装饰器来增强 LLM 的推理能力,或使用 '+++OutputFormat' 装饰器来控制 LLM 的输出格式。 具体装饰器的使用方法请参考仓库文档和示例。

信息

分类

AI与计算