关键词

笔记管理文本笔记工具调用上下文服务LLM应用

使用说明

项目简介

本项目 'simple-mcp-template' 是一个基于 Model Context Protocol (MCP) 的简易服务器模板，它演示了如何使用 MCP 协议构建一个提供上下文信息的后端服务。这个模板实现了一个简单的笔记系统，允许用户通过客户端调用服务器提供的工具来创建新的文本笔记。

主要功能点

  • 创建笔记 (create_note 工具): 允许客户端调用 'create_note' 工具，通过提供标题和内容来创建新的文本笔记。笔记数据存储在服务器内存中。
  • 工具发现: 客户端可以查询服务器以获取可用的工具列表及其描述和参数信息。
  • MCP 协议支持: 完全实现了 MCP 协议的服务器端功能，可以接收和处理来自 MCP 客户端的 JSON-RPC 请求，并返回符合 MCP 协议的响应。
  • Stdio 传输: 使用标准的 Stdio (标准输入/输出) 作为 MCP 服务器的传输协议，方便集成和部署。

安装步骤

  1. 安装 Node.js 和 npm: 确保您的系统已安装 Node.js 和 npm (Node 包管理器)。您可以从 nodejs.org 下载并安装。
  2. 克隆仓库: 将 'simple-mcp-template' 仓库克隆到本地： 
    git clone https://github.com/elethy/simple-mcp-template.git
cd simple-mcp-template
  3. 安装依赖: 在项目根目录下运行以下命令安装项目依赖： 
    npm install
  4. 构建项目: 运行以下命令构建 TypeScript 代码： 
    npm run build

服务器配置

对于 MCP 客户端，您需要配置服务器的启动命令。以下是一个示例 'mcpServers' 配置，通常在 MCP 客户端的配置文件中使用（例如，'dev.config.json'）：

{
  "mcpServers": {
    "simple-mcp-template": {
      "command": "/path/to/simple-mcp-template/build/index.js"
      // "command" 字段指定服务器启动命令的路径。
      // 请将 "/path/to/simple-mcp-template" 替换为您本地仓库的实际路径。
      // 确保路径指向构建后的 index.js 文件。
    }
  }
}

注意: '/path/to/simple-mcp-template' 需要替换为 'simple-mcp-template' 仓库在您本地文件系统中的绝对路径。

基本使用方法

  1. 启动服务器: 在项目根目录下，运行以下命令启动 MCP 服务器： 
    npm run inspector
    或者直接运行构建后的 'index.js' 文件： 
    node build/index.js
    服务器将通过 Stdio 监听来自 MCP 客户端的请求。
  2. 配置 MCP 客户端: 在您的 MCP 客户端配置中，添加上面提供的 'mcpServers' 配置，确保 'command' 路径正确指向您启动的服务器。
  3. 使用 MCP 客户端与服务器交互: 启动 MCP 客户端后，客户端将自动连接到配置的 MCP 服务器。您可以使用客户端提供的界面或命令来：
    • 列出可用工具: 查询服务器以获取 'create_note' 工具的信息。
    • 调用 'create_note' 工具: 使用客户端提供的工具调用功能，调用 'create_note' 工具并提供标题和内容参数，创建新的文本笔记。
    • 查看服务器响应: 客户端会显示服务器返回的响应信息，例如笔记创建成功的消息。

开发提示: 'npm run watch' 命令可以在开发过程中使用，它会在代码更改时自动重新构建项目，方便调试和开发。 'npm run inspector' 命令启动服务器并启用 Inspector，可以通过浏览器访问调试工具，用于更深入的开发和调试。

信息

分类

生产力应用

访问项目