使用说明

项目简介

Dev Prompter MCP Server 是一个基于 Model Context Protocol (MCP) 标准构建的后端服务器,它专注于提供 Prompt 模板服务。该服务器允许用户定义和管理 Prompt 模板,并根据客户端请求渲染这些模板,从而为大型语言模型 (LLM) 应用提供可定制的交互界面。作为一个 MCP 服务器,它旨在简化 LLM 应用的上下文管理和 Prompt 工程流程。

主要功能点

  • Prompt 模板管理: 支持加载和管理存储在文件系统中的 Prompt 模板,方便用户组织和维护各种Prompt。
  • Prompt 模板渲染: 根据客户端请求和提供的参数,动态渲染 Handlebars 模板,生成最终的 Prompt 文本。
  • 基于 Stdio 的传输: 使用标准输入/输出 (Stdio) 作为 MCP 协议的传输通道,简化部署和集成。
  • 开发调试支持: 提供 Debug 模式和日志管理,方便开发者调试和监控服务器运行状态。
  • 环境配置: 支持通过环境变量自定义模板目录和日志配置。
  • 元数据驱动: Prompt 模板通过 YAML Frontmatter 定义元数据,包括描述、版本和参数,方便管理和验证。

安装步骤

  1. 安装 Node.js 和 pnpm: 确保你的系统已安装 Node.js 和 pnpm 包管理器。你可以从 Node.js 官网 下载安装 Node.js,然后使用 npm 安装 pnpm:
    npm install -g pnpm
  2. 克隆仓库: 使用 Git 克隆 'mcp-dev-prompter' 仓库到本地:
    git clone https://github.com/martinbechard/mcp-dev-prompter.git
    cd mcp-dev-prompter
  3. 安装依赖: 在仓库根目录下运行 pnpm 命令安装项目依赖:
    pnpm install
  4. 构建项目: 运行以下命令构建项目:
    pnpm run build

服务器配置

MCP 客户端需要配置以下 JSON 格式信息以连接 Dev Prompter MCP Server。请注意,以下配置信息 不是 直接在服务器端配置,而是提供给 MCP 客户端 使用的配置示例。

{
  "serverName": "dev-prompter",
  "command": "node",
  "args": [
    "./dist/src/StdioServer.js"
  ],
  "transport": "stdio"
}

参数注释:

  • 'serverName': MCP 服务器的名称,客户端用于标识连接的服务器,可以自定义,例如 "dev-prompter"。
  • 'command': 启动 MCP 服务器的命令,这里是 'node',表示使用 Node.js 运行时环境。
  • 'args': 启动命令的参数数组,这里 '"./dist/src/StdioServer.js"' 指定了服务器入口文件 'StdioServer.js' 的路径,该文件位于构建后的 'dist/src' 目录下。
  • 'transport': 指定 MCP 客户端与服务器通信的传输协议,这里是 'stdio',表示使用标准输入输出流进行通信。

可选配置参数:

  • '--debug': 在 'args' 数组中可以添加 '--debug' 参数以启用 Debug 模式,例如:
    "args": [
      "./dist/src/StdioServer.js",
      "--debug"
    ]
    启用 Debug 模式后,服务器会将详细日志输出到日志文件。
  • '--templatesDir <模板目录>': 通过 '--templatesDir' 参数可以指定 Prompt 模板文件所在的目录,例如,如果模板文件放在 'my_templates' 目录下,可以配置为:
    "args": [
      "./dist/src/StdioServer.js",
      "--templatesDir",
      "./my_templates"
    ]
    如果未指定,默认模板目录为仓库根目录下的 'templates' 目录。

基本使用方法

  1. 启动服务器: 构建成功后,你可以通过 MCP 客户端配置中定义的命令和参数启动 Dev Prompter MCP Server。例如,在 MCP 客户端中配置好上述 JSON 后,启动客户端,客户端会自动连接到 Dev Prompter MCP Server。
  2. 管理 Prompt 模板: 将 Prompt 模板文件(Markdown 格式,带有 YAML Frontmatter 元数据)放置在服务器配置中指定的模板目录下(默认为 'templates' 目录)。服务器启动时会自动加载这些模板。
  3. 客户端请求 Prompt: MCP 客户端可以使用 'ListPrompts' 请求列出服务器上可用的 Prompt 模板,并使用 'GetPrompt' 请求根据模板名称和参数获取渲染后的 Prompt 文本。
  4. 查看日志 (Debug 模式): 如果启动服务器时启用了 Debug 模式,可以在 '~/Library/Logs/Claude/mcp-dev-prompter.log' 文件中查看服务器的详细运行日志。

模板文件示例 (templates/example.md):

---
description: 一个简单的问候模板
version: 1.0.0
arguments:
  name:
    description: 用户名
    required: true
---
\'\'\'handlebars
你好,{{name}}!欢迎使用 Dev Prompter MCP Server。
\'\'\'

注意: Dev Prompter MCP Server 主要提供 Prompt 模板服务,不包含资源管理和工具注册等 MCP 的其他功能。它专注于 Prompt 的定义、管理和渲染,适用于需要灵活 Prompt 定制和管理的 LLM 应用场景。

信息

分类

开发者工具