项目简介

'notepad-server' 是一个基于 Model Context Protocol (MCP) 的简单服务器实现，它提供了一个基础的 Notepad (记事本) 服务。通过该服务器，MCP 客户端可以调用预设的工具来管理和操作Notepad，例如创建新的记事本、删除、更新以及列出所有记事本等。这个项目旨在演示 MCP 协议的核心概念，特别是 工具 (Tools) 的注册和使用。

主要功能点

Notepad 管理: 提供对 Notepad 资源的增删改查功能。
工具 (Tools) 接口: 通过 MCP 协议暴露了一系列工具，允许客户端调用以实现 Notepad 的管理操作。
- 'addNotepad': 创建新的记事本。
- 'delNotepad': 删除指定 ID 的记事本。
- 'updateNotepad': 更新指定 ID 记事本的内容。
- 'listNotepads': 列出所有记事本。
- 'useNotepad': 获取指定 ID 记事本的详细信息。

安装步骤

安装 Node.js 和 npm: 确保你的电脑上已经安装了 Node.js 和 npm (Node 包管理器)。

克隆仓库: 使用 git 命令克隆 'notepad-server' 仓库到本地：

git clone https://github.com/GuoAccount/notepad-server.git

进入项目目录: 使用 'cd' 命令进入克隆下来的 'notepad-server' 目录：
```
cd notepad-server
```
安装依赖: 运行 'npm install' 命令安装项目所需的依赖包：
```
npm install
```
构建服务器: 运行 'npm run build' 命令编译 TypeScript 代码并生成可执行的 JavaScript 文件：
```
npm run build
```

服务器配置

要将 'notepad-server' 配置为 MCP 服务器供 MCP 客户端（例如 Claude Desktop）使用，你需要编辑 MCP 客户端的配置文件。以 Claude Desktop 为例，你需要修改 'claude_desktop_config.json' 文件，添加 'notepad-server' 的配置信息。

配置文件路径:

MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%/Claude/claude_desktop_config.json'

配置内容 (JSON 格式):

{
  "mcpServers": {
    "notepad-server": {
      "command": "/path/to/notepad-server/build/index.js"
      // command 字段指定 notepad-server 服务器的启动命令，这里指向构建后 index.js 文件的绝对路径。
      // 请将 "/path/to/notepad-server/build/index.js" 替换为实际的 notepad-server 项目 build 目录下 index.js 文件的绝对路径。
      // 例如: "/Users/your_username/notepad-server/build/index.js" (MacOS) 或 "C:\\Users\\YourUsername\\notepad-server\\build\\index.js" (Windows)
    }
  }
}

请务必将 'command' 字段的值替换为 'notepad-server' 项目 'build' 目录下 'index.js' 文件的实际绝对路径。 你可以通过终端或文件管理器找到 'index.js' 文件，并复制其完整路径。

基本使用方法

启动 MCP 服务器: 在配置好 MCP 客户端后，启动 'notepad-server' 服务器。由于 'notepad-server' 是通过 stdio 通信的，它通常由 MCP 客户端自动启动。你无需手动执行额外的启动命令，只需确保 MCP 客户端配置正确即可。
在 MCP 客户端中使用工具: 在 MCP 客户端（如 Claude Desktop）中，你可以通过特定的界面或命令来调用 'notepad-server' 提供的工具。具体的调用方式取决于 MCP 客户端的实现。通常，你需要在客户端中指定要使用的工具名称（例如 'addNotepad'），并提供工具所需的参数（例如 Notepad 的名称和内容）。

例如，在 Claude Desktop 中，你可能需要通过对话或特定的操作界面来触发对 'notepad-server' 工具的调用，以创建、删除、更新或查看 Notepad。

请参考你的 MCP 客户端的文档，了解如何配置和使用 MCP 服务器及其提供的工具。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息