README
🚀 📝 AI Sticky Notes – MCP项目
这是一个简单且功能强大的应用程序,借助MCP(模型上下文协议)搭建了一个由AI驱动的粘贴笔记系统。它集成了FastMCP、mcp[cli]接口,还与Claude Desktop实现了整合,为用户提供便捷的笔记管理体验。
🚀 快速开始
本项目利用MCP(模型上下文协议)构建了AI驱动的粘贴笔记系统,结合FastMCP、mcp[cli]接口与Claude Desktop,具备添加、查看、删除笔记等功能。
✨ 主要特性
- 添加新笔记:可轻松添加新的笔记内容。
- 查看所有现有笔记:方便用户查看已保存的全部笔记。
- 删除所有笔记:能快速清除所有笔记记录。
- 获取最新笔记:及时获取最近添加的笔记。
- 生成总结所有笔记的提示:可生成提示让AI总结当前所有笔记。
📦 安装指南
1. 创建并初始化MCP环境
uv install
uv init project-folder-name
cd project-folder-name
uv add "mcp[cli]"
2. 安装并使用Claude Desktop
- 下载并安装Claude Desktop。
- 运行并与定义的工具、资源和提示交互。
💻 使用示例
基础用法
# 以下是使用示例代码
# 假设已经完成环境搭建和依赖安装
from main import add_note, read_notes
# 添加新笔记
add_note("这是一条新笔记")
# 查看所有笔记
all_notes = read_notes()
print(all_notes)
高级用法
# 高级场景说明:可以组合使用多个工具函数实现更复杂的功能
from main import add_note, remove_notes, note_summary_prompt
# 添加多条笔记
add_note("笔记1")
add_note("笔记2")
add_note("笔记3")
# 生成总结所有笔记的提示
prompt = note_summary_prompt()
print(prompt)
# 删除所有笔记
remove_notes()
📚 详细文档
📁 文件概述
main.py
该文件包含所有用于管理笔记的工具和逻辑,基于MCP框架。
🔧 工具
add_note(message: str) -> str
将新笔记追加到notes.txt文件中。
read_notes() -> str
返回所有保存的笔记。如果没有任何笔记存在,则返回默认消息。
remove_notes() -> str
清除notes.txt文件中的所有笔记。
🔗 资源
get_latest_note() -> str
返回最近添加的笔记。
💬 提示
note_summary_prompt() -> str
生成一个提示,要求AI总结所有当前笔记。
📄 笔记文件
所有笔记均存储在本地notes.txt文件中,如果该文件不存在,则会自动创建。
📄 许可证
文档未提及相关许可证信息。
Scan to contact