本地笔记管理系统

一个基于Model Context Protocol (MCP)的本地笔记管理系统,支持创建、读取、搜索和管理Markdown格式的笔记,适用于个人知识管理。

  • by YajanaRao
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 yajanarao/notes-mcp

使用说明

注释MCP

使用模型上下文协议(MCP)的本地笔记管理系统。该系统允许您在本地目录中创建、读取、搜索和管理笔记,类似于Obsidian或Notion。

特性

  • 以Markdown格式创建和管理笔记
  • 自动元数据管理(创建日期、修改日期)
  • 基于标签的组织
  • 全文搜索
  • 本地存储(无云依赖)

安装

  1. 克隆此存储库
  2. 安装依赖项:
    npm install
    
  3. 构建项目:
    npm run build
    

钞票将存储在 notes 项目根目录中的目录。

可用命令

MCP提供以下命令:

列表注释

notes.list();

返回所有注释及其元数据的列表。

阅读备注

notes.read({ id: string });

根据特定音符的ID读取该音符。

写笔记

notes.write({
  id: string,
  title: string,
  content: string,
  tags?: string[]
})

使用指定的内容和元数据创建或更新注释。

搜索笔记

notes.search({
  query: string,
  tags?: string[]
})

按内容和/或标签搜索笔记。

备注格式

注释以Markdown格式存储,元数据以YAML开头:

---
title: Note Title
tags: [tag1, tag2]
created: 2024-03-21T12:00:00.000Z
modified: 2024-03-21T12:00:00.000Z
---

Note content goes here...

许可证

国际协调委员会