@becrafter/prompt-manager 0.1.2 → 0.1.8

package/README.md

@@ -2,110 +2,294 @@
 
 [![npm version](https://badge.fury.io/js/%40becrafter%2Fprompt-manager.svg)](https://www.npmjs.com/package/@becrafter/prompt-manager)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node.js Version](https://img.shields.io/badge/node-%3E%3D22.20.0-brightgreen)]()
 
-> **一个提示词管理工具，帮你把常用的 AI 提示词整理成库，随时调用。**
+> 🚀 **让AI提示词管理变得简单而强大** - 支持MCP协议、AI优化、多界面管理的企业级提示词管理平台
 
-## 这是什么？
+## ✨ 核心特性
 
-想象一下，你经常用 AI 写代码、做翻译、写文案...每次都要重新输入类似的提示词，很麻烦。
+### 🎯 AI提示词管理
+- 📝 **模板化管理** - 将常用提示词保存为可复用的模板
+- 🔍 **智能搜索** - 支持关键词和语义搜索，快速找到所需提示词
+- 📁 **分组组织** - 支持文件夹分组，便于分类管理
+- 🔧 **参数化支持** - 支持变量替换，让提示词更灵活
 
-**Prompt Manager 就是帮你管理这些提示词的工具：**
+### 🤖 AI增强功能
+- ⚡ **AI优化** - 使用AI自动优化你的提示词质量
+- 🔄 **迭代改进** - 支持多轮迭代优化，持续提升效果
+- 📊 **会话跟踪** - 跟踪优化过程中的迭代状态
 
-- 📝 把提示词保存成模板，随时调用
-- 🔍 快速搜索你需要的提示词
-- 🌐 通过网页界面管理，简单直观
-- 💻 也可以作为服务运行，让其他程序调用
+### 🔌 开放生态
+- 🔗 **MCP协议** - 完全兼容Model Context Protocol标准
+- 🛠️ **ToolM系统** - 内置工具沙箱，支持扩展自定义工具
+- 🌐 **API驱动** - 提供完整的REST API，支持程序化调用
+- 📡 **流式传输** - 支持HTTP流式传输，实时获取结果
 
-**简单说：就像收藏夹，但专门用来管理 AI 提示词。**
+### 💻 多界面支持
+- 🖥️ **桌面应用** - 开箱即用的Electron桌面应用
+- 🌐 **Web管理** - 现代化的Web管理界面
+- 💻 **命令行** - 强大的CLI工具，支持脚本集成
 
-## 快速开始
+## 🚀 快速开始
 
-### 方式一：命令行使用（适合技术人员）
+### 方式一：桌面应用（推荐）
 
 ```bash
-# 1. 安装
+# 1. 下载并安装桌面应用
+npm run desktop:build
+
+# 2. 双击运行安装包
+# 3. 点击系统托盘图标开始使用
+```
+
+**效果展示：**
+![演示动画](./docs/assets/demo.gif)
+
+
+![](./docs/assets/1.png)
+![](./docs/assets/2.png)
+![](./docs/assets/3.png)
+![](./docs/assets/4.png)
+![](./docs/assets/5.png)
+![](./docs/assets/6.png)
+![](./docs/assets/7.png)
+![](./docs/assets/8.png)
+
+
+
+### 方式二：命令行运行
+
+#### 安装 CLI 工具
+
+```bash
+# 全局安装（推荐）
 npm install -g @becrafter/prompt-manager
 
-# 2. 启动服务
+# 或本地安装
+npm install @becrafter/prompt-manager
+npx @becrafter/prompt-manager
+```
+
+#### 基本使用
+
+```bash
+# 启动服务（默认端口 5621）
 prompt-manager
 
-# 3. 打开浏览器访问
+# 指定端口和提示词目录
+prompt-manager --prompts-dir ./my-prompts --port 8080
+
+# 查看帮助信息
+prompt-manager --help
+```
+
+#### CLI 参数说明
+
+```bash
+# 核心参数
+-p, --prompts-dir <目录>    指定 prompts 文件所在目录
+-P, --port <端口>          指定服务器端口 (默认: 5621)
+-h, --help                 显示帮助信息
+
+# 示例
+prompt-manager --prompts-dir ./examples/prompts
+prompt-manager -p /path/to/prompts -P 3000
+```
+
+### 方式三：开发环境
+
+```bash
+# 克隆项目
+git clone https://github.com/BeCrafter/prompt-manager.git
+cd prompt-manager
+
+# 安装依赖
+npm install
+
+# 启动开发服务器
+npm run dev:all
+
+# 访问管理界面
 # http://localhost:5621/admin
 ```
 
-就这么简单！服务启动后，打开浏览器就能看到管理界面。
+## 🎨 使用场景
+
+### 👥 团队协作
+- **共享提示词库** - 团队成员共享高质量提示词模板
+- **标准化流程** - 统一团队的AI使用规范和最佳实践
+- **知识传承** - 新成员快速上手，避免重复造轮子
+
+### 🤖 AI开发者
+- **提示词优化** - 使用AI自动改进提示词效果
+- **版本管理** - 跟踪提示词的演进历史
+- **效果对比** - A/B测试不同版本的提示词效果
+
+### 🛠️ 程序集成
+- **API调用** - 通过REST API集成到现有系统中
+- **MCP协议** - 与支持MCP的AI客户端无缝集成
+- **自动化流程** - 在CI/CD流程中自动调用提示词
+
+## 📋 核心功能
+
+### 提示词管理
+- ✅ 创建和编辑提示词模板
+- ✅ 支持YAML格式配置
+- ✅ 参数化变量替换
+- ✅ 分组和标签管理
+- ✅ 启用/禁用控制
+
+### AI优化服务
+- ✅ 多模型支持（OpenAI、Google等）
+- ✅ 流式优化输出
+- ✅ 迭代优化模式
+- ✅ 优化历史记录
+
+### 工具生态
+- ✅ 内置常用工具（文件操作、PDF读取等）
+- ✅ 沙箱安全执行
+- ✅ 自定义工具扩展
+- ✅ 工具市场机制
+
+#### 🛡️ 工具沙箱机制
+
+Prompt Manager 采用创新的工具沙箱机制，确保工具安全可控：
+
+**工作原理：**
+1. **系统工具存储** - 内置工具位于 `packages/resources/tools/`
+2. **沙箱环境同步** - 首次运行时自动复制到 `~/.prompt-manager/toolbox/`
+3. **隔离执行** - 每个工具在独立沙箱目录中运行
+4. **权限控制** - 自动生成 package.json 管理工具权限
+
+**内置工具列表：**
+- **filesystem** - 文件系统操作（读写文件、目录管理）
+- **file-reader** - 高级文件读取（支持多种格式）
+- **pdf-reader** - PDF 文档解析和内容提取
+- **chrome-devtools** - 浏览器自动化和网页抓取
+- **playwright** - 现代网页自动化测试
+- **ollama-remote** - 本地 AI 模型集成
+- **todolist** - 任务管理和待办事项
+
+**自定义工具开发：**
+```javascript
+// 工具结构示例
+export default {
+  getMetadata() {
+    return {
+      name: 'my-tool',
+      description: '我的自定义工具',
+      version: '1.0.0'
+    };
+  },
+
+  getSchema() {
+    return {
+      type: 'object',
+      properties: {
+        input: { type: 'string' }
+      }
+    };
+  },
+
+  async execute({ input }) {
+    // 工具逻辑
+    return { result: `处理结果: ${input}` };
+  }
+};
+```
+
+### 界面体验
+- ✅ 现代化Web界面
+- ✅ 原生桌面应用
+- ✅ 命令行工具
+- ✅ 响应式设计
 
-### 方式二：桌面应用（适合所有人）
+## 🛠️ 环境要求
 
-下载桌面应用，双击运行，点击菜单栏图标就能管理提示词。
+### 系统要求
 
-> 💡 桌面应用正在开发中，敬请期待
+#### 通用要求
+- **Node.js**: v22.20.0+ (推荐使用 nvm 管理版本)
+- **操作系统**: macOS, Windows, Linux
+- **内存**: 至少 512MB 可用内存
+- **磁盘空间**: 至少 200MB 可用空间（包含工具沙箱）
 
-## 怎么用？
+#### NPM 包使用要求
+- **Node.js**: v22.20.0+ (必须版本)
+- **网络**: 需要网络连接（用于 AI 模型调用）
+- **权限**: 需要写权限创建用户配置目录
+- **原生模块**: node-pty (会自动编译)
 
-### 1. 创建提示词
+#### 开发环境额外要求
+- **Git**: 用于代码管理
+- **npm**: v8.0.0+ (随 Node.js 安装)
+- **Python**: v3.7+ (用于原生模块编译)
 
-在管理界面点击"新建"，输入提示词内容：
+### 环境检查
 
-```yaml
-name: 代码审查
-description: 帮我审查代码质量
-messages:
-  - role: user
-    content:
-      text: |
-        请审查以下代码，找出潜在问题：
-        
-        {{code}}
+项目提供了便捷的环境检查脚本：
+
+```bash
+# 自动检查开发环境
+npm run check:env
+
+# 或手动检查
+node --version  # 应显示 v22.x.x
+npm --version   # 检查 npm 版本
 ```
 
-### 2. 使用提示词
+### 常见问题
 
-保存后，你可以：
-- 在管理界面直接使用
-- 通过 API 调用（适合程序员）
-- 在支持 MCP 协议的 AI 客户端中使用
+#### Node.js 版本问题
+```bash
+# 使用 nvm 切换版本
+nvm install 22
+nvm use 22
 
-### 3. 管理提示词
+# 或从官网下载 v22.20.0
+# https://nodejs.org/
+```
 
-- 📁 按文件夹分类整理
-- 🔍 快速搜索
-- ✏️ 随时编辑
-- 🗑️ 删除不需要的
+#### 依赖编译问题
+```bash
+# 修复 node-pty 编译问题
+npm run fix:pty
+```
 
-## 常见使用场景
+#### NPM 包使用问题
 
-**场景 1：团队共享提示词**
-- 把团队常用的提示词整理在一起
-- 新成员直接使用，不用重复写
+**Q: 安装后提示权限错误？**
+```bash
+# 使用管理员权限安装（macOS/Linux）
+sudo npm install -g @becrafter/prompt-manager
 
-**场景 2：个人知识库**
-- 把好用的提示词保存下来
-- 按项目、按类型分类管理
+# 或使用 nvm 管理的 Node.js
+nvm use 22
+npm install -g @becrafter/prompt-manager
+```
 
-**场景 3：集成到其他工具**
-- 作为服务运行
-- 其他程序通过 API 调用你的提示词库
+**Q: 启动时报错 "node-pty module not available"？**
+```bash
+# 重新编译原生模块
+npm rebuild node-pty
 
-## 提示词格式
+# 或在项目目录中运行
+cd /usr/local/lib/node_modules/@becrafter/prompt-manager
+npm rebuild node-pty
+```
 
-提示词用 YAML 格式保存，很简单：
+**Q: 如何查看工具沙箱目录？**
+```bash
+# 查看沙箱目录内容
+ls -la ~/.prompt-manager/toolbox/
 
-```yaml
-name: 提示词名称
-description: 简短描述
-messages:
-  - role: user
-    content:
-      text: 提示词内容，可以用 {{变量名}} 来占位
-arguments:
-  - name: 变量名
-    description: 变量说明
-    type: string
-enabled: true
+# 查看工具日志
+ls -la ~/.prompt-manager/toolbox/*/logs/
 ```
 
-**示例：代码审查提示词**
+## 📝 提示词格式
+
+Prompt Manager 使用简洁的 YAML 格式定义提示词：
 
 ```yaml
 name: code-review
@@ -115,61 +299,57 @@ messages:
     content:
       text: |
         请审查这段 {{language}} 代码：
-        
+
         ```{{language}}
         {{code}}
         ```
-        
-        请指出：
-        1. 潜在问题
-        2. 改进建议
+
+        请指出潜在问题和改进建议
 arguments:
   - name: language
     description: 编程语言
     type: string
+    required: true
   - name: code
     description: 要审查的代码
     type: string
+    required: true
 enabled: true
 ```
 
-## 配置说明
+### 参数支持
+- **变量替换**: 使用 `{{变量名}}` 语法
+- **类型支持**: string, number, boolean
+- **可选参数**: 设置 `required: false`
 
-### 命令行参数
+### 分组管理
+- **文件夹分组**: 将提示词放在子目录中自动分组
+- **分组元数据**: 在 `.group.json` 中定义分组信息
+
+## ⚙️ 配置和部署
 
+### 命令行参数
 ```bash
-prompt-manager --port 6000              # 指定端口
+prompt-manager --port 5621              # 指定端口
 prompt-manager --prompts-dir ./prompts  # 指定提示词目录
 ```
 
 ### 环境变量
-
-创建 `.env` 文件（可选）：
-
 ```env
 SERVER_PORT=5621
 ADMIN_USERNAME=admin
-ADMIN_PASSWORD=你的密码
+ADMIN_PASSWORD=your_password
+LOG_LEVEL=info
 ```
 
-## 常见问题
-
-**Q: 提示词保存在哪里？**  
-A: 默认保存在 `~/.prompt-manager/prompts` 目录
-
-**Q: 可以多人使用吗？**  
-A: 可以，把提示词目录共享，或者部署为服务供团队使用
-
-**Q: 支持哪些 AI 客户端？**  
-A: 支持 MCP 协议的客户端都可以使用（如 Claude Desktop）
+### 存储位置
+- **提示词**: `~/.prompt-manager/prompts`
+- **配置**: `~/.prompt-manager/.env`
+- **日志**: `~/Library/Application Support/@becrafter/prompt-desktop/`
 
-**Q: 需要编程基础吗？**  
-A: 使用网页界面不需要，但作为服务运行需要基本的命令行知识
-
-## 技术细节（可选看）
+## 🔧 开发者指南
 
 ### 作为库使用
-
 ```javascript
 import { startServer } from '@becrafter/prompt-manager-core';
 
@@ -181,43 +361,46 @@ await startServer({
 });
 ```
 
-### API 接口
-
-- `GET /prompts` - 获取提示词列表
-- `GET /api/prompts/:name` - 获取单个提示词
-- `POST /api/prompts` - 创建/更新提示词
-- `POST /process` - 处理提示词（支持参数替换）
+### 开发环境
+```bash
+git clone https://github.com/BeCrafter/prompt-manager.git
+cd prompt-manager
+npm install
+npm run dev:all  # 启动所有服务
+```
 
-### MCP 协议支持
+## 📡 API 概览
 
-支持以下 MCP 工具：
-- `search_prompts` - 搜索提示词
-- `get_prompt` - 获取提示词
-- `reload_prompts` - 重新加载
+### 管理 API (需要认证)
+- `GET /adminapi/prompts` - 获取提示词列表
+- `POST /adminapi/prompts` - 创建/更新提示词
+- `GET /adminapi/optimization/models` - 获取AI模型列表
+- `POST /adminapi/prompts/optimize` - AI优化提示词
 
-## 开发
+### 公开 API (无需认证)
+- `GET /openapi/prompts` - 获取启用的提示词
+- `POST /openapi/process` - 处理提示词
 
-```bash
-# 克隆项目
-git clone https://github.com/BeCrafter/prompt-server.git
-cd prompt-server
+### MCP 协议支持
+- `search_prompts` - 搜索提示词
+- `get_prompt` - 获取提示词详情
+- `reload_prompts` - 重新加载提示词
 
-# 安装依赖
-npm install
+## 🤝 贡献指南
 
-# 启动开发服务器
-npm run dev
-```
+我们欢迎各种形式的贡献！
 
-## 许可证
+1. **Bug 报告** - [提交 Issue](https://github.com/BeCrafter/prompt-manager/issues)
+2. **功能建议** - 在 Discussions 中分享你的想法
+3. **代码贡献** - Fork 并提交 Pull Request
+4. **文档改进** - 帮助完善文档和示例
 
-MIT License
+## 📄 许可证
 
-## 相关链接
+MIT License - 详见 [LICENSE](LICENSE) 文件
 
-- [npm 包](https://www.npmjs.com/package/@becrafter/prompt-manager)
-- [问题反馈](https://github.com/BeCrafter/prompt-server/issues)
+## 🙏 致谢
 
----
+感谢所有贡献者和用户，让这个项目变得更好！
 
-**Made with ❤️ by BeCrafter**
+**Made with ❤️ by BeCrafter Team**

package/app/cli/commands/start.js

@@ -1,15 +1,39 @@
-import { normalizeArgv } from '../support/argv.js';
 import { registerSignalHandlers } from '../support/signals.js';
 
+// 简单的 CLI 参数解析
+function parseCLIArgs(args) {
+  const options = {};
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+    if (arg === '--prompts-dir' || arg === '-p') {
+      options.promptsDir = args[i + 1];
+      i++;
+    } else if (arg === '--port' || arg === '-P') {
+      options.port = parseInt(args[i + 1]);
+      i++;
+    } else if (arg === '--help' || arg === '-h') {
+      options.help = true;
+    } else if (arg === '--version' || arg === '-v') {
+      options.version = true;
+    }
+  }
+  return options;
+}
+
 export async function startCommand(rawArgs, options = {}) {
-  const { scriptPath } = options;
-  process.argv = normalizeArgv(rawArgs, scriptPath);
+  const cliOptions = parseCLIArgs(rawArgs);
+
+  // 如果请求帮助，显示 CLI 帮助
+  if (cliOptions.help) {
+    console.log(`Prompt Server CLI\n\n用法:\n  prompt-manager [command] [options]\n\n可用命令:\n  start  启动服务 (默认)\n  run    启动服务 (同 start)\n\n选项:\n  -p, --prompts-dir <目录>    指定 prompts 文件所在目录\n  -P, --port <端口>          指定服务器端口 (默认: 5621)\n  -h, --help                 显示此帮助信息\n\n示例:\n  prompt-manager --port 6000\n  prompt-manager start --prompts-dir ./examples/prompts`);
+    return;
+  }
 
   const { startServer, stopServer, getServerState } = await import('../../../packages/server/server.js');
 
   registerSignalHandlers(stopServer);
 
-  await startServer();
+  await startServer(cliOptions);
 
   const state = getServerState();
   console.log(`Prompt Server 已启动：${state.address}`);

package/app/cli/support/argv.js

@@ -2,6 +2,12 @@ import { fileURLToPath } from 'url';
 
 export function normalizeArgv(rawArgs, scriptPathOverride) {
   const execPath = process.execPath || 'node';
+
+  // 如果是全局安装的包，不需要修改 argv，因为 process.argv 已经正确设置
+  if (process.env.npm_config_global || process.env.npm_config_prefix) {
+    return [execPath, process.argv[1], ...(rawArgs || [])];
+  }
+
   const scriptPath = scriptPathOverride ?? fileURLToPath(new URL('../index.js', import.meta.url));
   return [execPath, scriptPath, ...(rawArgs || [])];
 }

package/env.example

@@ -0,0 +1,32 @@
+# 环境变量配置示例
+# 复制此文件为 .env 并根据需要修改
+SERVER_PORT=5621
+
+# Prompts目录路径 (默认: ~/.prompt-manager/prompts，可通过命令行覆盖)
+PROMPTS_DIR=$HOME/.prompt-manager/prompts
+
+# MCP服务器配置
+MCP_SERVER_NAME=prompt-manager
+MCP_SERVER_VERSION=0.1.8
+
+# 日志级别 (error, warn, info, debug)
+LOG_LEVEL=info
+
+# 最大prompt数量限制
+MAX_PROMPTS=1000
+
+# 管理员功能配置
+
+# 是否启用管理员功能
+ADMIN_ENABLE=true
+# 是否需要登录认证
+ADMIN_REQUIRE_AUTH=true
+# 管理员用户名
+ADMIN_USERNAME=admin
+# 理员密码
+ADMIN_PASSWORD=admin
+# 管理员路径
+ADMIN_PATH=/admin
+
+# 模型 API Key 配置
+OPENROUTER_API_KEY=your_openrouter_api_key_here