Sticky Notes MCP Server

Sticky Notes MCP Server

site icon
2025.02.19 1
JavaScript便签管理笔记服务交流协作
Sticky Notes MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,用于管理便签笔记。它提供了完整的 MCP 接口和 REST API,支持创建、更新、删除、搜索和管理笔记、标签和分区。此外,它还提供了一个基于 React 的用户界面,用于与便签进行交互。
View on GitHub

Overview

基本能力

产品定位

Sticky Notes MCP Server 是一个便签管理服务,旨在帮助用户高效地组织和管理笔记内容。

核心功能

  • 便签管理:创建、更新、删除、搜索笔记
  • 标签系统:支持分层标签管理和标签搜索
  • 分区组织:将笔记分组到自定义分区中
  • 颜色编码:支持为笔记设置颜色,并支持批量操作
  • 全文本搜索:使用 SQLite FTS5 进行高效的笔记搜索
  • 实时同步:通过 WebSocket 实现笔记的实时更新
  • Markdown 支持:笔记内容支持 Markdown 格式
  • 批量操作:支持批量删除、颜色更改和导出笔记
  • 主题系统:支持浅色和深色主题,并能根据系统偏好自动切换

适用场景

  • 个人笔记管理
  • 团队协作和知识共享
  • 会议记录和项目规划
  • 学习和研究笔记整理

MCP 工具列表

  • create-note:创建新笔记
  • update-note:更新现有笔记
  • delete-note:删除笔记
  • search-notes:搜索笔记
  • list-conversations:列出所有对话及其元数据

常见问题解答

  1. 数据库位置问题:确保 DB_ROOT 环境变量设置正确
  2. 端口冲突:使用 WEB_UI_PORTWS_PORT 配置替代端口
  3. 性能问题:服务器使用 SQLite 优化,包括 WAL 模式

使用教程

使用依赖

  • Node.js (v16 或更高版本)
  • npm 或 pnpm
  • SQLite (通过 better-sqlite3 自动包含)

安装教程

  1. 克隆仓库 bash git clone https://your.repo.url/sticky-notes-server.git cd sticky-notes-server
  2. 安装依赖 bash npm install
  3. 构建项目 bash npm run build
  4. 启动服务器 bash npm start

调试方式

  • 开发模式启动 bash npm run dev
  • 检查日志中的端口使用情况
  • 验证数据库文件是否在正确位置创建

许可证

该项目遵循 MIT 开源许可条款。