使用说明

项目简介

本项目是一个 MCP 服务器模板,它实现了一个简单的笔记系统,用于演示 MCP 服务器的核心概念。您可以将其用作构建自定义 MCP 服务器的起点。该服务器提供资源(笔记)、工具(创建笔记)和 Prompt(总结笔记),展示了如何通过 MCP 协议与 LLM 客户端交互。

主要功能点

  • 笔记资源管理:以资源的形式存储和管理文本笔记,每个笔记都有唯一的 URI ('note://')、标题、内容和元数据。
  • 创建笔记工具:提供 'create_note' 工具,允许用户通过指定标题和内容创建新的文本笔记。
  • 总结笔记Prompt:提供 'summarize_notes' Prompt,可以生成所有笔记内容的摘要,用于 LLM 的总结任务。
  • 标准 MCP 协议:完全基于 Model Context Protocol (MCP) 构建,使用 JSON-RPC 协议进行通信。
  • Stdio 传输:使用标准输入输出 (Stdio) 作为默认的传输协议,方便集成和调试。

安装步骤

  1. 安装 Node.js 和 npm:确保您的系统已安装 Node.js 和 npm 包管理器。
  2. 下载仓库:从 GitHub 下载或克隆 'mcp-server-template' 仓库到本地。
  3. 安装依赖:在仓库根目录下打开终端,运行命令 'npm install' 安装项目依赖。
  4. 构建服务器:运行命令 'npm run build' 编译 TypeScript 代码为 JavaScript。

服务器配置

要将此 MCP 服务器配置到 MCP 客户端(例如 Claude Desktop),您需要提供服务器的启动命令。以下是一个 'claude_desktop_config.json' 配置文件示例:

{
  "mcpServers": {
    "evm-server": {
      "command": "/path/to/mcp-server-template/build/index.js"
    }
  }
}

配置说明:

  • '"evm-server"': 服务器名称,您可以自定义,用于在客户端中标识该服务器。
  • '"command"': 请将 '/path/to/mcp-server-template/build/index.js' 替换为服务器 'index.js' 文件在您本地构建目录中的实际路径。 该路径可以是绝对路径,也可以是相对于客户端配置文件位置的相对路径。

基本使用方法

  1. 启动 MCP 服务器:在配置好 MCP 客户端并启动后,客户端会自动根据配置启动该 MCP 服务器。无需手动单独启动服务器。
  2. 通过 MCP 客户端与服务器交互:使用配置好的 MCP 客户端(例如 Claude Desktop)与服务器进行交互。客户端将根据服务器提供的资源、工具和 Prompt 与您进行对话,您可以:
    • 列出和访问已有的笔记资源。
    • 使用 'create_note' 工具创建新的笔记。
    • 使用 'summarize_notes' Prompt 生成笔记摘要。

注意: 本项目是一个基础模板,仅用于演示 MCP 服务器的基本功能。在实际应用中,您可能需要根据具体需求扩展其功能,例如添加更复杂的资源管理、工具和 Prompt,以及集成持久化存储等。

信息

分类

开发者工具