笔记服务系统

一个基于MCP协议的简单笔记系统,提供创建、删除、更新和列出笔记的功能。

  • by GuoAccount
  • JavaScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 guoaccount/notepad-server

使用说明

📝 记事本服务器MCP服务器

中文版

🤖 模型上下文协议服务器

🛠️ 该项目实现了一个简单的笔记系统,并通过提供以下内容演示了MCP的核心概念:

  • 创建新笔记的工具
  • 提示生成笔记摘要

🌟 特性

🛠️ 工具

addNotepad

  • 描述:添加新记事本
  • 参数:
    • name (string):记事本的名称
    • content (string):记事本的内容

delNotepad

  • 描述:删除记事本
  • 参数:
    • id (数字):要删除的记事本的ID

updateNotepad

  • 描述:更新记事本
  • 参数:
    • id (数字):要更新的记事本的ID
    • content (string):记事本的新内容

listNotepads

  • 描述:列出所有记事本
  • 参数:无

useNotepad

  • 描述:使用特定的记事本
  • 参数:
    • id (数字):要使用的记事本的ID

🛠️ 发展

安装依赖项:

npm install

构建服务器:

npm run build

对于自动重建的开发:

npm run watch

📥 安装

要与Claude Desktop一起使用,请添加服务器配置:

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

{
  "mcpServers": {
    "notepad-server": {
      "command": "/path/to/notepad-server/build/index.js"
    }
  }
}

🔍 调试

由于MCP服务器通过stdio进行通信,调试可能具有挑战性。我们建议使用 MCP检查员,可作为包脚本使用:

npm run inspector

检查器将提供一个URL,用于访问浏览器中的调试工具。