PromptX Logo

PromptX · AI应用原生专业能力增强系统

通过MCP协议为AI应用提供专业角色、记忆管理和知识体系,一行命令,让任何 AI 客户端秒变专业选手。

Stars npm version License CI Status

中文 | English | Issues

--- ### ✨ **一眼看懂 PromptX** PromptX 能做什么?简单来说,它让你的 AI 助手拥有了"大脑"和"记忆"。 - **🎭 专业角色扮演**: 提供覆盖不同领域的专家角色,让 AI 的回答更专业、更深入。 - **🧠 长期记忆与知识库**: AI能够记住关键信息和你的偏好,在持续的对话和工作中提供连贯、个性化的支持。 - **🔌 轻松集成**: 只需一行命令,即可为数十种主流 AI 应用(如 Claude、Cursor)无缝启用这些强大功能。
### 📸 **配置成功后的使用效果** #### **1. 发现并激活专业角色** *使用 `promptx_hello` 发现可用角色,再用 `promptx_action` 激活,AI即刻变身领域专家。* 角色发现与激活 #### **2. 拥有智能记忆** *使用 `promptx_remember` 保存关键信息,AI将在后续的交流中主动运用这些知识。* 记忆功能 --- ## ⚠️ **项目状态说明** PromptX 目前处于 **初始开发阶段**,我们正在积极完善功能和修复问题。在达到正式稳定版本之前,您可能会遇到一些使用上的问题或不稳定情况。 **我们诚恳地请求您的理解和支持!** 🙏 ### 📞 **遇到问题?获取帮助!** 如果您在使用过程中遇到任何问题,请通过以下方式联系我们: - 🐛 **提交 Issue**: [GitHub Issues](https://github.com/Deepractice/PromptX/issues) - 详细描述问题,我们会尽快回复 - 💬 **直接联系**: 添加开发者微信 `deepracticex` 获取即时帮助 - 📧 **邮件联系**: 发送邮件至 `sean@deepracticex.com` 获取技术支持 - 📱 **技术交流群**: 扫描下方二维码加入我们的技术交流群 您的反馈对我们非常宝贵,帮助我们快速改进产品质量! ✨ --- ## 🚀 **一键启动,30秒完成配置** 打开配置文件,将下面的 `promptx` 配置代码复制进去。这是最简单的 **零配置模式**,PromptX 会自动为您处理一切。 ```json { "mcpServers": { "promptx": { // 指定使用 npx 运行 promptx 服务 "command": "npx", // 启动参数配置 "args": [ "-y", // 自动确认 "-f", // 强制刷新缓存 "--registry", // 指定镜像源 "https://registry.npmjs.org", // 使用官方镜像 "dpml-prompt@beta", // 使用稳定测试版 "mcp-server" // 启动服务 ] } } } ``` **🎯 就这么简单!** 保存文件并重启您的AI应用,PromptX 就已成功激活。 > **💡 提示:** 配置中特意指定了官方镜像源 `registry.npmjs.org`,这可以避免因使用非官方镜像导致的安装问题。如果您发现安装很慢,建议使用代理工具加速,而不是切换到其他镜像源。 ### 🌐 **高级配置:HTTP 模式支持** 除了上述本地模式外,PromptX 还支持 **HTTP 模式**,适用于远程部署或特殊网络环境: ```bash # 启动 HTTP 模式服务器 npx -f -y dpml-prompt@beta mcp-server --transport http --port 3000 ``` 然后在客户端配置中使用: ```json { "mcpServers": { "promptx": { "url": "http://localhost:3000/mcp" } } } ``` 📖 **[完整安装配置指南](https://github.com/Deepractice/PromptX/wiki/PromptX-MCP-Install)** - 包含各种客户端的详细配置方法和故障排除 ### 不知道MCP是怎么? [点击查看 MCP幼儿园教程 BiliBili](https://www.bilibili.com/video/BV1HFd6YhErb) 目前所有支持 MCP 协议的 AI 客户端都可以使用 PromptX。主要包括:**Claude Desktop**、**Cursor**、**Windsurf**、**Cline**、**Zed**、**Continue** 等主流 AI 编程工具,以及更多正在接入中的应用。 --- ### ⚙️ **工作原理** 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应用,最终呈现给您。 --- **🎯 配置完成后,您的AI应用将自动获得6个专业工具:** - `promptx_init`: 🏗️ **系统初始化** - 自动准备工作环境。 - `promptx_hello`: 👋 **角色发现** - 浏览所有可用的专家角色。 - `promptx_action`: ⚡ **角色激活** - 一键变身指定领域的专家。 - `promptx_learn`: 📚 **知识学习** - 让AI学习特定的知识或技能。 - `promptx_recall`: 🔍 **记忆检索** - 从记忆库中查找历史信息。 - `promptx_remember`: 💾 **经验保存** - 将重要信息存入长期记忆。 📖 **[查看完整MCP集成指南](docs/mcp-integration-guide.md)** --- ## 📋 **实践案例: Legacy Lands Library**
Legacy Lands Library Logo
#### 📖 项目概述 **项目名称:** 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增长趋势** [![Star History Chart](https://api.star-history.com/svg?repos=Deepractice/PromptX&type=Date)](https://star-history.com/#Deepractice/PromptX&Date) --- ### **🤝 贡献与交流** 我们欢迎任何形式的贡献和反馈! - 🌿 **[分支策略](docs/BRANCHING.md)** - 分支管理和发布流程 - 🚀 **[发布流程](docs/RELEASE.md)** - 版本管理和发布文档 扫码加入技术交流群: 技术交流群 --- ## 📄 **许可证** [MIT License](LICENSE) - 让AI专业能力触手可及