Prompt MCP - 项目提示词管理工具

一个用于管理项目提示词的MCP（Model Context Protocol）工具，可以通过npx安装使用，与Cursor等支持MCP的编辑器无缝集成。

功能特性

• 📝 提示词管理：创建、读取、更新、删除提示词，支持批量删除
• 🏷️ 项目关联：将提示词与特定项目关联，支持项目级别的提示词管理
• 🏷️ 分类标签：为提示词添加分类和标签，便于组织和检索
• 🔍 搜索过滤：根据关键词、项目、标签搜索和过滤提示词
• 🎯 运行模式：支持三种运行模式（默认模式、节点模式、强制确认模式）
• 🔧 项目配置：基于项目配置文件（.z-prompt-mcp.json）管理项目设置
• 📋 节点规则：支持关键字匹配和节点规则，自动关联提示词
• ✅ 强制确认：支持重要操作前的用户确认机制
• 🚀 自动初始化：自动分析项目代码结构，批量创建节点提示词
• 💾 本地存储：数据存储在本地JSON文件中
• 🚀 npx支持：无需安装，直接使用
• 🌐 Web界面：提供直观的Web管理界面

安装

通过npx使用（推荐）

npx z-prompt-mcp init

本地安装

npm install -g z-prompt-mcp

快速开始

1. 初始化

npx z-prompt-mcp init

2. 创建项目

npx z-prompt-mcp project create "我的项目" --description "项目描述"

3. 创建提示词

npx z-prompt-mcp prompt create "代码审查" \
  --content "请审查以下代码，检查代码质量、性能和安全性问题" \
  --project "我的项目" \
  --tags "代码,审查,质量"

4. 在Cursor中配置

在Cursor的设置文件（~/.cursor/mcp.json 或 Cursor 设置中的 MCP 配置）中添加以下配置：

基础配置（仅MCP服务器）

{
  "mcpServers": {
    "z-prompt-mcp": {
      "command": "npx",
      "args": ["-y", "z-prompt-mcp", "server"],
      "env": {}
    }
  }
}

完整配置（MCP服务器 + Web界面）

{
  "mcpServers": {
    "z-prompt-mcp": {
      "command": "npx",
      "args": ["-y", "z-prompt-mcp", "server"],
      "env": {
        "ENABLE_WEB": "true",
        "PORT": "8079"
      }
    }
  }
}

配置说明：

• ENABLE_WEB: 设置为 "true" 时，会同时启动 Web 服务器
• PORT: Web 服务器的端口号（默认：8079）
• 使用 -y 参数可以自动确认安装，无需手动确认

配置完成后，重启 Cursor 即可使用。

运行模式

本工具支持三种运行模式，通过项目配置文件（.z-prompt-mcp.json）进行管理：

默认模式（default）

• 使用项目绑定的默认提示词规则
• 自动执行，无需用户确认
• 适用于常规开发场景

节点模式（node）

• 根据任务关键字自动匹配节点规则
• 自动关联匹配的提示词
• 支持多个节点规则匹配

强制确认模式（confirm）

• 节点规则匹配 + 用户确认
• 在执行重要操作前必须获得用户确认
• 支持自定义确认文本和超时设置
• 适用于需要严格控制的场景

项目配置文件

每个项目在根目录下会生成 .z-prompt-mcp.json 配置文件：

{
  "project_id": "550e8400-e29b-41d4-a716-446655440000",
  "project_name": "我的项目",
  "run_mode": {
    "mode": "confirm",
    "nodes": [
      {
        "keyword": "代码",
        "promptIds": [1, 2, 3]
      }
    ]
  }
}

初始化项目提示词

使用 init_prompt 工具可以自动分析项目代码结构，为关键代码节点批量创建提示词：

• 自动识别代码类型和架构层次
• 为每个节点创建对应的提示词
• 自动建立节点规则关联
• 支持多种编程语言和项目类型

Web界面使用

启动Web服务器

# 如果是全局安装
z-prompt-mcp web

# 如果是本地开发
npm run web

启动后，在浏览器中访问 http://localhost:8079 即可使用Web界面管理提示词和项目。

注意： 如果通过 MCP 配置启用了 Web 服务器，它会自动在后台启动，无需手动运行 web 命令。

Web界面功能

• 项目管理：创建、编辑、删除项目
• 提示词管理：创建、编辑、删除提示词
• 运行模式管理：配置项目运行模式和节点规则
• 搜索功能：快速搜索提示词内容
• 过滤功能：按项目和标签过滤提示词
• 响应式设计：支持桌面和移动设备

CLI命令

项目管理

# 创建项目
npx z-prompt-mcp project create <项目名称> [选项]

# 列出所有项目
npx z-prompt-mcp project list

# 删除项目
npx z-prompt-mcp project delete <项目名称>

提示词管理

# 创建提示词
npx z-prompt-mcp prompt create <标题> -c <内容> [选项]

# 列出提示词
npx z-prompt-mcp prompt list [选项]

# 搜索提示词
npx z-prompt-mcp prompt search <查询词>

# 删除提示词
npx z-prompt-mcp prompt delete <标题>

启动MCP服务器

npx z-prompt-mcp server

启动Web服务器

npx z-prompt-mcp web

MCP工具

配置完成后，您可以在 Cursor 中直接使用以下 MCP 工具：

提示词管理工具

• create_prompt - 创建提示词
• get_prompt - 获取提示词
• update_prompt - 更新提示词
• delete_prompt - 删除提示词
• delete_prompts - 批量删除提示词
• list_prompts - 列出提示词（支持过滤）
• search_prompts - 搜索提示词

项目管理工具

• get_project - 获取项目
• list_projects - 列出所有项目

运行模式工具

• run_mode - 获取当前项目的运行模式内置提示词
• get_run_mode_nodes - 获取当前项目运行模式的节点列表
• init_prompt - 分析项目代码结构，批量创建节点提示词

确认工具

• request_confirm_input - 显示强制确认输入框，要求用户确认后才能继续操作

API接口

Web界面提供以下REST API接口：

项目接口

• GET /api/projects - 获取所有项目
• GET /api/projects/:id - 获取特定项目
• POST /api/projects - 创建新项目
• PUT /api/projects/:id - 更新项目
• DELETE /api/projects/:id - 删除项目

提示词接口

• GET /api/prompts - 获取所有提示词（支持过滤）
• GET /api/prompts/search - 搜索提示词
• GET /api/prompts/:id - 获取特定提示词
• POST /api/prompts - 创建新提示词
• PUT /api/prompts/:id - 更新提示词
• DELETE /api/prompts/:id - 删除提示词

运行模式接口

• GET /api/run-modes - 获取所有运行模式
• GET /api/run-modes/:id - 获取特定运行模式
• POST /api/run-modes - 创建运行模式
• PUT /api/run-modes/:id - 更新运行模式
• DELETE /api/run-modes/:id - 删除运行模式

开发

本地开发

# 克隆仓库
git clone https://gitee.com/old-z/z-prompt-mcp.git
cd z-prompt-mcp

# 安装依赖
npm install

# 构建项目
npm run build

# 启动MCP服务器
npm start

# 启动Web服务器
npm run web

项目结构

z-prompt-mcp/
├── src/
│   ├── cli/           # CLI命令实现
│   ├── database/      # 数据库连接和操作
│   ├── handlers/      # 业务逻辑处理
│   ├── server.ts      # MCP服务器
│   └── web-server.ts # Web服务器
├── public/           # Web前端文件
│   ├── css/          # 样式文件
│   ├── js/           # JavaScript文件
│   └── index.html     # 主页面
├── dist/             # 编译后的文件
└── package.json

数据存储

数据存储在用户主目录的 .prompt-mcp 文件夹中：

• Windows: C:\Users\<用户名>\.prompt-mcp\db.json
• macOS (Intel & Apple Silicon): ~/.prompt-mcp/db.json
• Linux: ~/.prompt-mcp/db.json

项目配置文件存储在项目根目录：

• .z-prompt-mcp.json - 项目配置和运行模式设置

平台支持

本工具支持以下平台：

• ✅ Windows (x64)
• ✅ macOS Intel (x86_64)
• ✅ macOS Apple Silicon (arm64)
• ✅ Linux (x64, arm64)

所有平台上的功能和行为完全一致。

作者与联系方式

• 作者: z-prompt-mcp Contributors
• 邮箱: [email protected]
• 问题反馈: 如有问题或建议，请通过邮箱联系

许可证

本项目采用 GNU Affero General Public License v3.0 (AGPL-3.0)。

许可证说明

AGPL-3.0 是一个 copyleft 许可证，这意味着：

• ✅ 自由使用：您可以自由使用、修改和分发本软件
• ✅ 源代码可用：所有基于本软件的衍生作品必须保持开源
• ✅ 网络服务条款：即使通过 Web 服务提供软件，也必须向用户提供源代码
• ⚠️ 相同许可证：基于本代码的修改也必须使用 AGPL-3.0 许可证

重要提示

• 如果您修改了本软件并通过网络服务提供，必须向用户提供修改后的源代码
• 任何基于本软件的衍生作品都必须使用 AGPL-3.0 许可证
• 本软件按"原样"提供，不提供任何明示或暗示的担保

许可证全文

完整的许可证条款请查看 LICENSE 文件。

更多关于 AGPL-3.0 的信息，请访问：https://www.gnu.org/licenses/agpl-3.0.html