iriver/PromptX
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
5e6dc85f3e3acb67ef3075725fd298d36f37582b
PromptX/README_EN.md

302 lines
14 KiB
Markdown
Raw Blame History

<div align="center">
<img src="assets/logo/Creative PromptX Duck Logo 4.svg" alt="PromptX Logo" width="120" height="120"/>
<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> |
<strong><a href="README_EN.md">English</a></strong> |
<a href="https://github.com/Deepractice/PromptX/issues">Issues</a>
</p>
</div>
---
### ✨ **Understanding PromptX at a Glance**
What can PromptX do? Simply put, it gives your AI assistant a "brain" and "memory," and transforms you from user to creator.
- **🎭 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.
- **✨ AI Role Creation Workshop**: **Create professional AI assistants in 2 minutes** - Transform your ideas into reality, evolving from user to creator.
- **🔌 Easy Integration**: With just one command, seamlessly enable these powerful features for dozens of mainstream AI applications (like Claude, Cursor).
<br/>
### 📸 **Usage Effects After Configuration**
#### **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%">
#### **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%">
---
## ⚠️ **Project Status Notice**
PromptX is currently in the **early development stage**, and we are actively improving features and fixing issues. Before reaching the official stable version, you may encounter some usage issues or instability.
**We sincerely ask for your understanding and support!** 🙏
### 📞 **Need Help? Get Support!**
If you encounter any issues during usage, please contact us through:
- 🐛 **Submit Issue**: [GitHub Issues](https://github.com/Deepractice/PromptX/issues) - Describe the problem in detail, we'll respond promptly
- 💬 **Direct Contact**: Add developer WeChat `deepracticex` for immediate assistance
- 📧 **Email Contact**: Send email to `sean@deepracticex.com` for technical support
- 📱 **Tech Community**: Scan the QR code below to join our technical discussion group
Your feedback is invaluable to us and helps us improve product quality rapidly! ✨
---
## 🚀 **Quick Start - 30-Second 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.
```json
{
"mcpServers": {
"promptx": {
"command": "npx",
"args": [
"-y",
"-f",
"--registry",
"https://registry.npmjs.org",
"dpml-prompt@beta",
"mcp-server"
]
}
}
}
```
**Configuration Parameters:**
- `command`: Specifies using npx to run promptx service
- `args`: Startup parameters configuration list
- `-y`: Auto-confirm
- `-f`: Force refresh cache
- `--registry`: Specify registry source
- `https://registry.npmjs.org`: Use official registry
- `dpml-prompt@beta`: Use stable beta version
- `mcp-server`: Start service
**🎯 It's that simple!** Save the file and restart your AI application, and PromptX is successfully activated.
> **💡 Tip:** The configuration specifically uses the official registry `registry.npmjs.org` to avoid installation issues caused by unofficial mirrors. If you find the installation slow, it's recommended to use a proxy tool for acceleration rather than switching to alternative mirrors.
### 🌐 **Advanced Configuration: HTTP Mode Support**
In addition to the local mode above, PromptX also supports **HTTP mode**, suitable for remote deployment or special network environments:
```bash
# Start HTTP mode server
npx -f -y dpml-prompt@beta mcp-server --transport http --port 3000
```
Then use in client configuration:
```json
{
"mcpServers": {
"promptx": {
"url": "http://localhost:3000/mcp"
}
}
}
```
📖 **[Complete Installation & Configuration Guide](https://github.com/Deepractice/PromptX/wiki/PromptX-MCP-Install)** - Detailed configuration methods for various clients and troubleshooting
<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)
All AI clients that support the MCP protocol can use PromptX. This includes major applications like **Claude Desktop**, **Cursor**, **Windsurf**, **Cline**, **Zed**, **Continue**, and many more mainstream AI development tools that are integrating MCP support.
**🎯 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. **(Includes Nuwa🎨 Role Creation Consultant)**
- `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)**
---
## 🎨 **Nuwa Creation Workshop - Democratizing AI Role Design**
<div align="center">
<img src="assets/nuwa-logo.png" alt="Nuwa Creation Workshop" width="120" style="border-radius: 50%; margin: 15px 0 25px 0;">
</div>
#### **💫 From Idea to Reality in Just 2 Minutes**
Have you ever thought: What if I could customize a professional AI assistant for specific work scenarios? **Nuwa makes this idea a reality.**
> *"Every idea deserves its own dedicated AI assistant. Technical barriers should never limit creative flight."*
#### **🎯 Core Value Transformation**
- **🚀 Zero-Barrier Creation**: No need to learn complex technology - describe your needs in natural language
- **⚡ Lightning-Fast Delivery**: From idea to usable role in just 2 minutes
- **🎭 Professional Quality**: Automatically generates professional AI roles compliant with DPML standards
- **🔄 Plug-and-Play**: Created roles can be activated immediately after completion
- **💝 Sense of Control**: Elegant transformation from user to creator
#### **✨ Usage Scenarios Examples**
<div align="center">
| 🎯 **User Need** | ⚡ **Nuwa Generated** | 🚀 **Ready to Use** |
|---|---|---|
| 👩‍💼 "I need an AI assistant for Instagram marketing" | Instagram Marketing Expert Role | `promptx_action instagram-expert` |
| 👨‍💻 "I want a Python async programming expert" | Python Async Programming Tutor Role | `promptx_action python-async-tutor` |
| 🎨 "Give me a UI/UX design consultant" | UI/UX Design Expert Role | `promptx_action uiux-consultant` |
| 📊 "Need a data analyst assistant" | Data Analysis Expert Role | `promptx_action data-analyst` |
</div>
#### **📊 Efficiency Revolution**
<div align="center">
| **Traditional Method** | **Nuwa Method** | **Improvement** |
|---|---|---|
| 📚 Learn DPML syntax | 🗣️ Natural language description | **95% learning curve reduction** |
| ⏰ 2-8 hours development | ⚡ 2 minutes generation | **240x speed increase** |
| 🤔 Technical decision making | 🎯 Focus on requirements | **100% cognitive load reduction** |
| 🧪 Manual testing and debugging | ✅ Instant activation | **99% error rate reduction** |
</div>
#### **🚀 4-Step Simple Workflow**
<div align="center">
<img src="assets/nuwa-demo/step1-action-nuwa.jpg" alt="Step 1: Activate Nuwa Role Creation Consultant" width="80%" style="margin: 10px 0;">
<img src="assets/nuwa-demo/step2-require-nuwa.jpg" alt="Step 2: Describe your needs to Nuwa" width="80%" style="margin: 10px 0;">
<img src="assets/nuwa-demo/step3-modify-requirement.jpg" alt="Step 3: Nuwa understands and refines requirements" width="80%" style="margin: 10px 0;">
<img src="assets/nuwa-demo/step4-action-bew-role.jpg" alt="Step 4: Activate the newly created dedicated role" width="80%" style="margin: 10px 0;">
</div>
#### **💬 User Testimonials**
> **👨‍💻 Developer**: *"I used to spend hours writing role configurations. Now with Nuwa, I describe my needs and get a professional AI assistant immediately. It's magical!"*
> **🎨 Designer**: *"As a non-technical person, I never thought I could create AI roles. Nuwa made me feel like a creator, not just a user."*
> **📊 Product Manager**: *"Our team now creates customized AI assistants for different projects. Nuwa has become an indispensable part of our toolkit."*
#### **🧠 Design Philosophy**
Nuwa embodies the core philosophy of PromptX: **"Making professional capabilities accessible to everyone"**. We believe that:
- **🌟 Boundless Creativity**: Technical barriers shouldn't limit imagination
- **⚡ Instant Satisfaction**: Great ideas deserve immediate realization
- **🎯 Demand-Driven**: Technology should serve human creativity, not constrain it
- **🤝 Ecosystem Co-creation**: Every user can contribute to the AI assistant ecosystem
---
## 📋 **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;">
</div>
#### 📖 Project Overview
**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.
#### 🏢 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**
[![Star History Chart](https://api.star-history.com/svg?repos=Deepractice/PromptX&type=Date)](https://star-history.com/#Deepractice/PromptX&Date)
---
### **🤝 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
Join our technical community:
<img src="assets/qrcode.jpg" alt="Technical Community" width="200">
---
## 📄 **License**
[MIT License](LICENSE) - Making AI professional capabilities accessible
---
**🚀 Get Started Now: Launch PromptX MCP Server and enhance your AI application with professional capabilities!**
Reference in New Issue View Git Blame Copy Permalink