iriver/PromptX
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

更新README文件，增加项目标题和徽章，优化内容结构，提升可读性和用户体验，详细说明PromptX的功能和使用效果。

Browse Source
This commit is contained in:
AgustD
2025-06-13 23:58:09 +08:00
parent c02ce7baad
commit e28c8ebb4a
1 changed files with 101 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

163
README_EN.md
View File

@ -1,7 +1,15 @@
<div align="center">
<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>
<p>Provides specialized roles, memory management, and knowledge systems for AI applications through MCP protocol</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. 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>
<a href="README.md">中文</a> |
@ -10,41 +18,50 @@
</p>
</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/>
# 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)
#### **⚡ Zero-Configuration Integration (Recommended)**
Add to your AI application's MCP configuration file:
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.
```json
{
"mcpServers": {
"promptx": {
// Use npx to run promptx service
"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"]
}
}
}
```
**🎯 That's it!** PromptX automatically:
- ✅ **Intelligent workspace detection** - Automatically finds suitable workspace
- ✅ **Auto environment initialization** - No manual folder/config creation needed
- ✅ **Dynamic project adaptation** - Works seamlessly across different projects
**🎯 It's that simple!** Save the file and restart your AI application, and PromptX is successfully activated.
#### **🔧 Advanced Configuration (Optional)**
For custom configurations:
🔧 If you want to specify a particular folder as PromptX's workspace, you can add the `env` environment variable.
```json
{
@ -53,6 +70,9 @@ For custom configurations:
"command": "npx",
"args": ["-y", "-f", "dpml-prompt@snapshot", "mcp-server"],
"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"
}
}
@ -60,16 +80,43 @@ 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)
##### 🔧 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**
| Application | Status | Configuration | Notes |
@ -92,38 +139,23 @@ For custom configurations:
| **腾讯 CodeWhisperer** | 🟡 Planned | Tencent Cloud IDE | Tencent's AI programming tool |
> **Legend**:
> - ✅ **Official Support**: Native MCP protocol support
> - 🟡 **Experimental/Community Support**: Support through plugins or experimental features
> - ✅ **Official Support**: Native or official plugin support for MCP protocol.
> - 🟡 **Experimental/Community/Planned Support**: Support through community plugins, experimental features, or in development plans.
> - More AI applications are integrating MCP protocol...
**🎯 After configuration, your AI application gains 6 professional tools:**
- `promptx_init` - 🏗️ System initialization
- `promptx_hello` - 👋 Role discovery
- `promptx_action` - ⚡ Role activation
- `promptx_learn` - 📚 Knowledge learning
- `promptx_recall` - 🔍 Memory retrieval
- `promptx_remember` - 💾 Experience saving
**🎯 After configuration, your AI application will automatically gain 6 professional tools:**
- `promptx_init`: 🏗️ **System Initialization** - Automatically prepares the working environment.
- `promptx_hello`: 👋 **Role Discovery** - Browse all available expert roles.
- `promptx_action`: ⚡ **Role Activation** - Transform into an expert in a specific domain with one click.
- `promptx_learn`: 📚 **Knowledge Learning** - Have AI learn specific knowledge or skills.
- `promptx_recall`: 🔍 **Memory Retrieval** - Look up historical information from the memory repository.
- `promptx_remember`: 💾 **Experience Saving** - Store important information in long-term memory.
📖 **[Complete MCP Integration Guide](docs/mcp-integration-guide.md)**
### **📸 Usage Effects After Configuration**
---
#### **🎭 Role Discovery and Activation**
![Role Discovery](assets/role-discovery.png)
*Step 1: Use `promptx_hello` to discover all available professional roles*
![Role Selection](assets/role-select.png)
*Step 2: Use `promptx_action` to activate professional roles with complete capabilities*
#### **💭 Intelligent Memory Management**
![Memory Feature](assets/remember.png)
*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.
## 📋 Practice Cases
### 🎮 Legacy Lands Library
## 📋 **Practice Cases: 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;">
@ -141,22 +173,27 @@ For custom configurations:
**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.
#### 💡 User Experience
> #### **💡 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."
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.
#### **📚 Related Resources**
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.
- **AI Integration Standards and Practice Guide:** https://github.com/LegacyLands/legacy-lands-library/blob/main/AI_CODE_STANDARDS_ZHCN.md
#### 📚 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
## ⭐ **Star Growth Trend**
[![Star History Chart](https://api.star-history.com/svg?repos=Deepractice/PromptX&type=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
- 🚀 **[Release Process](docs/RELEASE.md)** - Version management and release documentation
@ -164,9 +201,11 @@ Join our technical community:
<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
---