使用说明
项目简介
mcp-server-memos-py 是一个 Python 包,它实现了 Model Context Protocol (MCP) 服务器,旨在为大型语言模型 (LLM) 提供与 Memos 服务器交互的能力。通过此 MCP 服务器,LLM 客户端可以调用预定义的工具来访问和操作 Memos 知识库中的备忘录和标签。
主要功能点
- 备忘录搜索: 使用关键词在 Memos 中搜索备忘录内容。
- 创建备忘录: 在 Memos 中创建新的备忘录,并可自定义备忘录的可见性(公开、保护、私有)。
- 获取备忘录内容: 根据备忘录 ID 检索特定备忘录的详细内容。
- 标签管理: 列出和管理 Memos 服务器中已有的标签。
安装步骤
- 确保你的 Python 环境已安装 pip。
- 打开终端或命令提示符,运行以下命令安装 mcp-server-memos-py 包:
pip install mcp-server-memos
服务器配置
为了让 MCP 客户端能够连接到 mcp-server-memos-py 服务器,你需要在 MCP 客户端的配置文件中添加或修改 'mcpServers' 部分。以下是一个配置示例,你需要根据你的 Memos 服务器信息进行相应的修改:
{ ..., "mcpServers": { "memos": { // 服务器名称,可以自定义 "command": "mcp-server-memos", // 启动 MCP 服务器的命令 "args": [ "--host", "YOUR_MEMOS_HOST", // 替换为你的 Memos 服务器主机名或IP地址,例如 "localhost" 或 "192.168.1.100" "--port", "YOUR_MEMOS_PORT", // 替换为你的 Memos 服务器端口号,例如 "5230" 或 "8080" "--token", "YOUR_MEMOS_ACCESS_TOKEN" // 替换为你的 Memos 访问令牌,用于身份验证 ] } } }
参数说明:
- 'serverName': MCP 服务器的名称,用于在客户端配置中引用。可以自定义,例如 "memos"。
- 'command': 启动 mcp-server-memos-py 服务器的命令,通常为 'mcp-server-memos'。
- 'args': 传递给 'mcp-server-memos' 命令的参数列表,用于配置 Memos 服务器的连接信息和身份验证:
- '--host': Memos 服务器的主机名或 IP 地址。
- '--port': Memos 服务器的端口号。
- '--token': 用于访问 Memos 服务器的访问令牌。你需要在 Memos 服务器中生成访问令牌并在此处配置。
请将 'YOUR_MEMOS_HOST'、'YOUR_MEMOS_PORT' 和 'YOUR_MEMOS_ACCESS_TOKEN' 替换为你的实际 Memos 服务器配置信息。
基本使用方法
配置完成后,MCP 客户端就可以通过 'memos' 这个服务器名称来调用 mcp-server-memos-py 提供的工具。以下是可用的工具及其参数:
| 工具名称 | 描述 | 参数 | |-------------------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------| | 'list_memo_tags' | 列出所有备忘录标签 | - 'parent': 标签的所有者 (格式: memos/{id}, 默认为 "memos/-" 表示列出所有标签)<br/>- 'visibility': 标签可见性 (PUBLIC/PROTECTED/PRIVATE, 默认为 PRIVATE) | | 'search_memo' | 搜索备忘录内容 | - 'key_word': 搜索关键词 | | 'create_memo' | 创建新的备忘录 | - 'content': 备忘录内容<br/>- 'visibility': 备忘录可见性 (PUBLIC/PROTECTED/PRIVATE, 默认为 PRIVATE) | | 'get_memo' | 获取指定ID的备忘录内容 | - 'name': 备忘录名称/ID (格式: memos/{id}) |
例如,在 MCP 客户端中调用 'search_memo' 工具搜索关键词 "会议记录" 的请求可能如下所示:
{ "tool_call": { "tool_name": "search_memo", "tool_args": { "key_word": "会议记录" } } }
请参考 MCP 客户端的文档,了解如何在你的 LLM 应��中集成和使用这些工具。
信息
分类
生产力应用