使用说明

项目简介

my-server MCP Server 是一个使用 TypeScript 开发的笔记服务器,它实现了 Model Context Protocol (MCP),可以作为 LLM 客户端的后端,提供笔记的存储、访问和总结功能。

主要功能点

  • 资源管理:将笔记以资源的形式进行管理,每个笔记有唯一的 URI (note://) 和元数据,客户端可以列出和读取笔记资源。
  • 创建笔记工具:提供 'create_note' 工具,允许客户端创建新的笔记,需要提供标题和内容。
  • 笔记总结 Prompt:提供 'summarize_notes' Prompt,可以生成所有笔记的摘要,用于 LLM 进行总结。

安装步骤

  1. 确保已安装 Node.js 和 npm。
  2. 克隆仓库到本地:
    git clone https://github.com/vivalalova/mcp_practice.git
  3. 进入项目目录:
    cd mcp_practice
  4. 安装依赖:
    npm install
  5. 构建项目:
    npm run build

服务器配置

要将此 MCP 服务器配置到 MCP 客户端(例如 Claude Desktop),需要编辑客户端的配置文件。 以下是配置示例 (claude_desktop_config.json):

{
  "mcpServers": {
    "my-server": {
      "command": "/path/to/my-server/build/index.js" // 请替换为 my-server 项目 build 目录下的 index.js 文件的绝对路径
    }
  }
}

请注意:你需要将 '/path/to/my-server/build/index.js' 替换为实际的 'index.js' 文件路径。这个路径是服务器的启动命令,MCP 客户端会使用这个命令来启动服务器。

基本使用方法

  1. 启动服务器:在项目目录下运行 'npm run start' (或者直接运行配置文件中指定的 'command')。
  2. 配置 MCP 客户端:按照上述 "服务器配置" 步骤配置你的 MCP 客户端,使其连接到 my-server 服务器。
  3. 使用 MCP 客户端:客户端应该能够列出和访问笔记资源 (note:// URI),调用 'create_note' 工具创建新笔记,以及使用 'summarize_notes' Prompt 生成笔记摘要。具体操作方式取决于 MCP 客户端的功能。

信息

分类

生产力应用