🚀 AI Note MCP 服務器
AI Note MCP 服務器是一個基於模型上下文協議(MCP)的服務器,它能將 Claude Desktop 與你的 AI Note 任務管理系統連接起來。藉助這個服務器,Claude 可以直接與你的 AI Note 任務進行交互,讓你通過自然語言對話來創建、更新和管理任務。
🚀 快速開始
在使用 AI Note MCP 服務器之前,請確保你已經滿足以下前提條件:
- Node.js >= 16.0.0
- npm 或 yarn
- 擁有 AI Note API 訪問權限(需要 API 密鑰)
- 啟用了 MCP 支持的 Claude Desktop
✨ 主要特性
- 📝 任務管理:直接在 Claude Desktop 中創建、更新、刪除和列出任務。
- 🏷️ 分類支持:使用分類來組織任務。
- 🔍 高級搜索:按內容、狀態等搜索任務。
- ⭐ 優先級管理:將任務標記為重要。
- 📅 截止日期支持:設置和管理任務的截止日期。
- 🔒 安全的 API 集成:使用 API 密鑰認證進行安全訪問。
📦 安裝指南
選項 1:從 npm 安裝
npm install -g @ainote/mcp
選項 2:從源代碼安裝
git clone https://github.com/ainote-dev/ainote-mcp.git
cd ainote-mcp-server
npm install
更新安裝
從 npm 更新(推薦)
若你通過 npm 安裝,可使用以下命令更新到最新版本:
npm update -g @ainote/mcp
若要安裝特定版本:
npm install -g @ainote/mcp@1.0.2
從源代碼更新
如果你是從源代碼安裝的,可使用以下命令更新:
cd ainote-mcp-server
git pull origin main
npm install
更新完成後,請 重啟 Claude Desktop 以加載新版本。
💻 使用示例
基礎用法
配置完成後,你可以通過 Claude 與你的 AI Note 任務進行交互。以下是一些示例對話:
你: "顯示我的待辦任務"
Claude: 我將從 AI Note 中檢索你的待辦任務...
你: "創建一個新任務,在週五前審核季度報告"
Claude: 我將為你創建該任務,並將截止日期設置為週五...
你: "將任務 ID 123 標記為已完成"
Claude: 我將把該任務標記為已完成...
📚 詳細文檔
可用工具
list_tasks
列出 AI Note 中的任務,並支持過濾選項。
參數:
status(可選):按狀態過濾 - "pending" 或 "completed"
limit(可選):任務的最大數量(默認值:25,最大值:500)
search(可選):在任務內容中搜索的關鍵字
create_task
在 AI Note 中創建一個新任務。
參數:
content(必需):任務描述
is_important(可選):標記為重要(布爾值)
due_date(可選):截止日期(ISO 格式)
category_id(可選):要分配的分類 ID
update_task
更新現有的任務。
參數:
id(必需):任務 ID
content(可選):新的任務內容
is_important(可選):更新重要狀態
completed_at(可選):標記為已完成(ISO 格式),或 null 以取消完成狀態
delete_task
軟刪除一個任務。
參數:
list_categories
列出所有可用的分類。
參數:無
API 參考
MCP 服務器使用以下端點與 AI Note API 進行通信:
GET /api/mcp/tasks - 列出任務
POST /api/mcp/tasks - 創建任務
PUT /api/mcp/tasks/:id - 更新任務
DELETE /api/mcp/tasks/:id - 刪除任務
GET /api/mcp/categories - 列出分類
所有請求都需要通過 Authorization 頭使用你的 API 密鑰進行身份驗證。
開發
本地運行
git clone https://github.com/ainote-dev/ainote-mcp.git
cd ainote-mcp-server
npm install
npm start
使用 Claude Desktop 進行測試
- 更新你的 Claude Desktop 配置,使其指向你的本地開發服務器。
- 設置用於測試的環境變量。
- 完全重啟 Claude Desktop。
- 在 Claude Desktop 設置中檢查 MCP 連接狀態。
項目結構
ainote-mcp-server/
├── index.js # 主服務器實現
├── package.json # 包配置
├── README.md # 英文文檔
├── README-ko.md # 韓文文檔
└── LICENSE # MIT 許可證
故障排除
常見問題
-
“API 密鑰未找到”錯誤
- 確保
AINOTE_API_KEY 已在你的環境或 Claude 配置中設置。
- 檢查 API 密鑰是否有效,並具有適當的權限。
-
“連接被拒絕”錯誤
- 驗證 API URL 是否正確。
- 檢查網絡連接。
- 確保 AI Note API 服務器正在運行。
-
“工具未找到”錯誤
- 在配置更改後重啟 Claude Desktop。
- 驗證 MCP 服務器是否已在 Claude Desktop 中正確配置。
-
任務未顯示
- 檢查 API 密鑰權限。
- 驗證你查詢的狀態是否正確(待辦/已完成)。
- 嘗試使用搜索參數。
調試模式
若要啟用調試日誌,請使用以下命令:
export DEBUG=mcp:*
貢獻代碼
我們歡迎你的貢獻!請按照以下步驟進行:
- 分叉倉庫。
- 創建一個功能分支 (
git checkout -b feature/amazing-feature)。
- 提交你的更改 (
git commit -m 'Add amazing feature')。
- 推送到該分支 (
git push origin feature/amazing-feature)。
- 打開一個拉取請求。
開發指南
- 遵循現有的代碼風格。
- 為新功能添加測試。
- 根據需要更新文檔。
- 在提交拉取請求之前,確保所有測試都通過。
📄 許可證
本項目採用 MIT 許可證 - 有關詳細信息,請參閱 LICENSE 文件。
支持
致謝