使用说明
项目简介
MCP Notes Server 是一个基于 Model Context Protocol (MCP) 构建的笔记应用后端。它允许用户通过 AI 模型以结构化的方式记录和管理个人笔记。该服务器提供 MCP 接口和 Web 界面两种访问方式。通过 MCP 接口,支持 AI 模型以工具调用的形式进行笔记的增删查改;通过 Web 界面,用户可以手动管理笔记。所有笔记数据存储在 AWS DynamoDB 中。
主要功能点
- AI 驱动的笔记管理: 通过 MCP 协议,AI 模型可以调用工具来创建、检索、更新和删除笔记。
- 全面的笔记操作: 支持创建、列表、获取、更新和删除笔记,无论是通过 AI 还是 Web 界面。
- 可靠的数据存储: 使用 AWS DynamoDB 存储笔记,保证数据的安全性和可靠性。
- 灵活的身份验证: 支持通过连接字符串或环境变量配置 AWS 凭证,方便集成。
- 项目独立性: 笔记数据独立存储,不依赖于特定的项目文件或结构,适合记录个人想法和知识。
安装步骤
- 环境准备: 确保已安装 Node.js 和 npm 或 bun。您需要一个 AWS 账户来使用 DynamoDB 服务。
- 克隆仓库: 将 GitHub 仓库 'MCP-Mirror/9Ninety_MCPNotes' 克隆到本地。
- 安装依赖: 在仓库根目录下运行 'npm install' 或 'bun install' 安装项目依赖。
服务器配置
MCP 服务器配置 (用于 MCP 客户端)
将以下 JSON 配置添加到您的 MCP 客户端配置中,例如 Claude Desktop, Cody, Cline 等。
{ "mcpServers": { "mcp-notes": { "command": "npx", "args": [ "-y", "-p", "mcp-notes", "mcp-notes-server", "--dynamodb", "dynamodb://<access_key>:<secret_key>@<region>/<table>" ] } } }
- 'server name': 'mcp-notes' (服务器名称,用户自定义,用于在客户端中标识该服务器)
- 'command': 'npx' (启动命令,用于执行 Node.js 包)
- 'args': 启动参数,一个字符串数组,包含以下参数:
- '-y': (可选) 自动确认 'npx' 安装包的提示
- '-p': 'mcp-notes' (指定要安装和执行的 npm 包名称为 'mcp-notes')
- 'mcp-notes-server': (指定执行 'mcp-notes' 包中的 'mcp-notes-server' 命令,即 MCP 服务器的入口)
- '--dynamodb': (参数名,指定 DynamoDB 连接字符串)
- 'dynamodb://<access_key>:<secret_key>@<region>/<table>': (DynamoDB 连接字符串,请替换以下占位符:
- '<access_key>': 您的 AWS Access Key ID
- '<secret_key>': 您的 AWS Secret Access Key
- '<region>': 您的 DynamoDB 表所在的 AWS 区域 (例如 'us-east-1')
- '<table>': 您的 DynamoDB 表名称 (例如 'mcp-notes') )
基本使用方法
配置完成后,在您的 MCP 客户端中连接到 'mcp-notes' 服务器。您可以使用 AI 模型的工具调用功能,通过以下工具与笔记服务器进行交互:
- 'listNotes': 列出笔记,可以根据标签进行过滤。
- 'getNote': 根据 ID 获取指定笔记的详细内容。
- 'writeNote': 创建或更新笔记。需要提供笔记的 ID, 标题, 摘要, 标签和内容。
- 'deleteNote': 根据 ID 删除指定笔记。
具体工具的使用方法和参数请参考仓库 'README.md' 文档中 "🔧 Available MCP Tools" 章节的描述。
您还可以通过 Web 界面 (默认地址: 'http://localhost:3100') 手动查看和管理笔记。启动 Web 服务器的命令请参考仓库 'README.md' 文档中 "🚀 Running Web Servers" 章节。
信息
分类
生产力应用