使用说明
项目简介
MCP Notes Server 是一个基于 Model Context Protocol (MCP) 构建的笔记应用后端,旨在为用户提供 AI 驱动的个人笔记管理能力。通过集成 MCP 协议,该服务器可以与支持 MCP 协议的 LLM 客户端(如 Claude Desktop, Cody, Cline)配合使用,实现通过 AI 进行笔记的记录、检索和管理。同时,也提供 Web 界面进行手动操作。
主要功能点
- AI 驱动的笔记管理: 通过 MCP 协议与 AI 模型交互,实现笔记的创建、检索、更新和删除。
- 资源管理: 将笔记作为资源进行托管和管理,允许 LLM 客户端访问和引用笔记内容。
- 工具集成: 提供 'listNotes', 'getNote', 'writeNote', 'deleteNote' 等工具,允许 LLM 客户端调用这些功能操作笔记。
- 双服务器架构: 包含 MCP 服务器和 Web 服务器,满足 AI 驱动和手动操作两种使用场景。
- 数据持久化: 使用 AWS DynamoDB 存储笔记数据。
安装步骤
- 确保已安装 Node.js 或 Bun。
- 克隆仓库或下载代码。
- 进入项目根目录,如果选择使用 'npm',运行 'npm install' 安装依赖;如果选择使用 'bun',可能不需要显式安装依赖,可以直接运行。
服务器配置
- MCP 服务器启动命令配置 (JSON):
参数说明:{ "mcpServers": { "mcp-notes": { "command": "npx", "args": [ "-y", "-p", "mcp-notes", "mcp-notes-server", "--dynamodb", "dynamodb://<access_key>:<secret_key>@<region>/<table>" ] } } }- 'command': 启动 MCP 服务器的命令,例如 'npx' 或 'node'。
- 'args': 命令参数列表。
- '-y -p mcp-notes': 使用 'npx' 安装并运行 'mcp-notes' 包。
- 'mcp-notes-server': 指定运行 'mcp-notes-server' 命令,即 MCP 服务器入口。
- '--dynamodb "dynamodb://<access_key>:<secret_key>@<region>/<table>"': DynamoDB 连接字符串,用于配置笔记数据存储。需要替换 '<access_key>', '<secret_key>', '<region>', '<table>' 为你的 AWS DynamoDB 凭据、区域和表名。
- Web 服务器启动命令 (可选):
参数说明:npx -p mcp-notes mcp-notes-web-server --dynamodb "dynamodb://<access_key>:<secret_key>@<region>/<table>"- '--dynamodb "dynamodb://<access_key>:<secret_key>@<region>/<table>"': DynamoDB 连接字符串,与 MCP 服务器相同。
基本使用方法
- 配置 AWS DynamoDB: 确保已创建 AWS 账户,并在 DynamoDB 中创建用于存储笔记的表。配置 AWS 访问密钥和密钥。
- 启动 MCP 服务器: 根据 MCP 客户端(如 Claude Desktop, Cody, Cline)的配置要求,配置 MCP 服务器启动命令,并启动 MCP 服务器。
- 配置 Web 服务器 (可选): 如果需要手动管理笔记,可以启动 Web 服务器,并通过浏览器访问 'http://localhost:3100' 进行操作。
- 在 MCP 客户端中使用: 在支持 MCP 协议的客户端中,配置连接到 MCP Notes Server,即可通过 AI 模型使用笔记功能。例如,可以指示 AI 模型列出笔记、读取指定笔记、创建或更新笔记、删除笔记等。
信息
分类
生产力应用