MCP Notes

🚀 MCP筆記服務器

這是一個模型上下文協議（MCP）服務器實現，主要用於管理帶有持久存儲的筆記，為筆記的創建、讀取、更新和刪除等操作提供便利。

🚀 快速開始

本服務器可用於管理帶有持久存儲的筆記，你可以通過以下步驟快速上手：

1. 完成服務器的安裝（可選擇自動安裝或手動安裝）。
2. 啟動服務器。
3. 進行筆記的創建、讀取、更新和刪除等操作。

✨ 主要特性

• 基本操作：支持創建、讀取、更新和刪除筆記。
• 持久化存儲：使用JSON進行持久化存儲，確保數據的持久保存。
• 時間記錄：記錄筆記的創建和修改時間戳，方便追溯。
• 摘要生成：通過提示生成筆記摘要，便於快速瞭解筆記內容。
• 訪問控制：基於資源的訪問控制，使用note:// URI方案，保障數據安全。

📦 安裝指南

通過Smithery安裝

要自動為Claude Desktop安裝notes，請通過Smithery：

npx -y @smithery/cli install notes --client claude

手動安裝

1. 確保已安裝Python 3.10或更高版本。
2. 創建虛擬環境：

   python -m venv .venv
   
   # 在Unix/MacOS中：
   source .venv/bin/activate
   
   # 在Windows中：
   .venv\Scripts\activate
   

3. 安裝需求：

   pip install MCP
   

💻 使用示例

基礎用法

啟動服務器

mcp install src/notes
mcp start Notes

示例操作

# 創建一個筆記
await client.call_tool("add-note", {
    "name": "example",
    "content": "這是一個測試筆記"
})

# 列出所有筆記
await client.call_tool("list-all-notes")

# 更新一個筆記
await client.call_tool("update-note", {
    "name": "example",
    "content": "更新後的內容"
})

# 刪除一個筆記
await client.call_tool("delete-note", {
    "name": "example"
})

📚 詳細文檔

項目結構

notes/
├── __init__.py          # 包初始化
├── server.py           # 主服務器實現
├── storage.py          # 筆記持久層
├── resources.py        # 資源處理（note:// URI）
├── prompts.py         # LLM提示生成
└── tools/             # 服務器工具
    ├── __init__.py    # 工具包初始化
    ├── list_tools.py  # 工具列表功能
    └── handle_tools.py # 工具處理實現

可用工具

• add-note：創建新筆記
• list-all-notes：顯示所有存儲的筆記
• update-note：修改現有筆記
• delete-note：刪除筆記

存儲

筆記存儲在notes_storage.json中，結構如下：

{
    "note_name": {
        "content": "Note內容",
        "created_at": "2025-01-12T11:28:16.721704",
        "modified_at": "2025-01-12T11:28:16.721704"
    }
}

資源訪問

筆記可以通過note:// URI方案作為資源訪問：

• 列出資源：返回所有可用的筆記
• 讀取資源：使用note://internal/note_name訪問特定筆記

提示生成

服務器包含一個提示生成功能，用於筆記摘要：

• 支持簡短和詳細摘要
• 筆記格式適合語言模型輸入
• 使用generate-summary工具生成摘要

開發

克隆倉庫

使用以下命令克隆此倉庫：

git clone https://github.com/your-username/notes-mcp.git
cd notes-mcp

依賴項

確保安裝了以下Python包：

• flask：用於Web界面
• python-dotenv：用於環境變量管理
• requests：用於API請求

運行服務器

安裝依賴後，運行：

python server.py

訪問http://localhost:5000查看Web界面。

貢獻

歡迎貢獻！請參考CONTRIBUTING.md瞭解如何參與開發。