@iflow-mcp/promptx
Version:
AI角色创建平台和智能工具开发平台,基于MCP协议提供专业AI能力注入
272 lines (188 loc) • 11.8 kB
Markdown
<div align="center">
<img src="assets/logo/Creative PromptX Duck Logo 4.svg" alt="PromptX Logo" width="120" height="120"/>
<h1>PromptX · Leading AI Agent Context Platform</h1>
<h2>✨ Chat is all you need - Revolutionary interaction design that turns AI agents into industry experts</h2>
<p><strong>Core Capabilities:</strong>AI Role Creation Platform | Intelligent Tool Development Platform | Cognitive Memory System</p>
<p>Based on MCP protocol, inject professional capabilities into Claude, Cursor and other AI applications with a single command</p>
<!-- Badges -->
<p>
<a href=" "><img src="https://img.shields.io/github/stars/Deepractice/PromptX?style=social" alt="Stars"/></a>
<img src="https://komarev.com/ghpvc/?username=PromptX&label=views&color=0e75b6&style=flat&abbreviated=true" alt="Views"/>
<a href="LICENSE"><img src="https://img.shields.io/github/license/Deepractice/PromptX?color=blue" alt="License"/></a>
<a href="https://zread.ai/Deepractice/PromptX" target="_blank"><img src="https://img.shields.io/badge/Ask_Zread-_.svg?style=flat&color=00b0aa&labelColor=000000&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTQuOTYxNTYgMS42MDAxSDIuMjQxNTZDMS44ODgxIDEuNjAwMSAxLjYwMTU2IDEuODg2NjQgMS42MDE1NiAyLjI0MDFWNC45NjAxQzEuNjAxNTYgNS4zMTM1NiAxLjg4ODEgNS42MDAxIDIuMjQxNTYgNS42MDAxSDQuOTYxNTZDNS4zMTUwMiA1LjYwMDEgNS42MDE1NiA1LjMxMzU2IDUuNjAxNTYgNC45NjAxVjIuMjQwMUM1LjYwMTU2IDEuODg2NjQgNS4zMTUwMiAxLjYwMDEgNC45NjE1NiAxLjYwMDFaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00Ljk2MTU2IDEwLjM5OTlIMi4yNDE1NkMxLjg4ODEgMTAuMzk5OSAxLjYwMTU2IDEwLjY4NjQgMS42MDE1NiAxMS4wMzk5VjEzLjc1OTlDMS42MDE1NiAxNC4xMTM0IDEuODg4MSAxNC4zOTk5IDIuMjQxNTYgMTQuMzk5OUg0Ljk2MTU2QzUuMzE1MDIgMTQuMzk5OSA1LjYwMTU2IDE0LjExMzQgNS42MDE1NiAxMy43NTk5VjExLjAzOTlDNS42MDE1NiAxMC42ODY0IDUuMzE1MDIgMTAuMzk5OSA0Ljk2MTU2IDEwLjM5OTlaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik0xMy43NTg0IDEuNjAwMUgxMS4wMzg0QzEwLjY4NSAxLjYwMDEgMTAuMzk4NCAxLjg4NjY0IDEwLjM5ODQgMi4yNDAxVjQuOTYwMUMxMC4zOTg0IDUuMzEzNTYgMTAuNjg1IDUuNjAwMSAxMS4wMzg0IDUuNjAwMUgxMy43NTg0QzE0LjExMTkgNS42MDAxIDE0LjM5ODQgNS4zMTM1NiAxNC4zOTg0IDQuOTYwMVYyLjI0MDFDMTQuMzk4NCAxLjg4NjY0IDE0LjExMTkgMS42MDAxIDEzLjc1ODQgMS42MDAxWiIgZmlsbD0iI2ZmZiIvPgo8cGF0aCBkPSJNNCAxMkwxMiA0TDQgMTJaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00IDEyTDEyIDQiIHN0cm9rZT0iI2ZmZiIgc3Ryb2tlLXdpZHRoPSIxLjUiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIvPgo8L3N2Zz4K&logoColor=ffffff" alt="zread"/></a>
</p>
<p>
<a href="https://www.npmjs.com/package/@promptx/cli"><img src="https://img.shields.io/npm/v/@promptx/cli?color=orange&logo=npm" alt="npm version"/></a>
<a href="https://github.com/Deepractice/PromptX/releases"><img src="https://img.shields.io/github/v/release/Deepractice/PromptX?color=green&logo=github" alt="Latest Release"/></a>
<a href="https://hub.docker.com/r/deepracticexs/promptx"><img src="https://img.shields.io/badge/docker-latest-0db7ed?logo=docker&logoColor=white" alt="Docker"/></a>
</p>
<p>
<a href="README.zh-Hans.md">简体中文</a> |
<a href="README.zh-Hant.md">繁體中文</a> |
<strong><a href="README.md">English</a></strong> |
<a href="https://github.com/Deepractice/PromptX/issues">Issues</a>
</p>
</div>
---
## 💬 Chat is All you Need - Natural conversation, instant expertise
### ✨ Experience PromptX Magic in 3 Steps
#### 🔍 **Step 1: Discover Experts**
```
User: "Show me what experts are available"
AI: Instantly displays 23 available roles, from product managers to architects
```
#### ⚡ **Step 2: Summon Expert**
```
User: "I need a product manager expert"
AI: Instantly transforms into a professional product manager with complete knowledge and methodologies
```
#### 🎯 **Step 3: Professional Dialogue**
```
User: "Help me redesign the product page"
AI: Provides in-depth product strategy advice as a professional product manager
```
### 🚀 Why is this revolutionary?
**❌ Traditional approach:**
- Learn complex instruction syntax
- Remember various parameter configurations
- Worry about saying the wrong thing and breaking functionality
**✅ PromptX approach:**
- Natural conversation like talking to a real expert
- Say what you want to say - AI understands your intent
- Expert state remains active throughout the conversation
### 💡 Core Philosophy
> **Treat AI as a person, not software**
>
> No need for "correct commands" - just natural expression. AI will understand what expert you want and instantly switch identities.
---
## ⚡ Get Started - Choose Your Way
### 🎯 Method 1: PromptX Client (Recommended)
**For all users - One-click launch, zero configuration**
#### 📥 Download Client
| Platform | Download Link |
|----------|--------------|
| 🍎 **macOS (Apple Silicon)** | [Download .dmg](https://promptx.deepractice.ai/download/latest/promptx-desktop-mac-arm64.dmg) |
| 🍎 **macOS (Intel)** | [Download .dmg](https://promptx.deepractice.ai/download/latest/promptx-desktop-mac-x64.dmg) |
| 🪟 **Windows** | [Download .exe](https://promptx.deepractice.ai/download/latest/promptx-desktop-win32-x64-setup.exe) |
[📦 View All Releases & Platforms](https://promptx.deepractice.ai/download/) (Linux, Portable versions, etc.)
#### 🚀 Quick Start
1. **Start HTTP Service** - Open client, automatically runs MCP server
2. **Configure AI Application** - Add the following configuration to your Claude/Cursor or other AI tools:
```json
{
"mcpServers": {
"promptx": {
"type": "streamable-http",
"url": "http://127.0.0.1:5203/mcp"
}
}
}
```
3. **Start Chatting** - Say "Show me available experts" in your AI application
✅ No technical background required ✅ Visual management ✅ Auto-updates
💡 **Need help?** Join our [Discord Community](https://discord.gg/rdmPr54K) for support and discussions!
### 🔧 Method 2: Direct Run (Developers)
**Developers with Node.js environment can use directly:**
```json
{
"mcpServers": {
"promptx": {
"command": "npx",
"args": ["-y", "@promptx/mcp-server"]
}
}
}
```
### 🐳 Method 3: Docker (Production Ready)
**Deploy PromptX with Docker for production environments:**
```bash
docker run -d -p 5203:5203 -v ~/.promptx:/root/.promptx deepracticexs/promptx:latest
```
📚 **[Full Docker Documentation →](./docker/README.md)**
---
## 🎨 **Nuwa & Luban - PromptX's Creation Twins**
### 🎭 **Nuwa - AI Role Designer**
<div align="center">
<img src="assets/logo/nuwa-logo-backgroud.jpg" alt="Nuwa" width="120" style="border-radius: 50%; margin: 15px 0 25px 0;">
</div>
**One sentence, one expert. Natural language creates professional AI roles.**
💡 **Want to try Nuwa?** Say: "Activate Nuwa, I want to create an AI that understands both code and product"
<div align="center">
| 💭 **You Say** | 🎭 **Nuwa Creates** | ✨ **Result** |
|---|---|---|
| "I need someone who understands both code and product" | Technical Product Manager role with dual expertise | AI instantly becomes TPM with engineering + product skills |
| "Create a Python expert who teaches like a patient mentor" | Python Mentor role with teaching methodology | AI transforms into educational programming guide |
| "I want an AI that writes like Hemingway" | Literary Writing Expert with style analysis | AI adopts concise, powerful writing style |
</div>
### 🔧 **Luban - Tool Integration Master**
<div align="center">
<img src="assets/logo/luban-enchance.png" alt="Luban" width="120" style="border-radius: 50%; margin: 15px 0 25px 0;">
</div>
**Any API, any platform. 3 minutes from credential to working tool.**
💡 **Want to try Luban?** Say: "Activate Luban, I want AI to query our PostgreSQL database"
<div align="center">
| 💭 **You Say** | 🔧 **Luban Builds** | ✨ **Result** |
|---|---|---|
| "Connect to our Slack workspace" + webhook URL | Slack notification tool with channel targeting | AI can post to any Slack channel |
| "Let AI query our PostgreSQL" + connection string | Database tool with safe read-only queries | AI executes SQL and analyzes data |
| "Integrate with OpenAI API" + API key | AI platform tool with model selection | AI chains multiple AI services |
</div>
### ✍️ **Writer - Professional Content Creator**
**From concept to compelling content. Master of authentic, engaging writing.**
💡 **Want to try Writer?** Say: "Activate Writer, I need to write a tech blog that doesn't sound like AI"
<div align="center">
| 💭 **You Say** | ✍️ **Writer Creates** | ✨ **Result** |
|---|---|---|
| "Write a technical blog about our new feature" | Deep technical content with user stories | Engaging post that developers actually want to read |
| "I need marketing copy that doesn't sound like AI" | Human-like copy with personality and persuasion | Content that converts because it feels authentic |
| "Help me write a product launch announcement" | ISSUE methodology: conversational detail gathering | Rich product story, not cold corporate speak |
</div>
### 🚀 **Why This Changes Everything**
**Traditional AI Writing:** Templates → Generic content → Readers spot AI instantly → Trust collapse
**Writer Role:** Real conversation → Unique details → Anti-AI processing → Genuinely human content
**The magic: Nuwa gives AI knowledge, Luban gives AI power, Writer gives AI soul.**
---
## 🛠️ Built-in Tools - Ready-to-use Office Document Processing
PromptX comes with professional document processing tools, turning AI into your office assistant.
### 📊 Excel Tool
Turn AI into your data analysis assistant and report generation expert.
- Data analysis and insights
- Automated report generation
- Chart visualization
- Data processing automation
**[📖 Learn More](./packages/resource/resources/tool/excel-tool/README.md)** | [中文文档](./packages/resource/resources/tool/excel-tool/README.zh-CN.md)
### 📝 Word Tool
Turn AI into your document reading expert and professional writing assistant.
- Document reading and analysis
- Professional document creation
- Batch text replacement
- Format conversion
**[📖 Learn More](./packages/resource/resources/tool/word-tool/README.md)** | [中文文档](./packages/resource/resources/tool/word-tool/README.zh-CN.md)
### 📄 PDF Reader
Turn AI into your PDF reading expert with smart caching.
- Page-by-page reading
- Content analysis and extraction
- Image extraction
- Smart caching for faster access
**[📖 Learn More](./packages/resource/resources/tool/pdf-reader/README.md)** | [中文文档](./packages/resource/resources/tool/pdf-reader/README.zh-CN.md)
---
## ⭐ **Star Growth Trend**
<div align="center">
[](https://star-history.com/#Deepractice/PromptX&Date)
</div>
---
## 💝 **Sponsors**
<div align="center">
### [SignPath](https://signpath.io)
Windows desktop application code signing is provided by [SignPath.io](https://signpath.io), certificate by [SignPath Foundation](https://signpath.org).
</div>
---
## 🏢 **About**
<div align="center">
**Proudly brought to you by [Deepractice](https://github.com/Deepractice)**
*Making AI your professional partner*
🌐 [Official Site](https://deepractice.ai) | 🔧 [GitHub](https://github.com/Deepractice) | 📚 [Documentation](https://docs.deepractice.ai) | 💬 [Forum](https://x.deepractice.ai) | 🎮 [Discord](https://discord.gg/rdmPr54K) | 🚀 [Gateway Service](https://router.deepractice.ai)
### Connect with Founder
<img src="https://brands.deepractice.ai/images/sean-wechat-qrcode.jpg" alt="Sean's WeChat" width="200"/>
*Scan to connect with Sean (Founder & CEO) on WeChat*
</div>