使用说明

项目简介

mcp-prompts (MCP Prompt Manager) 是一个基于 Model Context Protocol (MCP) 构建的服务器应用，专注于Prompt模板的管理和项目自动化编排。它允许用户创建、管理和应用Prompt模板，并利用模板和设计模式自动化软件项目的创建过程。该服务器支持文件系统和 PostgreSQL 数据库作为存储选项，并提供了备份和恢复功能，方便用户管理Prompt数据。

主要功能点

Prompt 模板管理: 提供创建、检索、更新和删除Prompt模板的功能，方便用户组织和维护Prompt。
模板变量支持: 允许在Prompt模板中使用变量，在运行时填充，实现Prompt的动态定制。
项目自动化编排: 通过预定义的项目模板和组件模板，自动化软件项目的创建，包括生成项目结构、文档和基本代码。
多种存储选项: 支持文件系统和 PostgreSQL 数据库两种存储方式，满足不同场景的需求。
数据库导出/导入与同步: 提供工具用于在文件系统和 PostgreSQL 数据库之间导出、导入和同步Prompt数据。
备份与恢复: 支持创建和恢复Prompt数据的备份，保障数据安全。
MCP 协议集成: 无缝集成 Model Context Protocol，作为 MCP 服务器为客户端提供服务。

安装步骤

前提条件:

Node.js 18 或更高版本
PostgreSQL (可选，用于数据库存储)
Docker (可选，用于容器化部署)

通过 NPM 安装 (推荐):

打开终端，运行以下命令全局安装 'mcp-prompt-manager':

npm install -g @sparesparrow/mcp-prompt-manager

安装完成后，即可通过命令 'mcp-prompt-manager' 启动服务器。

手动从源码安装:

克隆仓库到本地:

git clone https://github.com/sparesparrow/mcp-prompts.git
cd mcp-prompts

安装项目依赖:
```
npm install
```
配置环境变量：在项目根目录下创建 '.env' 文件，并根据需要配置以下变量 (示例配置使用文件存储):
```
STORAGE_TYPE=file
PROMPTS_DIR=./prompts
SERVER_NAME=mcp-prompt-manager
SERVER_VERSION=1.1.0
LOG_LEVEL=info
```
- 'STORAGE_TYPE': 存储类型，可选 'file', 'postgres', 'memory'。默认为 'file'。
- 'PROMPTS_DIR': 文件存储时Prompt文件存放的目录。默认为 './prompts'。
- 'PG_CONNECTION_STRING': 当 'STORAGE_TYPE' 为 'postgres' 时，PostgreSQL 数据库连接字符串。
- 'SERVER_NAME': MCP 服务器名称，用于服务器描述信息。默认为 'mcp-prompt-manager'。
- 'SERVER_VERSION': MCP 服务器版本号，用于服务器描述信息。默认为 '1.1.0'。
- 'LOG_LEVEL': 日志级别，可选 'info', 'debug', 'error'。默认为 'info'。

构建并运行应用:

npm run build
npm start

服务器配置

对于 MCP 客户端 (例如 Claude Desktop)，需要配置 MCP 服务器的启动信息才能连接。以下是 'mcp-prompts' 服务器的 Claude Desktop 客户端配置示例，添加到 Claude Desktop 的配置文件 '~/.config/Claude/config.json' 中的 'mcpServers' 字段：

{
  "mcpServers": {
    "prompt-manager-ts": {
      "command": "npx",
      "args": [
        "-y",
        "@sparesparrow/mcp-prompt-manager"
      ]
    }
  }
}

配置参数说明:

'"prompt-manager-ts"': 服务器名称，客户端用于标识和引用此服务器，可以自定义。
'"command": "npx"': 启动服务器的命令，这里使用 'npx' 直接运行 NPM 包，前提是已全局安装 '@sparesparrow/mcp-prompt-manager' 或使用 'npx' 命令。
'"args": [...]': 传递给启动命令的参数。
- '"-y"': 'npx' 的参数，用于跳过安装确认提示。
- '"@sparesparrow/mcp-prompt-manager"': 要执行的 NPM 包名，即 'mcp-prompt-manager' 服务器。

注意: 请确保 MCP 客户端能够找到 'npx' 命令 (通常 Node.js 安装后会自动添加到 PATH 环境变量)。如果使用源码手动安装，并且希望直接运行 'npm start' 启动服务器，则 'command' 应配置为 'npm'，'args' 配置为 '["start"]'。

基本使用方法

启动服务器: 根据安装方式，使用以下命令启动 MCP Prompt Manager 服务器：
- 全局安装: 'mcp-prompt-manager'
- 使用 npx: 'npx @sparesparrow/mcp-prompt-manager'
- 源码运行: 'npm start'
连接客户端: 配置 MCP 客户端 (例如 Claude Desktop) 连接到该服务器。配置信息参考 "服务器配置" 部分。

使用 MCP 工具: MCP Prompt Manager 提供了丰富的工具，可以通过 MCP 客户端调用。以下是一些常用工具示例 (JSON 格式参数)：

添加 Prompt 模板 ('add_prompt'):

{
  "prompt": {
    "name": "代码审查助手",
    "content": "请审查以下代码，并提供详细的反馈...",
    "description": "用于代码审查的 Prompt 模板",
    "isTemplate": true,
    "tags": ["代码", "审查"],
    "category": "开发"
  }
}

获取 Prompt 模板 ('get_prompt'):

{
  "id": "代码审查助手"
}

应用 Prompt 模板 ('apply_template'):

{
  "id": "代码审查助手",
  "variables": {
    "language": "Python",
    "task": "分析性能瓶颈"
  }
}

列出 Prompt 模板 ('list_prompts'):

{
  "category": "开发",
  "tags": ["代码"]
}

创建项目 ('create_project'):

{
  "project_name": "我的新项目",
  "project_idea": "一个基于微服务的电商平台...",
  "output_directory": "/path/to/output"
}

更多工具及其详细参数，请参考仓库 README.md 文档的 "MCP Tools" 和 "Project Orchestration" 部分。

关键词