mcp-server-notes

🚀 MCP 笔记服务器

MCP 笔记服务器是一个简单的 MCP（消息协调协议）服务器，它能够提供对存储在 ~/DocumentationGenerator/notes/ 中的笔记的访问，方便用户管理和检索笔记。

🚀 快速开始

安装指南

1. 确保安装了 Python 3.7+ 版本。
2. 创建虚拟环境：

   python -m venv venv
   

3. 激活虚拟环境：
   • 在 macOS/Linux 上：source venv/bin/activate
   • 在 Windows 上：venv\Scripts\activate
4. 安装依赖项：

   pip install -r requirements.txt
   

启动服务器

要启动 MCP 服务器，只需运行以下命令：

python notes.py

这将启动服务器，地址为 http://0.0.0.0:8000。

✨ 主要特性

• 提供简单的 MCP 协议接口，方便与客户端进行交互。
• 支持列出所有笔记、获取特定笔记以及按查询字符串搜索笔记等功能。

💻 使用示例

基础用法

以下是连接到 MCP 服务器的简单 Python 客户端示例：

from mcp.client import MCPClient

# 连接到MCP服务器
client = MCPClient("http://localhost:8000")

# 列出所有笔记
notes = client.call("notes.list_notes")

# 获取特定笔记
note = client.call("notes.get_note", note_name="your-note-name")

# 搜索笔记
search_results = client.call("notes.search", query="important")

📚 详细文档

API 接口

服务器暴露以下 MCP 命令：

• list_notes() - 获取所有笔记
• get_note(note_name) - 通过名称获取特定笔记
• search(query, note_name=None) - 按查询字符串搜索笔记

笔记格式

笔记以 JSON 文件形式存储在指定目录中，采用以下格式：

{
    "category": "分类",
    "summary": "笔记摘要", 
    "tags": [
        {
            "tag": "子细节的标签",
            "summary": "子细节的高级别业务逻辑",
            "messages": [
                {
                    "timestamp": "消息的时间戳",
                    "message": "消息内容"
                },
                {
                    "timestamp": "消息的时间戳",
                    "message": "消息内容"
                }
            ]
        }
    ]
}