dpml-prompt/prompt/protocol/dpml.protocol.md

DPML-powered AI prompt framework - Revolutionary AI-First CLI system based on Deepractice Prompt Markup Language. Build sophisticated AI agents with structured prompts, memory systems, and execution frameworks.

# Deepractice提示词标记语言模式协议 (DPML)

> **TL;DR:** DPML(Deepractice Prompt Markup Language)是一种专为#提示词 工程设计的标记语言，结合了#标签（XML结构）和#内容（Markdown内容），为各类提示词提供标准化的表达框架，确保提示词的结构清晰性和语义准确性。

### 目的与范围

DPML旨在为提示词工程提供一种标准化的表达方式，解决以下关键问题：
- 为不同类型的提示词提供清晰的#语义结构（思考类、执行类等）
- 保持提示词的自然语言表达能力和灵活性
- 支持提示词的模块化组织和复用
- 确保提示词的机器可解析性和人类可读性

DPML适用于所有需要结构化表达提示词的场景，包括但不限于：
- AI助手的提示词系统
- 复杂任务的指令设计
- 自动化工作流的提示词定义
- 知识管理的提示词组织

### 设计思想

DPML的核心设计理念基于以下关键思想:

1. **自然语言驱动**: DPML认为提示词本质上是自然语言的结构化表达，而非传统编程语言。#标签结构仅用于提供#语义边界，#内容仍以自然语言为主。

2. **释义即实现**: DPML中，对提示词的#语义释义本身就构成了#实现。当AI系统理解一个提示词的语义后，无需额外的转换层，该理解过程即为执行过程。

3. **语义透明性**: #标签和#属性名称具有自解释性，使人类和AI都能直观理解结构的意图和功能。

4. **组合复用**: 通过协议实现绑定(`A:B`语法)，简单协议可组合构建复杂功能，实现"积木式"提示词工程。

5. **一致性理解**: 同一DPML结构应在不同AI系统中产生一致理解和行为，确保提示词的可移植性和稳定性。

这些设计思想指导DPML的所有协议设计，使提示词既具备结构化的机器可解析性，又保持自然语言的表达力和灵活性。

### 相关协议

- **XML**: DPML的基本#标签结构借鉴了XML
- **Markdown**: DPML的#内容部分采用Markdown格式

## 📝 语法规则

### 形式化定义

```ebnf
document    ::= element | (element document)
element     ::= '<' tag attributes '>' content '</' tag '>' | '<' tag attributes '/>'
tag         ::= [namespace ':'] name
namespace   ::= name
name        ::= [A-Za-z][A-Za-z0-9_-]*
attributes  ::= (attribute attributes) | ε
attribute   ::= name '="' value '"'
value       ::= [^"]*
content     ::= markdown_text | (element content) | ε
markdown_text ::= (* 任何有效的Markdown文本 *)
```

### 词法元素

| 元素 | 形式 | 描述 |
|------|------|------|
| #标签 | `<tag>...</tag>` | 定义#语义单元，如`<thinking>`,`<executing>` |
| #自闭合标签 | `<tag />` | 无内容的标签，如`<import />` |
| #属性 | `property="value"` | #标签配置信息，如`type="analysis"` |
| #内容 | Markdown格式文本 | #标签内的实际提示词文本 |
| 注释 | `<!-- comment -->` | 协议注释，不作为提示词内容 |

### 组合规则

1. #标签可以嵌套，形成层次结构
2. 一个#标签可以有多个#属性，属性名在同一标签中不能重复
3. #标签必须正确闭合，要么是配对标签`<tag></tag>`，要么是#自闭合标签`<tag/>`
4. #内容部分可以是纯Markdown文本，也可以包含其他#标签
5. 根元素推荐使用`<prompt>`，但不强制要求

## 🧩 语义定义

### 核心概念

| 概念 | 定义 | 示例 |
|------|------|------|
| #提示单元 | 由#标签定义的语义完整的提示组件 | `<thinking>分析问题...</thinking>` |
| #属性修饰 | 通过#属性细化#提示单元的行为特性 | `<executing priority="high">` |
| #内容表达 | 使用Markdown表达的实际提示文本 | `# 步骤\n1. 首先...` |
| #组合提示 | 多个#提示单元组合形成完整提示 | `<thinking>...</thinking><executing>...</executing>` |

### 属性约束

DPML对#属性采用以下约束和规范：

1. **属性的通用性原则**：
   - #属性是通用机制，可应用于任何#标签
   - 同一#属性可用于不同#标签，但语义一致
   - #属性独立于#标签单独定义，不绑定于特定#标签

2. **属性定义原则**：
   - DPML本身不预定义具体#属性，仅提供#属性的语法框架
   - 所有使用的#属性必须在具体协议或属性规范中明确定义
   - 未定义的#属性不允许使用
   - #属性值必须符合规定的类型和范围

3. **属性规范管理**：
   - #属性在单独的属性规范文档中定义
   - 每个#属性定义包括：名称、数据类型、适用范围、语义
   - 新#属性需遵循规范化流程引入
   - 兼容性变更需考虑向后兼容性


#属性约束确保提示词的一致性和互操作性。在使用DPML开发提示词时，开发者应遵循已定义的#属性规范，不得创建私有或未文档化的#属性。

### 协议实现绑定

DPML中的冒号(`:`)语法是核心语义机制，用于表达#标签间的实现关系：

1. **基本实现绑定**：通过冒号表示一个功能通过特定协议实现
   ```xml
   <store:execution>
     <!-- 表示store功能通过execution协议实现 -->
   </store:execution>
   ```
   
   在DPML中，`A:B`表示"A通过B实现"，读作"A implemented with B"。冒号左侧表示"做什么"(功能)，右侧表示"怎么做"(实现方式)。

2. **实现继承行为**：当使用`<A:B>`形式时，A#标签继承B协议的全部结构规则和语义特征。例如：
   ```xml
   <store:execution>
     <process>...</process>  <!-- 来自execution协议的子标签 -->
     <rule>...</rule>        <!-- 来自execution协议的子标签 -->
   </store:execution>
   ```

3. **多协议组合**：不同功能可以通过不同协议实现，共同构建复杂系统
   ```xml
   <memory>
     <store:execution>存储操作...</store:execution>
     <recall:resource>检索操作...</recall:resource>
   </memory>
   ```

4. **实现层次结构**：
   ```mermaid
   flowchart LR
     A["memory"] --> B["store:execution"]
     A --> C["recall:resource"]
     B --> D["process"]
     B --> E["rule"]
     C --> F["path引用"]
   ```

每个实现绑定关系都明确表达了"这个功能使用那个协议来实现"，确保提示词组件的语义清晰性和交互一致性。

### 解释规则

1. #标签名决定#提示单元的主要语义类型（思考、执行等）
2. #属性提供额外的控制和元数据，影响#提示单元的解释方式
3. #内容部分按Markdown语法解析，保留其格式特性（标题、列表、强调等）
4. #嵌套标签表示包含关系，内层#提示单元属于外层#提示单元的组成部分
5. 同级#标签按顺序解释，表示提示流程的先后次序


## 📋 使用示例

### 有效示例

**1. 基本思考-执行流程**
```
<prompt>
  <thinking type="analysis">
    # 问题分析
    这是一个**数据处理**问题，需要考虑：
    1. 数据格式转换
    2. 性能优化
  </thinking>
  
  <executing>
    # 执行步骤
    1. 首先读取输入文件
    2. 应用转换算法
    3. 输出结果到目标位置
    
    确保全程**记录日志**以便调试。
  </executing>
</prompt>
```

**2. 带属性的复杂结构**
```
<prompt>
  <context type="background">
    # 项目背景
    客户需要一个数据可视化dashboard。
  </context>
  
  <thinking type="design" priority="high">
    # 设计思路
    采用模块化设计，分离数据层和视图层。
    
    <concept id="arch" domain="frontend">
      ## 架构概念
      使用React + D3.js组合
    </concept>
  </thinking>
  
  <executing steps="3">
    # 实现步骤
    1. 搭建基础框架
    2. 实现数据连接器
    3. 开发可视化组件
  </executing>
</prompt>
```

**3. 资源引用**
```
<prompt>
  <resource type="reference" src="docs/api-spec.md">
    参考API规范文档
    
    API端点定义在源码的25-35行
  </resource>
  
  <thinking>
    基于API规范进行设计...
  </thinking>
</prompt>
```

**4. 跨协议组合示例**
```
<memory>
  <!-- 存储操作通过execution协议实现 -->
  <store:execution>
    <content>用户操作系统：MacOS 13.4</content>
    
    <process>
      # 存储流程
      ```mermaid
      flowchart TD
        A[接收内容] --> B[验证格式]
        B --> C[写入存储]
      ```
    </process>
    
    <rule>
      1. 记忆写入必须原子化
      2. 冲突时保留高置信度版本
    </rule>
  </store:execution>
  
  <!-- 检索操作通过resource协议实现 -->
  <recall:resource>
    @memory://system/os_info?confidence=0.8
  </recall:resource>
</memory>
```

### 无效示例

**1. 标签未闭合**
```
<prompt>
  <thinking>
    思考内容...
  <!-- 缺少</thinking>标签 -->
  
  <executing>
    执行步骤...
  </executing>
</prompt>
```
错误原因：`<thinking>`标签未正确闭合

**2. 属性格式错误**
```
<prompt>
  <thinking type=analysis>
    思考内容...
  </thinking>
</prompt>
```
错误原因：属性值缺少双引号，应为`type="analysis"`

**3. 使用未定义属性**
```
<prompt>
  <thinking color="blue" importance="9">
    思考内容...
  </thinking>
</prompt>
```
错误原因：使用了未在属性规范中定义的`color`和`importance`属性

## 💡 最佳实践

1. **标签命名自释义**：选择具有自解释性的标签名称，使其本身就能清晰表达逻辑语义，即使没有计算机处理，人和AI也能轻松理解标签结构的逻辑上下文
2. **语义清晰度**：选择表意明确的标签名，让提示结构一目了然
3. **适度分层**：合理使用嵌套结构，避免过深的层次导致可读性下降
4. **内容聚焦**：每个标签内容应关注单一职责，避免功能混杂
5. **属性合理性**：只使用必要的属性，避免过度配置
6. **一致性**：在整个项目中保持一致的DPML结构风格
7. **命名空间明确性**：使用命名空间时，确保左侧表示"做什么"(功能)，右侧表示"怎么做"(实现)
8. **属性合规性**：只使用已正式定义的属性，遵循属性规范中的类型和值约束

## 📌 总结

DPML通过结合标签语言的结构化能力和Markdown的内容表现力，为提示词工程提供了一种既规范又灵活的表达方式。其核心优势在于清晰的语义结构、协议复用机制和人类可读性，特别适合构建复杂、模块化的AI交互提示系统。