Merge pull request #90 from Deepractice/feature/readme-product-optimization

🌟 README社区价值体系全面优化
This commit is contained in:
Sean
2025-06-28 11:31:16 +08:00
committed by GitHub
2 changed files with 215 additions and 124 deletions

339
README.md
View File

@ -1,7 +1,9 @@
<div align="center"> <div align="center">
<img src="assets/logo/Creative PromptX Duck Logo 4.svg" alt="PromptX Logo" width="120" height="120"/> <img src="assets/logo/Creative PromptX Duck Logo 4.svg" alt="PromptX Logo" width="120" height="120"/>
<h1>PromptX · AI应用原生专业能力增强系统</h1> <h1>PromptX · 领先的AI上下文工程平台</h1>
<p>通过MCP协议为AI应用提供专业角色、记忆管理和知识体系一行命令让任何 AI 客户端秒变专业选手。</p> <h2>✨ Chat is all you need - 革命性交互设计让AI Agent秒变行业专家</h2>
<p><strong>核心功能模块:</strong><a href="https://github.com/Deepractice/dpml">提示词结构化协议</a> | <a href="https://github.com/Deepractice/PATEOAS">AI状态化协议</a> | 记忆系统 | 女娲角色工坊 | 鲁班工具工坊</p>
<p>基于MCP协议一行命令为Claude、Cursor等AI应用注入专业能力</p>
<!-- Badges --> <!-- Badges -->
<p> <p>
@ -20,52 +22,66 @@
--- ---
### **一眼看懂 PromptX** ### 🚀 **实力证明 - 真实案例数据**
PromptX 能做什么?简单来说,它让你的 AI 助手拥有了"大脑"和"记忆"更让你成为AI能力的创造者。 > **"使用 PromptX一位开发者仅三天内完成了超过一万一千行的高质量 Java 代码"**
> —— Legacy Lands 制作组核心开发者
- **🎭 专业角色扮演**: 提供覆盖不同领域的专家角色,让 AI 的回答更专业、更深入。 > **"MCP开发时间从40小时缩短到30分钟"**
- **🧠 长期记忆与知识库**: AI能够记住关键信息和你的偏好在持续的对话和工作中提供连贯、个性化的支持。 > —— 社区开发者 coso
- **✨ AI角色创造工坊**: **2分钟内**将你的想法变成专业AI助手从使用者到创造者的华丽转身。
- **🔌 轻松集成**: 只需一行命令,即可为数十种主流 AI 应用(如 Claude、Cursor无缝启用这些强大功能。
<br/>
### 📸 **配置成功后的使用效果** ### 💬 **Chat is All you Need - 看看对话如何改变一切**
#### **1. 发现并激活专业角色** #### **1. 对话发现专业角色**
*使用 `promptx_welcome` 发现可用角色,再用 `promptx_action` 激活AI即刻变身领域专家。* *只需一句话"我要发现可用角色"AI就会展示所有可用的专业领域*
<img src="assets/role-discovery.png" alt="角色发现与激活" width="80%"> <img src="assets/role-discovery.png" alt="Chat方式发现角色" width="80%">
#### **2. 拥有智能记忆** #### **2. 对话选择专业角色**
*使用 `promptx_remember` 保存关键信息AI将在后续的交流中主动运用这些知识。* *看到感兴趣的专家后,直接说"激活XX专家"即可瞬间转换AI身份*
<img src="assets/remember.png" alt="记忆功能" width="80%"> <img src="assets/role-select.png" alt="Chat方式选择激活角色" width="80%">
--- #### **3. 对话管理智能记忆**
*说一句"记住这个重要信息"AI就会自动保存下次对话时主动运用这些知识*
<img src="assets/remember.png" alt="Chat方式管理记忆" width="80%">
## ⚠️ **项目状态说明** #### **💡 重要把AI当人不是软件**
PromptX 目前处于 **初始开发阶段**,我们正在积极完善功能和修复问题。在达到正式稳定版本之前,您可能会遇到一些使用上的问题或不稳定情况。 看完上面的演示,你可能还在想:"具体应该说什么指令?"
**我们诚恳地请求您的理解和支持!** 🙏 **❌ 请停止这样想:**
> "什么指令能激活角色?" | "正确的命令是什么?" | "我说错了会不会失效?"
### 📞 **遇到问题?获取帮助!** **✅ 正确的使用心态:**
> "就像和真人专家聊天一样自然" | "想到什么就说什么AI会理解你的意图" | "听不懂?换个说法再说一遍就行"
如果您在使用过程中遇到任何问题,请通过以下方式联系我们: **🎯 实际例子对比:**
```
❌ 软件思维:请执行 promptx_action java-developer
✅ 人际思维我需要一个Java开发专家
✅ 人际思维帮我找个懂Java的专家
✅ 人际思维我要和Java大牛聊聊
✅ 人际思维切换到Java开发模式
```
- 🐛 **提交 Issue**: [GitHub Issues](https://github.com/Deepractice/PromptX/issues) - 详细描述问题,我们会尽快回复 **💬 Chat is All you Need 的真正含义:**
- 💬 **直接联系**: 添加开发者微信 `deepracticex` 获取即时帮助 - 🗣️ **自然表达** - 想怎么说就怎么说,就像和朋友聊天
- 📧 **邮件联系**: 发送邮件至 `sean@deepracticex.com` 获取技术支持 - 🔄 **灵活调整** - AI没听懂换个说法继续说
- 📱 **技术交流群**: 扫描下方二维码加入我们的技术交流群 - 🤖 **信任AI** - 相信AI能理解你的真实意图不必拘泥于"标准用法"
- 💬 **持续对话** - 把每次交互当成和专家的连续对话,而不是一次性命令
您的反馈对我们非常宝贵,帮助我们快速改进产品质量! ✨
--- ---
## 🚀 **一键启动30秒完成配置** ## 🚀 **一键启动30秒完成配置**
### ⚙️ **快速配置**
**📋 前置要求:** 确保已安装 [Node.js](https://nodejs.org/zh-cn)(建议 v18 及以上版本)
打开配置文件,将下面的 `promptx` 配置代码复制进去。这是最简单的 **零配置模式**PromptX 会自动为您处理一切。 打开配置文件,将下面的 `promptx` 配置代码复制进去。这是最简单的 **零配置模式**PromptX 会自动为您处理一切。
**推荐配置beta公测版**
```json ```json
{ {
"mcpServers": { "mcpServers": {
@ -84,8 +100,47 @@ PromptX 目前处于 **初始开发阶段**,我们正在积极完善功能和
} }
``` ```
<details>
<summary>📦 <strong>其他版本配置</strong></summary>
**Alpha内测版最新功能**
```json
{
"mcpServers": {
"promptx": {
"command": "npx",
"args": ["-y", "-f", "--registry", "https://registry.npmjs.org", "dpml-prompt@alpha", "mcp-server"]
}
}
}
```
**Latest正式版最高稳定性**
```json
{
"mcpServers": {
"promptx": {
"command": "npx",
"args": ["-y", "-f", "--registry", "https://registry.npmjs.org", "dpml-prompt@latest", "mcp-server"]
}
}
}
```
</details>
### 📋 **发布渠道说明**
根据你的使用需求选择合适的版本:
| 🏷️ **渠道** | 📊 **稳定性** | 🎯 **适用场景** | 📦 **配置** |
|---------|---------|------------|---------|
| **alpha** | 内测版 ⚡ | 尝鲜最新功能,参与测试反馈 | `dpml-prompt@alpha` |
| **beta** | 公测版 🧪 | 功能相对稳定,适合日常使用 | `dpml-prompt@beta` |
| **latest** | 正式版 ✅ | 生产环境,追求最高稳定性 | `dpml-prompt@latest` |
**配置参数说明:** **配置参数说明:**
- `command`: 指定使用 npx 运行 promptx 服务 - `command`: 指定使用 npx 运行 promptx 服务npx 随 Node.js 自动安装)
- `args`: 启动参数配置列表 - `args`: 启动参数配置列表
- `-y`: 自动确认 - `-y`: 自动确认
- `-f`: 强制刷新缓存 - `-f`: 强制刷新缓存
@ -98,55 +153,38 @@ PromptX 目前处于 **初始开发阶段**,我们正在积极完善功能和
> **💡 提示:** 配置中特意指定了官方镜像源 `registry.npmjs.org`,这可以避免因使用非官方镜像导致的安装问题。如果您发现安装很慢,建议使用代理工具加速,而不是切换到其他镜像源。 > **💡 提示:** 配置中特意指定了官方镜像源 `registry.npmjs.org`,这可以避免因使用非官方镜像导致的安装问题。如果您发现安装很慢,建议使用代理工具加速,而不是切换到其他镜像源。
### ✅ **安装成功确认**
配置完成并重启AI应用后当你看到以下MCP工具出现时即代表PromptX安装成功
<img src="assets/install-success.jpg" alt="PromptX MCP工具安装成功示意图" width="80%">
看到这些工具说明PromptX已成功连接现在就可以开始使用"Chat is All you Need"的体验了。
📖 **[完整安装配置指南](https://github.com/Deepractice/PromptX/wiki/PromptX-MCP-Install)** - 包含各种客户端的详细配置方法和故障排除 📖 **[完整安装配置指南](https://github.com/Deepractice/PromptX/wiki/PromptX-MCP-Install)** - 包含各种客户端的详细配置方法和故障排除
### 不知道MCP是什么 [点击查看 MCP幼儿园教程 BiliBili](https://www.bilibili.com/video/BV1HFd6YhErb)
### 不知道MCP是怎么 [点击查看 MCP幼儿园教程 BiliBili](https://www.bilibili.com/video/BV1HFd6YhErb)
目前所有支持 MCP 协议的 AI 客户端都可以使用 PromptX。主要包括**Claude Desktop**、**Cursor**、**Windsurf**、**Cline**、**Zed**、**Continue** 等主流 AI 编程工具,以及更多正在接入中的应用。 目前所有支持 MCP 协议的 AI 客户端都可以使用 PromptX。主要包括**Claude Desktop**、**Cursor**、**Windsurf**、**Cline**、**Zed**、**Continue** 等主流 AI 编程工具,以及更多正在接入中的应用。
--- ---
### ⚙ **工作原理** ## **项目状态说明**
PromptX 作为您和AI应用之间的"专业能力中间件",通过标准的 [MCP协议](https://github.com/metacontroller/mcp) 进行通信 PromptX 目前处于 **初始开发阶段**,我们正在积极完善功能和修复问题。在达到正式稳定版本之前,您可能会遇到一些使用上的问题或不稳定情况
```mermaid **我们诚恳地请求您的理解和支持!** 🙏
graph TD
subgraph "Your AI App (Claude,Cursor,etc.)"
A[👨‍💻 User Interaction]
end
subgraph "PromptX MCP Server" ### 📞 **遇到问题?获取帮助!**
C{PromptX Engine}
D[🎭 Role Library]
E[🧠 Memory & Knowledge]
end
A -- "Calls 'promptx_...' tools" --> B(MCP Protocol) 如果您在使用过程中遇到任何问题,请通过以下方式联系我们:
B --> C
C -- "Accesses" --> D
C -- "Accesses" --> E
subgraph "Enhanced Response" - 🐛 **提交 Issue**: [GitHub Issues](https://github.com/Deepractice/PromptX/issues) - 详细描述问题,我们会尽快回复
F[✨ Professional Output] - 💬 **直接联系**: 添加开发者微信 `deepracticex` 获取即时帮助
end - 📧 **邮件联系**: 发送邮件至 `sean@deepracticex.com` 获取技术支持
C --> F - 📱 **技术交流群**: 扫描下方二维码加入我们的技术交流群
```
当您调用 `promptx_...` 系列工具时AI应用会将请求通过MCP协议发送给 PromptX。PromptX 引擎会加载相应的专业角色、检索相关记忆然后返回一个经过专业能力增强的结果给AI应用最终呈现给您。 您的反馈对我们非常宝贵,帮助我们快速改进产品质量! ✨
---
**🎯 配置完成后您的AI应用将自动获得6个专业工具**
- `promptx_init`: 🏗️ **系统初始化** - 自动准备工作环境。
- `promptx_hello`: 👋 **角色发现** - 浏览所有可用的专家角色。
- `promptx_action`: ⚡ **角色激活** - 一键变身指定领域的专家。**(含女娲🎨角色创造顾问)**
- `promptx_learn`: 📚 **知识学习** - 让AI学习特定的知识或技能。
- `promptx_recall`: 🔍 **记忆检索** - 从记忆库中查找历史信息。
- `promptx_remember`: 💾 **经验保存** - 将重要信息存入长期记忆。
📖 **[查看完整MCP集成指南](docs/mcp-integration-guide.md)**
--- ---
@ -217,76 +255,129 @@ graph TD
--- ---
## 📋 **实践案例: Legacy Lands Library**
<div align="center">
<img src="https://raw.githubusercontent.com/LegacyLands/legacy-lands-library/main/logo.png" alt="Legacy Lands Library Logo" width="120" style="border-radius: 10px; margin: 15px 0 25px 0;">
</div>
#### 📖 项目概述
**项目名称:** Legacy Lands Library
**项目地址:** https://github.com/LegacyLands/legacy-lands-library
**项目简介:** legacy-lands-library 是一个面向现代 Minecraft 服务端插件开发的开发工具库。它旨在为开发者提供一个跨平台、生产就绪的基础设施。
#### 🏢 组织信息
**组织名称:** 遗迹之地制作组 (Legacy Lands)
**官方网站:** https://www.legacylands.cn/
**组织简介:** 遗迹之地 (Legacy Lands) 是一个专注于构建大型 Minecraft 文明模拟体验的创新团队。参与开源社区,为 Minecraft 服务端插件等领域开发提供优雅、高效且可靠的解决方案。
> #### **💡 核心开发者使用心得**
> "使用 PromptX 的开发体验真的非常不一样。我们团队基于 Claude Code 并结合 PromptX**一位开发者仅三天内就完成了超过一万一千行的高质量 Java 代码。**
>
> 这套工作流的价值在实际开发中体现得淋漓尽致。PromptX 解决了 AI 使用时的许多痛点,时刻确保代码风格的统一和质量的达标,大大降低了新成员的学习成本。过去那些需要反复沟通、依靠文档传承的最佳实践,现在能够自然而然地融入到每一次代码生成中。"
>
> ---
>
> “女娲”让我使用 AI 角色更加方便、快捷实际上手发现我并不需要懂代码也不需要懂复杂的AI原理。我只需要用大白话告诉“女娲”我想要什么它就能帮我把背后那些复杂的设计工作给完成了能引导我完成剩下的所有事情。“女娲”本身不负责写小红书笔记但它能创造出一个“精通小红书营销”的专家。一旦这个专家被创造出来我以后所有小红书相关的工作都可以交给这个新角色去做了效率和专业度都大大提升。
#### **📚 相关资源**
- **AI集成标准与实践指南** https://github.com/LegacyLands/legacy-lands-library/blob/main/AI_CODE_STANDARDS_ZHCN.md
---
## 📚 **社区教程与案例**
社区成员 **coso** 基于 PromptX 架构开发了 MCP 工具,并分享了完整的开发经验:
#### 🔧 **使用 PromptX 架构开发 crawl-mcp 工具**
- **文章**[从想法到产品我如何用Cursor Agent开发出智能内容处理MCP工具](https://mp.weixin.qq.com/s/x23Ap3t9LBDVNcr_7dcMHQ)
- **成果**[crawl-mcp-server](https://www.npmjs.com/package/crawl-mcp-server) - NPM包 | [GitHub](https://github.com/wutongci/crawl-mcp)
- **亮点**:以 PromptX 为架构参考,实现零代码开发,几小时完成从想法到发布
#### 🛠️ **MCP 开发模板化实践**
- **文章**[从零代码到开源我如何用模板革命MCP开发](https://mp.weixin.qq.com/s/aQ9Io2KFoQt8k779L5kuuA)
- **成果**[mcp-template](https://github.com/wutongci/mcp-template) - 通用MCP开发模板
- **价值**:将 MCP 开发时间从 40 小时缩短到 30 分钟
> 💡 欢迎社区成员分享基于 PromptX 的实践经验,提交 PR 添加到此处。
---
## ⭐ **Star增长趋势** ## ⭐ **Star增长趋势**
[![Star History Chart](https://api.star-history.com/svg?repos=Deepractice/PromptX&type=Date)](https://star-history.com/#Deepractice/PromptX&Date) [![Star History Chart](https://api.star-history.com/svg?repos=Deepractice/PromptX&type=Date)](https://star-history.com/#Deepractice/PromptX&Date)
--- ---
### **🤝 贡献与交流**
我们欢迎任何形式的贡献和反馈! ## 🌟 **Deepractice 深度实践社区**
- 🌿 **[分支策略](docs/BRANCHING.md)** - 分支管理和发布流程 <div align="center">
- 🚀 **[发布流程](docs/RELEASE.md)** - 版本管理和发布文档 <h3>🎯 打造AI原生Life Style社区</h3>
<p><em>"实践 · 协作 · 创新"</em></p>
</div>
扫码加入技术交流群: ### 💫 **社区愿景**
<img src="assets/qrcode.jpg" alt="技术交流群" width="200"> AI不仅仅是技术工具更是重新定义生活方式的革命力量。我们致力于打造AI原生的Life Style社区汇聚各领域的实践者
- **🏠 生活** - 分享AI原生的生活方式和日常实践经验
- **📚 学习** - 构建AI时代的知识体系和学习方法论
- **💼 工作** - 探索AI原生的工作模式和协作范式
- **🚀 创业** - 孵化AI原生的商业模式和创新项目
### ⚖️ **价值观**
- 🔓 **技术开源** - 代码和技术方案开放共享让AI能力触手可及
- 📚 **内容分享** - 知识和经验无私传播,共建智慧生态
- 🌐 **社区开放** - 不设门槛壁垒欢迎所有AI实践者参与
- 💰 **价值交换** - 商业服务基于公平交换,拒绝竭泽而渔
### 🎁 **社区价值**
我们构建基于**注意力价值交换**的社区生态,让每个参与者都能获得价值:
#### 🎯 **内容生态供给**
**开源产品与优质内容**,促进社区知识共享:
- 🛠️ **技术产品**PromptX、DPML、PATEOAS等开源工具
- 📚 **实践内容**AI工作流、最佳实践、案例分享
- 🎓 **学习资源**:教程、方法论、技能指南
- 💡 **创新思路**:前沿探索、商业洞察、未来趋势
#### 👥 **注意力价值支持**
**内容价值 ↔ 流量价值**,社区成员的关注为创造者提供基础曝光:
- 🔍 **内容发现**:优质内容获得社区推荐和传播
- 💬 **互动反馈**:真实用户的使用体验和改进建议
- 🤝 **协作机会**:寻找志同道合的合作伙伴
- 🚀 **项目孵化**:利用社区影响力助力项目起步
#### 💰 **商业价值交换**
**内容价值 ↔ 货币价值**,支持优质创造者的可持续发展:
- 📊 **付费内容**:深度教程、专业咨询、定制方案
- 🎯 **服务变现**:技术服务、项目合作、专家指导
- 🚀 **产品推广**:基于价值贡献的商业展示机会
- 💡 **创新孵化**:优质项目的商业化路径支持
#### ⚖️ **价值交换原则**
- **价值优先**:内容质量决定获得的注意力和商业资源
- **公平交换**:贡献与收获成正比,拒绝割韭菜行为
- **生态共建**:每个人既是内容消费者,也是价值创造者
- **可持续发展**:支持创造者通过优质内容获得合理收益
### 🤝 **加入我们**
<div align="center">
<img src="assets/qrcode.jpg" alt="Deepractice深度实践社区" width="200">
</div>
--- ---
## 📄 **许可证** ## 🏆 **社区优质案例分享**
### 📋 **企业级应用案例**
#### **🎮 Legacy Lands Library - Minecraft开发工具库**
<div align="center">
<img src="https://raw.githubusercontent.com/LegacyLands/legacy-lands-library/main/logo.png" alt="Legacy Lands Library Logo" width="120" style="border-radius: 10px; margin: 15px 0 25px 0;">
</div>
**项目简介:** 面向现代 Minecraft 服务端插件开发的生产级工具库
**项目地址:** https://github.com/LegacyLands/legacy-lands-library
**组织官网:** https://www.legacylands.cn/
> **💡 核心开发者使用心得**
>
> "使用 PromptX 的开发体验真的非常不一样。我们团队基于 Claude Code 并结合 PromptX**一位开发者仅三天内就完成了超过一万一千行的高质量 Java 代码。**
>
> 这套工作流的价值在实际开发中体现得淋漓尽致。PromptX 解决了 AI 使用时的许多痛点,时刻确保代码风格的统一和质量的达标,大大降低了新成员的学习成本。"
>
> "女娲让我使用 AI 角色更加方便、快捷我只需要用大白话告诉女娲我想要什么它就能帮我创造出专业的AI助手效率和专业度都大大提升。"
**相关资源:** [AI集成标准与实践指南](https://github.com/LegacyLands/legacy-lands-library/blob/main/AI_CODE_STANDARDS_ZHCN.md)
---
### 🛠️ **社区优秀内容分享**
#### **🔧 crawl-mcp-server** - 智能内容处理工具,几小时完成从想法到发布
**作者:** coso | **链接:** [开发经验分享](https://mp.weixin.qq.com/s/x23Ap3t9LBDVNcr_7dcMHQ) | [NPM](https://www.npmjs.com/package/crawl-mcp-server)
#### **🎯 mcp-template** - MCP开发模板将开发时间从40小时缩短到30分钟
**作者:** coso | **链接:** [开发经验分享](https://mp.weixin.qq.com/s/aQ9Io2KFoQt8k779L5kuuA) | [GitHub](https://github.com/wutongci/mcp-template)
#### **🧠 feishu-mcp** - 解决跨AI工具记忆丢失问题的零门槛方案
**作者:** 社区成员 | **链接:** [应用分享](https://mp.weixin.qq.com/s/TTl3joJYR2iZU9_NSI2Hbg) | [NPM](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp)
#### **🎓 AI教育专家团队** - 多角色协作生成高质量系统性教育内容
**作者:** 社区教育工作者 | **链接:** [创新分享](https://mp.weixin.qq.com/s/8mAq1r5kqAOJM1bmIWlYbQ)
---
### 🌟 **分享你的案例**
我们诚挚邀请社区成员分享AI实践经验
- 📝 **提交方式** - 通过 PR 添加你的案例到此处
- 🎯 **分享内容** - 项目介绍、使用心得、效果数据、经验总结
- 🏆 **展示平台** - 在这里展示你的创新成果,获得社区认可
- 🤝 **互相学习** - 与其他实践者交流经验,共同成长
> **让每个优质案例都成为社区的财富!**
[MIT License](LICENSE) - 让AI专业能力触手可及

BIN
assets/install-success.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB