使用说明
项目简介
'keep-mcp' 是一个 MCP (Model Context Protocol) 服务器,它扩展了 LLM (大型语言模型) 应用的能力,使其可以安全且方便地与用户的 Google Keep 笔记进行交互。通过 'keep-mcp' 提供的工具,LLM 可以搜索、创建、更新和删除 Google Keep 笔记,从而实现更丰富的上下文感知和功能扩展。
主要功能点
- 搜索笔记: 允许 LLM 客户端根据关键词在用户的 Google Keep 笔记中进行搜索,快速检索相关信息。
- 创建笔记: 支持 LLM 客户端在 Google Keep 中创建新的笔记,方便用户通过 LLM 应用记录想法和信息。
- 更新笔记: 允许 LLM 客户端修改已有的 Google Keep 笔记的内容,保持笔记信息的及时更新。
- 删除笔记: 支持 LLM 客户端删除 Google Keep 笔记,方便用户管理笔记内容。
- 安全控制: 默认情况下,修改和删除操作仅限于由 'keep-mcp' 创建的笔记,可以通过 'UNSAFE_MODE' 选项解除限制。
安装步骤
- 前提条件: 确保你的系统已安装 Python 和 pipx。pipx 是一个用于安装和运行 Python 应用的工具,可以有效隔离依赖。如果未安装 pipx,请参考 pipx 官方文档 进行安装。
- 安装 'keep-mcp': 打开终端或命令提示符,运行以下命令安装 'keep-mcp':
这将安装 'keep-mcp' 及其依赖。pipx install keep-mcp
服务器配置
为了让 MCP 客户端能够连接到 'keep-mcp' 服务器,需要在 MCP 客户端的配置文件中添加服务器配置信息。以下是一个典型的 JSON 格式配置示例,你需要根据你的实际情况进行调整:
{ "serverName": "keep-mcp-server", "command": "pipx", "args": [ "run", "keep-mcp" ], "env": { "GOOGLE_EMAIL": "你的Google邮箱地址", "GOOGLE_MASTER_TOKEN": "你的Google Master Token" } }
配置参数说明:
- '"serverName"': 为你的 'keep-mcp' 服务器指定一个名称,例如 '"keep-mcp-server"'。这个名称将在 MCP 客户端中用于标识和调用该服务器。
- '"command"': 指定启动服务器的命令。由于我们使用 'pipx' 安装了 'keep-mcp',这里使用 'pipx' 作为命令执行器。
- '"args"': 传递给 'command' 的参数列表。'["run", "keep-mcp"]' 表示使用 'pipx run' 命令来运行 'keep-mcp' 可执行程序。
- '"env"': 设置服务器运行所需的环境变量。
- '"GOOGLE_EMAIL"': 必须配置。 替换为你的 Google 账户邮箱地址。'keep-mcp' 服务器将使用此邮箱地址访问 Google Keep API。
- '"GOOGLE_MASTER_TOKEN"': 必须配置。 替换为你的 Google 账户 Master Token。Master Token 用于 Google Keep API 的身份验证。 请务必参考 gkeepapi 文档 和 gpsoauth 文档 获取 Master Token 的方法。 Master Token 涉及到你的 Google 账户安全,请妥善保管,并避免泄露。
可选配置:
- '"env"' 中可以添加 '"UNSAFE_MODE": "true"' 来解除对笔记修改和删除操作的限制,允许操作任何 Google Keep 笔记,而不仅仅是 'keep-mcp' 创建的笔记。请谨慎使用 'UNSAFE_MODE',因为它可能会带来数据安全风险。
基本使用方法
'keep-mcp' 服务器安装配置完成后,需要通过 MCP 客户端与其建立连接并调用其提供的工具。 具体使用方法取决于你使用的 MCP 客户端。 通常,你需要配置 MCP 客户端连接到名为 '"keep-mcp-server"' (或你在 '"serverName"' 中配置的名称) 的服务器,然后可以使用以下工具:
- 'find': 搜索笔记。 例如,可以传递参数 '{"query": "你的搜索关键词"}' 来搜索包含特定关键词的笔记。
- 'create_note': 创建新笔记。 可以传递参数 '{"title": "笔记标题", "text": "笔记内容"}' 来创建带有标题和内容的笔记。
- 'update_note': 更新笔记。 需要指定 'note_id' (笔记ID),以及可选的 'title' 和 'text' 参数来更新笔记。
- 'delete_note': 删除笔记。 需要指定 'note_id' 来删除指定的笔记。
请参考你的 MCP 客户端的文档,了解如何配置和调用 MCP 服务器的工具。
信息
分类
生产力应用