@becrafter/prompt-manager 0.0.16 → 0.0.19

package/IFLOW.md

@@ -0,0 +1,175 @@
+# Prompt Manager 项目概述
+
+## 项目简介
+
+Prompt Manager 是一个基于 MCP（Model Context Protocol）协议的 Prompt 管理服务。它支持 HTTP 流式传输、提供 Web 管理界面和桌面应用，能够将静态提示词模板转换为可通过 API 调用的动态服务。
+
+核心特性包括：
+- 完全兼容模型上下文协议（MCP）
+- 基于 StreamableHTTP 协议优化的 HTTP 流式传输
+- 自动发现子目录中的 prompt 文件
+- 支持命令行参数和环境变量配置
+- 内置 Electron 菜单应用，可一键启动/停止服务
+- 提供 Web 管理界面，方便创建、编辑和管理提示词
+
+## 技术栈
+
+- **后端**: Node.js (>=18.0.0), Express.js
+- **前端**: 内置管理界面使用原生 JavaScript 和 Codemirror
+- **协议**: MCP (Model Context Protocol)
+- **桌面应用**: Electron
+- **包管理**: npm/pnpm
+
+## 项目结构
+
+```
+prompt-manager/
+├── app/
+│   ├── cli/            # 命令行命令分发与共享工具
+│   └── desktop/        # Electron 菜单应用
+├── packages/
+│   ├── admin-ui/       # 内置管理后台静态资源
+│   └── server/         # 服务端核心逻辑
+├── examples/
+│   └── prompts/        # 随包示例提示词（首次启动会同步到 ~/.prompt-manager/prompts）
+├── scripts/            # 安装/维护脚本（如 env 同步）
+├── bin/                # 可执行入口
+└── package.json
+```
+
+## 构建和运行
+
+### 安装依赖
+
+在项目根目录运行：
+
+```bash
+npm install
+```
+
+### 启动开发服务器
+
+```bash
+# 启动服务端开发服务器
+npm run dev
+
+# 启动桌面应用开发环境
+npm run desktop:dev
+```
+
+### 构建桌面应用
+
+```bash
+# 构建桌面应用安装包
+npm run desktop:build
+```
+
+### 命令行使用
+
+```bash
+# 使用默认配置启动
+prompt-manager
+
+# 指定提示词目录
+prompt-manager --prompts-dir ./my-prompts
+
+# 指定端口
+prompt-manager --port 5621
+
+# 显式使用 start/run 命令
+prompt-manager start --port 6000
+prompt-manager run --prompts-dir ./examples/prompts
+
+# 获取帮助/版本信息
+prompt-manager --help
+prompt-manager --version
+```
+
+## 开发约定
+
+1. **代码风格**: 项目使用 ES6 模块系统，遵循标准的 JavaScript 编码规范。
+2. **目录结构**: 
+   - `app/` 目录包含客户端相关代码（CLI 和桌面应用）
+   - `packages/` 目录包含服务端核心逻辑和管理界面
+   - `examples/` 目录包含示例提示词文件
+3. **配置管理**: 支持通过命令行参数、环境变量和配置文件进行配置。
+4. **日志记录**: 使用自定义 logger 模块进行日志记录。
+5. **错误处理**: 统一的错误处理机制，关键操作都有适当的错误捕获和处理。
+
+## API 接口
+
+### MCP 协议接口
+
+服务器实现了 MCP 协议，支持以下工具：
+
+- `search_prompts`: 搜索提示词
+- `get_prompt`: 获取指定提示词的完整内容
+- `reload_prompts`: 重新加载所有提示词（暂未启用）
+
+### Web 管理接口
+
+1. **获取提示词列表**
+   ```
+   GET /prompts[?search=关键词]
+   ```
+
+2. **获取单个提示词详情**
+   ```
+   GET /api/prompts/:name[?path=文件路径]
+   ```
+
+3. **创建/更新提示词**
+   ```
+   POST /api/prompts
+   ```
+
+4. **删除提示词**
+   ```
+   DELETE /api/prompts/:name[?path=文件路径]
+   ```
+
+5. **切换提示词启用状态**
+   ```
+   POST /api/prompts/:name/toggle[?path=文件路径]
+   ```
+
+6. **处理提示词**
+   ```
+   POST /process
+   ```
+
+7. **分组管理**
+   - 获取所有分组列表: `GET /api/groups`
+   - 创建新分组: `POST /api/groups`
+   - 重命名分组: `PATCH /api/groups/rename`
+   - 更新分组启用状态: `PATCH /api/groups/status`
+   - 删除分组: `DELETE /api/groups?path=分组路径`
+
+## 桌面应用
+
+位于 `app/desktop` 目录，使用 Electron 构建的菜单栏应用，提供以下功能：
+
+- 启/停服务
+- 复制服务地址
+- 打开管理后台
+- 检查更新
+- 关于服务信息
+
+## 提示词格式
+
+提示词文件使用 YAML 格式，需要包含以下基本结构：
+
+```yaml
+name: prompt-name
+description: 提示词描述
+messages:
+  - role: user
+    content:
+      text: 提示词内容，支持 {{参数名}} 格式的参数替换
+arguments:
+  - name: 参数名
+    description: 参数描述
+    type: string|number|boolean
+    required: true|false
+enabled: true|false  # 是否启用该提示词
+```

package/README.md

@@ -1,17 +1,19 @@
-# MCP Prompt Server
+# Prompt Manager
 
 [![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%3D18.0.0-brightgreen)](https://nodejs.org/)
 
-一个基于 模型上下文协议（MCP） 的 Prompt 管理服务器 。可以将分散的、静态的提示词模板，转变为一个可通过 API 调用的、可动态配置的、可复用的服务，从而更高效地管理和使用 AI 提示词。
+一个基于MCP协议的Prompt管理服务，支持HTTP流式传输、Web管理界面和桌面应用，可将静态提示词模板转换为可通过API调用的动态服务。
 
 ## 核心特性
 
-- 🛠️ **完整接口**：提供提示词列表、处理、帮助和版本信息等接口
+- 🛠️ **MCP协议支持**：完全兼容模型上下文协议（MCP），可与各种AI客户端集成
+- 🌐 **HTTP流式传输**：基于StreamableHTTP协议优化，提供稳定的长连接支持
 - 📁 **递归扫描**：自动发现子目录中的 prompt 文件
 - ⚙️ **灵活配置**：支持命令行参数和环境变量配置
-- 🖥️ **原生桌面壳**：内置 Electron 菜单应用，可一键启动/关闭服务，并内嵌管理后台
+- 🖥️ **原生桌面壳**：内置 Electron 菜单应用，可一键启动/停止服务，并内嵌管理后台
+- 📋 **管理界面**：提供Web管理界面，方便创建、编辑和管理提示词
 
 ## 快速开始
 
@@ -102,7 +104,7 @@ npm run desktop:build
 
 ### 升级机制
 
-菜单中的 “检查更新” 会：
+菜单中的 "检查更新" 会：
 
 1. 读取当前运行的服务版本（`app.getPath('userData')/prompt-manager/package.json`）
 2. 对比 npm Registry 上的最新版本
@@ -110,7 +112,7 @@ npm run desktop:build
 4. 通过 `npm install --omit=dev` 在沙盒目录中重新安装依赖
 5. 保留示例 `examples/prompts` 目录（若存在），用户自定义数据保存在 `~/.prompt-manager/prompts`，无需额外迁移
 
-整个过程无需系统层面的 Node/npm，真正实现“装上即用”。
+整个过程无需系统层面的 Node/npm，真正实现"装上即用"。
 
 ## 配置选项
 
@@ -130,117 +132,79 @@ npm run desktop:build
 | `MCP_SERVER_NAME` | 服务器名称 | `prompt-manager` |
 | `SERVER_PORT` | 服务器端口 | `5621` |
 | `PROMPTS_DIR` | Prompts目录路径 | `~/.prompt-manager/prompts` |
-| `MCP_SERVER_VERSION` | 服务器版本 | `0.0.16` |
+| `MCP_SERVER_VERSION` | 服务器版本 | `0.0.19` |
 | `LOG_LEVEL` | 日志级别 (error, warn, info, debug) | `info` |
 | `MAX_PROMPTS` | 最大prompt数量限制 | `100` |
 | `RECURSIVE_SCAN` | 是否启用递归扫描子目录 | `true` |
+| `ADMIN_ENABLE` | 是否启用管理界面 | `true` |
+| `ADMIN_PATH` | 管理界面路径 | `/admin` |
+| `ADMIN_USERNAME` | 管理员用户名 | `admin` |
+| `ADMIN_PASSWORD` | 管理员密码 | `admin` |
 
 > 安装或首次运行时，会自动将 `env.example` 内容写入 `~/.prompt-manager/.env`（如果该文件尚未存在），方便在系统范围内共享配置。
 
 ## API 接口
 
-### 获取服务器信息
+### MCP协议接口
 
-```
-GET /
-```
+服务器实现了MCP协议，支持以下工具：
 
-返回服务器基本信息和可用接口列表。
+- `search_prompts`: 搜索提示词
+- `get_prompt`: 获取指定提示词的完整内容
+- `reload_prompts`: 重新加载所有提示词
 
-### 获取提示词列表
+### Web管理接口
+
+#### 获取提示词列表
 
 ```
-GET /prompts
+GET /prompts[?search=关键词]
 ```
 
-返回所有可用的提示词列表。
+返回所有可用的提示词列表，支持搜索功能。
 
-### 获取单个提示词详情
+#### 获取单个提示词详情
 
 ```
-GET /prompts/:name
+GET /api/prompts/:name[?path=文件路径]
 ```
 
 返回指定名称的提示词详细信息。
 
-### 创建新提示词
+#### 创建/更新提示词
 
 ```
-POST /prompts
+POST /api/prompts
 ```
 
-创建新的提示词文件。
+创建或更新提示词文件。
 
 请求体示例：
 ```json
 {
   "name": "my-prompt",
-  "description": "我的自定义提示词",
-  "messages": [
-    {
-      "role": "user",
-      "content": {
-        "text": "这是一个{{参数}}示例"
-      }
-    }
-  ],
-  "arguments": [
-    {
-      "name": "参数",
-      "description": "示例参数",
-      "type": "string",
-      "required": true
-    }
-  ]
+  "group": "default",
+  "yaml": "name: my-prompt\ndescription: 我的自定义提示词\nmessages:\n  - role: user\n    content:\n      text: 这是一个{{参数}}示例\n"
 }
 ```
 
-### 更新提示词
+#### 删除提示词
 
 ```
-PUT /prompts/:name
+DELETE /api/prompts/:name[?path=文件路径]
 ```
 
-更新现有的提示词文件。修改前会自动创建备份。
-
-请求体格式与创建相同。
+删除指定的提示词文件。
 
-### 删除提示词
+#### 切换提示词启用状态
 
 ```
-DELETE /prompts/:name
+POST /api/prompts/:name/toggle[?path=文件路径]
 ```
 
-删除指定的提示词文件。删除前会自动创建备份。
+切换提示词的启用/禁用状态。
 
-### 验证YAML格式
-
-```
-POST /prompts/validate
-```
-
-验证提示词YAML格式是否正确。
-
-请求体示例：
-```yaml
-yaml: |
-  name: test-prompt
-  description: 测试提示词
-  messages:
-    - role: user
-      content:
-        text: 测试内容
-```
-
-### 获取备份列表
-
-```
-GET /backups
-```
-
-获取所有提示词备份文件列表。
-
-### 处理提示词
+#### 处理提示词
 
 ```
 POST /process
@@ -259,21 +223,37 @@ POST /process
 }
 ```
 
-### 获取帮助信息
+#### 分组管理
+
+```
+GET /api/groups
+```
+
+获取所有分组列表。
 
 ```
-GET /help
+POST /api/groups
 ```
 
-返回服务器使用帮助信息。
+创建新分组。
+
+```
+PATCH /api/groups/rename
+```
+
+重命名分组。
+
+```
+PATCH /api/groups/status
+```
 
-### 获取版本信息
+更新分组启用状态。
 
 ```
-GET /version
+DELETE /api/groups?path=分组路径
 ```
 
-返回服务器版本信息。
+删除分组（仅当分组为空时）。
 
 ## 提示词格式
 
@@ -286,6 +266,12 @@ messages:
   - role: user
     content:
       text: 提示词内容，支持 {{参数名}} 格式的参数替换
+arguments:
+  - name: 参数名
+    description: 参数描述
+    type: string|number|boolean
+    required: true|false
+enabled: true|false  # 是否启用该提示词
 ```
 
 ## 开发
@@ -323,4 +309,4 @@ npm run dev
 
 ## 许可证
 
-MIT License
+MIT License

package/app/desktop/assets/templates/about.html

@@ -0,0 +1,147 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8">
+  <title>关于 Prompt Manager</title>
+  <style>
+    /* 支持纵向滚动但隐藏滚动条 */
+    body {
+      margin: 0;
+      padding: 0;
+      font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif;
+      background: linear-gradient(135deg, #ffffff 0%, #ffffff 100%);
+      color: #333;
+      min-height: 100vh;
+      display: flex;
+      flex-direction: column;
+      align-items: center;
+      justify-content: center;
+      /* 支持纵向滚动 */
+      overflow-x: hidden;
+      overflow-y: auto;
+    }
+    
+    /* 针对WebKit浏览器隐藏滚动条 */
+    body::-webkit-scrollbar {
+      display: none;
+    }
+    
+    /* 针对Firefox浏览器隐藏滚动条 */
+    body {
+      scrollbar-width: none;
+      -ms-overflow-style: none;
+    }
+    
+    .container {
+      background: white;
+      border-radius: 12px;
+      box-shadow: 0 8px 30px rgba(0, 0, 0, 0.12);
+      padding: 30px;
+      width: 320px;
+      text-align: center;
+      transition: transform 0.3s ease;
+      /* 防止容器内容溢出 */
+      max-width: 100%;
+    }
+    
+    .container:hover {
+      transform: translateY(-2px);
+    }
+    
+    .logo {
+      width: 64px;
+      height: 64px;
+      /* background: linear-gradient(135deg, #dcdbdb 0%, #dcdbdb 100%); */
+      border-radius: 6px;
+      border: 1px solid #ccc;
+      margin: 0 auto 15px;
+      display: flex;
+      align-items: center;
+      justify-content: center;
+      font-size: 28px;
+      color: white;
+      font-weight: bold;
+    }
+    
+    .version-info {
+      background: #f8f9fa;
+      border-radius: 8px;
+      padding: 15px;
+      margin-bottom: 20px;
+      text-align: left;
+    }
+    
+    .version-item {
+      display: flex;
+      justify-content: space-between;
+      margin-bottom: 8px;
+      font-size: 14px;
+    }
+    
+    .version-item:last-child {
+      margin-bottom: 0;
+    }
+    
+    .label {
+      color: #7f8c8d;
+      font-weight: 500;
+    }
+    
+    .value {
+      color: #2c3e50;
+      font-weight: 500;
+    }
+    
+    .notification {
+      background: #e3f2fd;
+      border-left: 4px solid #2196f3;
+      padding: 12px;
+      border-radius: 0 8px 8px 0;
+      margin: 15px 0;
+      text-align: left;
+    }
+    
+    .notification-title {
+      font-weight: 600;
+      color: #1976d2;
+      margin: 0 0 5px 0;
+      font-size: 13px;
+    }
+    
+    .notification-content {
+      font-size: 12px;
+      color: #555;
+      margin: 0;
+    }
+  </style>
+</head>
+<body>
+  <div class="container">
+    <div class="logo">
+      <img src="data:image/png;base64,{{logoData}}" alt="Prompt Server Logo" width="64" height="64">
+    </div>
+    
+    <div class="version-info">
+      <div class="version-item">
+        <span class="label">服务版本:</span>
+        <span class="value">{{version}}</span>
+      </div>
+      <div class="version-item">
+        <span class="label">Electron:</span>
+        <span class="value">{{electronVersion}}</span>
+      </div>
+      <div class="version-item">
+        <span class="label">Node.js:</span>
+        <span class="value">{{nodeVersion}}</span>
+      </div>
+    </div>
+    
+    {{#if debugLogEnabled}}
+    <div class="notification">
+      <div class="notification-title">调试日志已开启</div>
+      <div class="notification-content">日志文件路径: {{logFilePath}}</div>
+    </div>
+    {{/if}}
+  </div>
+</body>
+</html>