🚀 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 文件。
支持
致谢