181
README.md
181
README.md
@ -1,7 +1,15 @@
|
|||||||
<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"/>
|
||||||
<p><strong>AI应用原生的专业能力增强系统</strong></p>
|
<h1>PromptX · AI应用原生专业能力增强系统</h1>
|
||||||
<p>通过MCP协议为Claude Desktop等AI应用提供专业角色、记忆管理和知识体系</p>
|
<p>通过MCP协议为AI应用提供专业角色、记忆管理和知识体系,一行命令,让任何 AI 客户端秒变专业选手。</p>
|
||||||
|
|
||||||
|
<!-- Badges -->
|
||||||
|
<p>
|
||||||
|
<a href=" "><img src="https://img.shields.io/github/stars/Deepractice/PromptX?style=social" alt="Stars"/></a>
|
||||||
|
<a href="https://www.npmjs.com/package/dpml-prompt"><img src="https://img.shields.io/npm/v/dpml-prompt?color=orange&logo=npm" alt="npm version"/></a>
|
||||||
|
<a href="LICENSE"><img src="https://img.shields.io/github/license/Deepractice/PromptX?color=blue" alt="License"/></a>
|
||||||
|
<a href="https://github.com/Deepractice/PromptX/actions"><img src="https://img.shields.io/github/actions/workflow/status/Deepractice/PromptX/ci.yml?label=CI&logo=github" alt="CI Status"/></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<strong><a href="README.md">中文</a></strong> |
|
<strong><a href="README.md">中文</a></strong> |
|
||||||
@ -10,36 +18,50 @@
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ✨ **一眼看懂 PromptX**
|
||||||
|
|
||||||
|
PromptX 能做什么?简单来说,它让你的 AI 助手拥有了"大脑"和"记忆"。
|
||||||
|
|
||||||
|
- **🎭 专业角色扮演**: 提供覆盖不同领域的专家角色,让 AI 的回答更专业、更深入。
|
||||||
|
- **🧠 长期记忆与知识库**: AI能够记住关键信息和你的偏好,在持续的对话和工作中提供连贯、个性化的支持。
|
||||||
|
- **🔌 轻松集成**: 只需一行命令,即可为数十种主流 AI 应用(如 Claude、Cursor)无缝启用这些强大功能。
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
## 🚀 一键启动 - AI应用直连
|
### 📸 **配置成功后的使用效果**
|
||||||
|
|
||||||
### 🔌 **MCP标准化接入**
|
#### **1. 发现并激活专业角色**
|
||||||
|
*使用 `promptx_hello` 发现可用角色,再用 `promptx_action` 激活,AI即刻变身领域专家。*
|
||||||
|
<img src="assets/role-discovery.png" alt="角色发现与激活" width="80%">
|
||||||
|
|
||||||
# 在AI应用中配置MCP连接 (最简配置)
|
#### **2. 拥有智能记忆**
|
||||||
|
*使用 `promptx_remember` 保存关键信息,AI将在后续的交流中主动运用这些知识。*
|
||||||
|
<img src="assets/remember.png" alt="记忆功能" width="80%">
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
#### **⚡ 零配置接入 (推荐)**
|
## 🚀 **一键启动,30秒完成配置**
|
||||||
在AI应用的MCP配置文件中添加:
|
|
||||||
|
打开配置文件,将下面的 `promptx` 配置代码复制进去。这是最简单的 **零配置模式**,PromptX 会自动为您处理一切。
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"mcpServers": {
|
"mcpServers": {
|
||||||
"promptx": {
|
"promptx": {
|
||||||
|
// 指定使用 npx 运行 promptx 服务
|
||||||
"command": "npx",
|
"command": "npx",
|
||||||
|
// '-y' 自动确认, '-f' 强制刷新缓存, 'dpml-prompt@snapshot' 使用最新版, 'mcp-server' 启动服务
|
||||||
"args": ["-y", "-f", "dpml-prompt@snapshot", "mcp-server"]
|
"args": ["-y", "-f", "dpml-prompt@snapshot", "mcp-server"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
**🎯 就这么简单!** PromptX会自动:
|
**🎯 就这么简单!** 保存文件并重启您的AI应用,PromptX 就已成功激活。
|
||||||
- ✅ **智能识别工作目录** - 自动找到合适的工作空间
|
|
||||||
- ✅ **自动初始化环境** - 无需手动创建文件夹和配置
|
|
||||||
- ✅ **动态适应项目** - 在不同项目中都能正常工作
|
|
||||||
|
|
||||||
#### **🔧 高级配置 (可选)**
|
🔧 如果您想指定一个特定的文件夹作为 PromptX 的工作区,可以添加 `env` 环境变量。
|
||||||
如需自定义配置,可添加以下选项:
|
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@ -48,6 +70,9 @@
|
|||||||
"command": "npx",
|
"command": "npx",
|
||||||
"args": ["-y", "-f", "dpml-prompt@snapshot", "mcp-server"],
|
"args": ["-y", "-f", "dpml-prompt@snapshot", "mcp-server"],
|
||||||
"env": {
|
"env": {
|
||||||
|
// PROMPTX_WORKSPACE: 自定义工作空间路径 (可选,系统会自动识别)
|
||||||
|
// Windows: "D:\\path\\to\\your\\project" (注意使用双反斜杠)
|
||||||
|
// macOS/Linux: "/Users/username/path/your/project"
|
||||||
"PROMPTX_WORKSPACE": "/your/custom/workspace/path"
|
"PROMPTX_WORKSPACE": "/your/custom/workspace/path"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -55,26 +80,50 @@
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ⚙️ **工作原理**
|
||||||
|
|
||||||
|
PromptX 作为您和AI应用之间的"专业能力中间件",通过标准的 [MCP协议](https://github.com/metacontroller/mcp) 进行通信。
|
||||||
|
|
||||||
|
```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"
|
||||||
|
F[✨ Professional Output]
|
||||||
|
end
|
||||||
|
C --> F
|
||||||
|
```
|
||||||
|
|
||||||
|
当您调用 `promptx_...` 系列工具时,AI应用会将请求通过MCP协议发送给 PromptX。PromptX 引擎会加载相应的专业角色、检索相关记忆,然后返回一个经过专业能力增强的结果给AI应用,最终呈现给您。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### 不知道MCP怎么使用? [点击查看 MCP幼儿园教程 BiliBili](https://www.bilibili.com/video/BV1HFd6YhErb)
|
### 不知道MCP怎么使用? [点击查看 MCP幼儿园教程 BiliBili](https://www.bilibili.com/video/BV1HFd6YhErb)
|
||||||
|
|
||||||
|
|
||||||
##### 🔧 高级选项说明:
|
|
||||||
- `PROMPTX_WORKSPACE`: 自定义工作空间路径 (可选,系统会自动识别)
|
|
||||||
|
|
||||||
##### 📂 自定义工作空间路径格式
|
|
||||||
|
|
||||||
- **Windows**: `"D:\\username\\path\\your\\project"` (使用双反斜杠)
|
|
||||||
- **macOS/Linux**: `"/Users/username/path/your/project"`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### **支持MCP的AI应用**
|
#### **支持MCP的AI应用**
|
||||||
|
|
||||||
| AI应用 | 状态 | 配置文件位置 | 特性 |
|
| AI应用 | 状态 | 配置文件位置 | 特性 |
|
||||||
|--------|------|-------------|------|
|
|--------|--------|-----------|------|
|
||||||
| **Claude Desktop** | ✅ 官方支持 | Windows: `%APPDATA%\Claude\claude_desktop_config.json`<br/>macOS: `~/Library/Application Support/Claude/claude_desktop_config.json` | Anthropic官方客户端,MCP原生支持 |
|
| **Claude Desktop** | ✅ 官方支持 | Windows: `%APPDATA%\Claude\claude_desktop_config.json`<br/>macOS: `~/Library/Application Support/Claude/claude_desktop_config.json` | Anthropic官方客户端,MCP原生支持 |
|
||||||
| **Cursor** | ✅ 支持 | 通过MCP设置面板配置 | 智能代码编辑器,开发者友好 |
|
| **Cursor** | ✅ 支持 | 通过MCP设置面板配置 | 智能代码编辑器,开发者友好 |
|
||||||
|
| **Claude Code** | ✅ 支持 | `/home/user/.claude.json` 或者 `~/.claude.json` | Anthropic官方CLI工具,MCP原生支持,命令行AI编程助手 |
|
||||||
| **Windsurf** | ✅ 支持 | IDE内MCP配置面板 | Codeium推出的AI原生IDE |
|
| **Windsurf** | ✅ 支持 | IDE内MCP配置面板 | Codeium推出的AI原生IDE |
|
||||||
| **Cline** | ✅ 支持 | VS Code插件配置 | 强大的AI编程助手 |
|
| **Cline** | ✅ 支持 | VS Code插件配置 | 强大的AI编程助手 |
|
||||||
| **Augment** | ✅ 支持 | 桌面应用配置 | AI原生代码编辑器 |
|
| **Augment** | ✅ 支持 | 桌面应用配置 | AI原生代码编辑器 |
|
||||||
@ -89,42 +138,63 @@
|
|||||||
| **百度 Comate** | 🟡 计划支持 | 百度IDE插件 | 百度推出的AI编程助手 |
|
| **百度 Comate** | 🟡 计划支持 | 百度IDE插件 | 百度推出的AI编程助手 |
|
||||||
| **腾讯 CodeWhisperer** | 🟡 计划支持 | 腾讯云IDE | 腾讯云AI编程工具 |
|
| **腾讯 CodeWhisperer** | 🟡 计划支持 | 腾讯云IDE | 腾讯云AI编程工具 |
|
||||||
|
|
||||||
> **说明**:
|
|
||||||
> - ✅ **官方支持**:原生支持MCP协议
|
|
||||||
> - 🟡 **实验/社区支持**:通过插件或实验性功能支持
|
|
||||||
> - 更多AI应用正在接入MCP协议...
|
|
||||||
|
|
||||||
**🎯 配置完成后,AI应用将获得6个专业工具:**
|
> **图例说明**:
|
||||||
- `promptx_init` - 🏗️ 系统初始化
|
> - ✅ **官方支持**:原生或通过官方插件支持MCP协议。
|
||||||
- `promptx_hello` - 👋 角色发现
|
> - 🟡 **实验/社区/计划支持**:通过社区插件、实验性功能或已列入开发计划。
|
||||||
- `promptx_action` - ⚡ 角色激活
|
> - 更多AI应用正在接入...
|
||||||
- `promptx_learn` - 📚 知识学习
|
|
||||||
- `promptx_recall` - 🔍 记忆检索
|
|
||||||
- `promptx_remember` - 💾 经验保存
|
|
||||||
|
|
||||||
📖 **[完整MCP集成指南](docs/mcp-integration-guide.md)**
|
**🎯 配置完成后,您的AI应用将自动获得6个专业工具:**
|
||||||
|
- `promptx_init`: 🏗️ **系统初始化** - 自动准备工作环境。
|
||||||
|
- `promptx_hello`: 👋 **角色发现** - 浏览所有可用的专家角色。
|
||||||
|
- `promptx_action`: ⚡ **角色激活** - 一键变身指定领域的专家。
|
||||||
|
- `promptx_learn`: 📚 **知识学习** - 让AI学习特定的知识或技能。
|
||||||
|
- `promptx_recall`: 🔍 **记忆检索** - 从记忆库中查找历史信息。
|
||||||
|
- `promptx_remember`: 💾 **经验保存** - 将重要信息存入长期记忆。
|
||||||
|
|
||||||
### **📸 配置成功后的使用效果**
|
📖 **[查看完整MCP集成指南](docs/mcp-integration-guide.md)**
|
||||||
|
|
||||||
#### **🎭 角色发现和激活**
|
---
|
||||||

|
|
||||||
*步骤1:使用 `promptx_hello` 发现所有可用的专业角色*
|
|
||||||
|
|
||||||

|
## 📋 **实践案例: Legacy Lands Library**
|
||||||
*步骤2:使用 `promptx_action` 一键激活专业角色,获得完整专业能力*
|
|
||||||
|
|
||||||
#### **💭 智能记忆管理**
|
<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;">
|
||||||
*步骤3:使用 `promptx_remember` 保存重要信息,AI将主动记忆并在合适时机调用*
|
</div>
|
||||||
|
|
||||||
> **✨ 配置提示**:完成MCP配置后,您的AI应用将获得上述所有专业功能。无需额外学习,按照界面提示即可享受专业化AI服务。
|
#### 📖 项目概述
|
||||||
|
|
||||||
## ⭐ Star增长趋势
|
**项目名称:** 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集成标准与实践指南:** https://github.com/LegacyLands/legacy-lands-library/blob/main/AI_CODE_STANDARDS_ZHCN.md
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ⭐ **Star增长趋势**
|
||||||
|
|
||||||
[](https://star-history.com/#Deepractice/PromptX&Date)
|
[](https://star-history.com/#Deepractice/PromptX&Date)
|
||||||
|
|
||||||
### **贡献指南**
|
---
|
||||||
- 📋 **[贡献流程](CONTRIBUTING.md)** - 详细的贡献指南和代码规范
|
|
||||||
|
### **🤝 贡献与交流**
|
||||||
|
|
||||||
|
我们欢迎任何形式的贡献和反馈!
|
||||||
|
|
||||||
- 🌿 **[分支策略](docs/BRANCHING.md)** - 分支管理和发布流程
|
- 🌿 **[分支策略](docs/BRANCHING.md)** - 分支管理和发布流程
|
||||||
- 🚀 **[发布流程](docs/RELEASE.md)** - 版本管理和发布文档
|
- 🚀 **[发布流程](docs/RELEASE.md)** - 版本管理和发布文档
|
||||||
|
|
||||||
@ -132,13 +202,8 @@
|
|||||||
|
|
||||||
<img src="assets/qrcode.jpg" alt="技术交流群" width="200">
|
<img src="assets/qrcode.jpg" alt="技术交流群" width="200">
|
||||||
|
|
||||||
|
|
||||||
## 📄 许可证
|
|
||||||
|
|
||||||
MIT License - 让AI专业能力触手可及
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**🚀 立即体验:启动PromptX MCP Server,让您的AI应用获得专业能力增强!**
|
## 📄 **许可证**
|
||||||
|
|
||||||
|
|
||||||
|
[MIT License](LICENSE) - 让AI专业能力触手可及
|
||||||
168
README_EN.md
168
README_EN.md
@ -1,7 +1,15 @@
|
|||||||
<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"/>
|
||||||
<p><strong>AI-native professional capability enhancement system</strong></p>
|
<h1>PromptX · AI-native Professional Capability Enhancement System</h1>
|
||||||
<p>Provides specialized roles, memory management, and knowledge systems for AI applications through MCP protocol</p>
|
<p>Provides specialized roles, memory management, and knowledge systems for AI applications through MCP protocol. One command to transform any AI client into a professional powerhouse.</p>
|
||||||
|
|
||||||
|
<!-- Badges -->
|
||||||
|
<p>
|
||||||
|
<a href=" "><img src="https://img.shields.io/github/stars/Deepractice/PromptX?style=social" alt="Stars"/></a>
|
||||||
|
<a href="https://www.npmjs.com/package/dpml-prompt"><img src="https://img.shields.io/npm/v/dpml-prompt?color=orange&logo=npm" alt="npm version"/></a>
|
||||||
|
<a href="LICENSE"><img src="https://img.shields.io/github/license/Deepractice/PromptX?color=blue" alt="License"/></a>
|
||||||
|
<a href="https://github.com/Deepractice/PromptX/actions"><img src="https://img.shields.io/github/actions/workflow/status/Deepractice/PromptX/ci.yml?label=CI&logo=github" alt="CI Status"/></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<a href="README.md">中文</a> |
|
<a href="README.md">中文</a> |
|
||||||
@ -10,41 +18,50 @@
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ✨ **Understanding PromptX at a Glance**
|
||||||
|
|
||||||
|
What can PromptX do? Simply put, it gives your AI assistant a "brain" and "memory."
|
||||||
|
|
||||||
|
- **🎭 Professional Role-Playing**: Provides expert roles across different domains, making AI responses more professional and in-depth.
|
||||||
|
- **🧠 Long-term Memory & Knowledge Base**: AI can remember key information and your preferences, providing coherent and personalized support in ongoing conversations and work.
|
||||||
|
- **🔌 Easy Integration**: With just one command, seamlessly enable these powerful features for dozens of mainstream AI applications (like Claude, Cursor).
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
# PromptX
|
### 📸 **Usage Effects After Configuration**
|
||||||
|
|
||||||
> **AI-native professional capability enhancement system** - Provides specialized roles, memory management, and knowledge systems for AI applications through MCP protocol
|
#### **1. Discover and Activate Professional Roles**
|
||||||
|
*Use `promptx_hello` to discover available roles, then `promptx_action` to activate them, instantly transforming your AI into a domain expert.*
|
||||||
|
<img src="assets/role-discovery.png" alt="Role Discovery and Activation" width="80%">
|
||||||
|
|
||||||
[中文](README.md) | **English** | [Issues](https://github.com/Deepractice/PromptX/issues)
|
#### **2. Intelligent Memory**
|
||||||
|
*Use `promptx_remember` to save key information, and AI will proactively apply this knowledge in subsequent interactions.*
|
||||||
|
<img src="assets/remember.png" alt="Memory Feature" width="80%">
|
||||||
|
|
||||||
## 🚀 Quick Start - Direct AI Application Integration
|
---
|
||||||
|
|
||||||
### 🔌 **MCP Standardized Integration**
|
## 🚀 **Quick Start - 30-Second Setup**
|
||||||
|
|
||||||
# Configure MCP connection in AI applications (minimal setup)
|
Open your configuration file and copy the `promptx` configuration code below. This is the simplest **zero-configuration mode**, where PromptX automatically handles everything for you.
|
||||||
|
|
||||||
#### **⚡ Zero-Configuration Integration (Recommended)**
|
|
||||||
Add to your AI application's MCP configuration file:
|
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"mcpServers": {
|
"mcpServers": {
|
||||||
"promptx": {
|
"promptx": {
|
||||||
|
// Use npx to run promptx service
|
||||||
"command": "npx",
|
"command": "npx",
|
||||||
|
// '-y' auto-confirm, '-f' force refresh cache, 'dpml-prompt@snapshot' use latest version, 'mcp-server' start service
|
||||||
"args": ["-y", "-f", "dpml-prompt@snapshot", "mcp-server"]
|
"args": ["-y", "-f", "dpml-prompt@snapshot", "mcp-server"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
**🎯 That's it!** PromptX automatically:
|
**🎯 It's that simple!** Save the file and restart your AI application, and PromptX is successfully activated.
|
||||||
- ✅ **Intelligent workspace detection** - Automatically finds suitable workspace
|
|
||||||
- ✅ **Auto environment initialization** - No manual folder/config creation needed
|
|
||||||
- ✅ **Dynamic project adaptation** - Works seamlessly across different projects
|
|
||||||
|
|
||||||
#### **🔧 Advanced Configuration (Optional)**
|
🔧 If you want to specify a particular folder as PromptX's workspace, you can add the `env` environment variable.
|
||||||
For custom configurations:
|
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@ -53,6 +70,9 @@ For custom configurations:
|
|||||||
"command": "npx",
|
"command": "npx",
|
||||||
"args": ["-y", "-f", "dpml-prompt@snapshot", "mcp-server"],
|
"args": ["-y", "-f", "dpml-prompt@snapshot", "mcp-server"],
|
||||||
"env": {
|
"env": {
|
||||||
|
// PROMPTX_WORKSPACE: Custom workspace path (optional, automatically detected by default)
|
||||||
|
// Windows: "D:\\path\\to\\your\\project" (note the double backslashes)
|
||||||
|
// macOS/Linux: "/Users/username/path/your/project"
|
||||||
"PROMPTX_WORKSPACE": "/your/custom/workspace/path"
|
"PROMPTX_WORKSPACE": "/your/custom/workspace/path"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -60,22 +80,50 @@ For custom configurations:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ⚙️ **How It Works**
|
||||||
|
|
||||||
|
PromptX acts as a "professional capability middleware" between you and your AI application, communicating through the standard [MCP protocol](https://github.com/metacontroller/mcp).
|
||||||
|
|
||||||
|
```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"
|
||||||
|
F[✨ Professional Output]
|
||||||
|
end
|
||||||
|
C --> F
|
||||||
|
```
|
||||||
|
|
||||||
|
When you call the `promptx_...` series of tools, your AI application sends the request via the MCP protocol to PromptX. The PromptX engine loads the appropriate professional roles, retrieves relevant memories, and then returns a professionally enhanced result to your AI application, which is ultimately presented to you.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### New to MCP? [Watch MCP Tutorial on BiliBili](https://www.bilibili.com/video/BV1HFd6YhErb)
|
### New to MCP? [Watch MCP Tutorial on BiliBili](https://www.bilibili.com/video/BV1HFd6YhErb)
|
||||||
|
|
||||||
##### 🔧 Advanced Options:
|
|
||||||
- `PROMPTX_WORKSPACE`: Custom workspace path (optional, auto-detected by default)
|
|
||||||
|
|
||||||
##### 📂 Custom Workspace Path Formats
|
|
||||||
|
|
||||||
- **Windows**: `"D:\\username\\path\\your\\project"` (use double backslashes)
|
|
||||||
- **macOS/Linux**: `"/Users/username/path/your/project"`
|
|
||||||
|
|
||||||
#### **Supported AI Applications**
|
#### **Supported AI Applications**
|
||||||
|
|
||||||
| Application | Status | Configuration | Notes |
|
| Application | Status | Configuration | Notes |
|
||||||
|-------------|--------|---------------|-------|
|
|-------------|--------|---------------|-------|
|
||||||
| **Claude Desktop** | ✅ Official | Windows: `%APPDATA%\Claude\claude_desktop_config.json`<br/>macOS: `~/Library/Application Support/Claude/claude_desktop_config.json` | Anthropic's official client with native MCP support |
|
| **Claude Desktop** | ✅ Official | Windows: `%APPDATA%\Claude\claude_desktop_config.json`<br/>macOS: `~/Library/Application Support/Claude/claude_desktop_config.json` | Anthropic's official client with native MCP support |
|
||||||
| **Cursor** | ✅ Supported | MCP settings panel | Developer-friendly code editor |
|
| **Cursor** | ✅ Supported | MCP settings panel | Developer-friendly code editor |
|
||||||
|
| **Claude Code** | ✅ Supported | `/home/user/.claude.json` or `~/.claude.json` | Anthropic's official CLI tool with native MCP support, command-line AI programming assistant |
|
||||||
| **Windsurf** | ✅ Supported | IDE MCP panel | Codeium's AI-native IDE |
|
| **Windsurf** | ✅ Supported | IDE MCP panel | Codeium's AI-native IDE |
|
||||||
| **Cline** | ✅ Supported | VS Code plugin config | Powerful AI programming assistant |
|
| **Cline** | ✅ Supported | VS Code plugin config | Powerful AI programming assistant |
|
||||||
| **Augment** | ✅ Supported | Desktop app config | AI-native code editor |
|
| **Augment** | ✅ Supported | Desktop app config | AI-native code editor |
|
||||||
@ -91,41 +139,61 @@ For custom configurations:
|
|||||||
| **腾讯 CodeWhisperer** | 🟡 Planned | Tencent Cloud IDE | Tencent's AI programming tool |
|
| **腾讯 CodeWhisperer** | 🟡 Planned | Tencent Cloud IDE | Tencent's AI programming tool |
|
||||||
|
|
||||||
> **Legend**:
|
> **Legend**:
|
||||||
> - ✅ **Official Support**: Native MCP protocol support
|
> - ✅ **Official Support**: Native or official plugin support for MCP protocol.
|
||||||
> - 🟡 **Experimental/Community Support**: Support through plugins or experimental features
|
> - 🟡 **Experimental/Community/Planned Support**: Support through community plugins, experimental features, or in development plans.
|
||||||
> - More AI applications are integrating MCP protocol...
|
> - More AI applications are integrating MCP protocol...
|
||||||
|
|
||||||
**🎯 After configuration, your AI application gains 6 professional tools:**
|
**🎯 After configuration, your AI application will automatically gain 6 professional tools:**
|
||||||
- `promptx_init` - 🏗️ System initialization
|
- `promptx_init`: 🏗️ **System Initialization** - Automatically prepares the working environment.
|
||||||
- `promptx_hello` - 👋 Role discovery
|
- `promptx_hello`: 👋 **Role Discovery** - Browse all available expert roles.
|
||||||
- `promptx_action` - ⚡ Role activation
|
- `promptx_action`: ⚡ **Role Activation** - Transform into an expert in a specific domain with one click.
|
||||||
- `promptx_learn` - 📚 Knowledge learning
|
- `promptx_learn`: 📚 **Knowledge Learning** - Have AI learn specific knowledge or skills.
|
||||||
- `promptx_recall` - 🔍 Memory retrieval
|
- `promptx_recall`: 🔍 **Memory Retrieval** - Look up historical information from the memory repository.
|
||||||
- `promptx_remember` - 💾 Experience saving
|
- `promptx_remember`: 💾 **Experience Saving** - Store important information in long-term memory.
|
||||||
|
|
||||||
📖 **[Complete MCP Integration Guide](docs/mcp-integration-guide.md)**
|
📖 **[Complete MCP Integration Guide](docs/mcp-integration-guide.md)**
|
||||||
|
|
||||||
### **📸 Usage Effects After Configuration**
|
---
|
||||||
|
|
||||||
#### **🎭 Role Discovery and Activation**
|
## 📋 **Practice Cases: Legacy Lands Library**
|
||||||

|
|
||||||
*Step 1: Use `promptx_hello` to discover all available professional roles*
|
|
||||||
|
|
||||||

|
<div align="center">
|
||||||
*Step 2: Use `promptx_action` to activate professional roles with complete capabilities*
|
<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>
|
||||||
|
|
||||||
#### **💭 Intelligent Memory Management**
|
#### 📖 Project Overview
|
||||||

|
|
||||||
*Step 3: Use `promptx_remember` to save important information for intelligent recall*
|
|
||||||
|
|
||||||
> **✨ Configuration Note**: After completing MCP configuration, your AI application will have all the above professional features. No additional learning required - just follow the interface prompts to enjoy professional AI services.
|
**Project Name:** Legacy Lands Library
|
||||||
|
**Project URL:** https://github.com/LegacyLands/legacy-lands-library
|
||||||
|
**Project Description:** legacy-lands-library is a development toolkit library for modern Minecraft server plugin development. It aims to provide developers with a cross-platform, production-ready infrastructure.
|
||||||
|
|
||||||
## ⭐ Star Growth Trend
|
#### 🏢 Organization Information
|
||||||
|
|
||||||
|
**Organization Name:** Legacy Lands Development Team
|
||||||
|
**Official Website:** https://www.legacylands.cn/
|
||||||
|
**Organization Description:** Legacy Lands is an innovative team focused on building large-scale Minecraft civilization simulation experiences. They participate in the open-source community, providing elegant, efficient, and reliable solutions for Minecraft server plugin development and other domains.
|
||||||
|
|
||||||
|
> #### **💡 Core Developer Experience**
|
||||||
|
> "The development experience with PromptX is truly different. Our team, using Claude Code combined with PromptX, had one developer complete over eleven thousand lines of high-quality Java code in just three days.
|
||||||
|
>
|
||||||
|
> The value of this workflow is fully demonstrated in actual development. PromptX solves many pain points in AI usage, consistently ensuring code style uniformity and quality standards, greatly reducing the learning curve for new team members. Best practices that previously required repeated communication and documentation inheritance can now naturally integrate into every code generation."
|
||||||
|
|
||||||
|
#### **📚 Related Resources**
|
||||||
|
|
||||||
|
- **AI Integration Standards and Practice Guide:** https://github.com/LegacyLands/legacy-lands-library/blob/main/AI_CODE_STANDARDS_ZHCN.md
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ⭐ **Star Growth Trend**
|
||||||
|
|
||||||
[](https://star-history.com/#Deepractice/PromptX&Date)
|
[](https://star-history.com/#Deepractice/PromptX&Date)
|
||||||
|
|
||||||
### **Contributing Guidelines**
|
---
|
||||||
- 📋 **[Contributing Process](CONTRIBUTING.md)** - Detailed contribution guide and code standards
|
|
||||||
|
### **🤝 Contributing and Communication**
|
||||||
|
|
||||||
|
We welcome any form of contribution and feedback!
|
||||||
|
|
||||||
- 🌿 **[Branching Strategy](docs/BRANCHING.md)** - Branch management and release process
|
- 🌿 **[Branching Strategy](docs/BRANCHING.md)** - Branch management and release process
|
||||||
- 🚀 **[Release Process](docs/RELEASE.md)** - Version management and release documentation
|
- 🚀 **[Release Process](docs/RELEASE.md)** - Version management and release documentation
|
||||||
|
|
||||||
@ -133,9 +201,11 @@ Join our technical community:
|
|||||||
|
|
||||||
<img src="assets/qrcode.jpg" alt="Technical Community" width="200">
|
<img src="assets/qrcode.jpg" alt="Technical Community" width="200">
|
||||||
|
|
||||||
## 📄 License
|
---
|
||||||
|
|
||||||
MIT License - Making AI professional capabilities accessible
|
## 📄 **License**
|
||||||
|
|
||||||
|
[MIT License](LICENSE) - Making AI professional capabilities accessible
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@ -40,6 +40,12 @@ npx dpml-prompt@snapshot mcp-server
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### 3. Claude Code 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
claude mcp add-json promptx '{"command":"npx","args":["-y","-f","dpml-prompt@snapshot","mcp-server"]}'
|
||||||
|
```
|
||||||
|
|
||||||
### 💡 **重要:关于 `cwd` 参数**
|
### 💡 **重要:关于 `cwd` 参数**
|
||||||
|
|
||||||
#### **`cwd` 的含义和MCP协议限制**
|
#### **`cwd` 的含义和MCP协议限制**
|
||||||
|
|||||||
Reference in New Issue
Block a user