Requirements

Requirements

site icon
2025.04.06 0
Markdown 笔记管理MCP 协议内容生成
mvp-MCP-server_MD-Notes 是一个基于 Model-Context-Protocol (MCP) 的最小化服务器设计,主要用于检索和阅读 Markdown 笔记。它采用轻量级的 Express.js 框架,提供基本的笔记管理功能,包括列出笔记、读取笔记内容和简单搜索功能。
View on GitHub

Overview

基本能力

产品定位

mvp-MCP-server_MD-Notes 是一个专为 Markdown 笔记管理设计的轻量级 MCP 服务器,旨在通过 MCP 协议提供笔记的检索和阅读功能。

核心功能

  1. 笔记检索:支持列出所有可用的 Markdown 笔记。
  2. 笔记阅读:可以读取特定笔记的内容。
  3. 笔记搜索:提供简单的搜索功能,便于快速定位笔记。
  4. MCP 协议支持:实现 MCP 协议的发现和调用端点。

适用场景

  1. 个人知识管理:用于管理和检索个人的 Markdown 笔记。
  2. 团队协作:团队成员可以通过 MCP 协议共享和访问笔记。
  3. 集成开发:可以与其他工具或 LLM(如 Claude)集成,实现自动化笔记检索和阅读。

工具列表

  1. MCP Router
  2. 处理 MCP 协议请求。
  3. 提供 /discover 端点,返回可用的工具和功能。
  4. 提供 /invoke 端点,处理工具功能调用。

  5. Notes Tool

  6. 实现笔记检索功能,包括 list_notesread_notesearch_notes

常见问题解答

  1. 如何添加新的笔记?
  2. 将 Markdown 文件放入 notes/ 目录即可。

  3. 如何扩展搜索功能?

  4. 可以在 notes-tool.js 中扩展 search_notes 方法的实现。

使用教程

使用依赖

  1. 确保已安装 Node.js 运行环境。
  2. 安装项目依赖: bash npm install express cors

安装教程

  1. 克隆项目或创建项目目录。
  2. 初始化项目并安装依赖: bash npm init -y npm install express cors
  3. 创建项目结构: mcp-notes-server/ ├── package.json ├── server.js ├── routes/ │ └── mcp-router.js ├── tools/ │ └── notes-tool.js └── notes/ └── ... (your .md files)
  4. 启动服务器: bash node server.js

调试方式

  1. 检查服务器是否正常运行: bash curl http://localhost:3000/discover
  2. 测试笔记检索功能: bash curl -X POST http://localhost:3000/invoke -H "Content-Type: application/json" -d '{"tool": "notes", "function": "list_notes"}'
  3. 测试笔记阅读功能: bash curl -X POST http://localhost:3000/invoke -H "Content-Type: application/json" -d '{"tool": "notes", "function": "read_note", "parameters": {"note_name": "example.md"}}'

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。