使用说明(Markdown 格式):

  • 项目简介

    • Memex Twos MCP Server 是一个基于 MCP(Model Context Protocol)的后端服务,专门为 Twos 导出数据提供可查询的上下文服务。它通过 JSON-RPC 与客户端通信,向 LLM 客户端提供资源、工具和提示模板等能力,便于在本地实现隐私安全的上下文服务。
  • 主要功能点

    • 资源托管:提供数据库统计、人物列表、标签列表等只读资源,供客户端查询。
    • 工具注册与执行:实现如按日期查询、关键词全文检索、按人物/标签筛选等工具,支持分页和限制返回数量。
    • 数据库封装:依赖本地 SQLite 数据库,提供安全的只读查询接口。
    • 本地化部署:独立运行在本地,数据处理流程可选进行 grooming、实体分类等处理,并可通过 Claude Code 进行 AI 语义分析(可选)。
    • MCP 服务器实现:包含 list_resources、read_resource、list_tools、call_tool 等 MCP 端点,遵循 MCP 的标准协议规范。
    • 集成配置与测试脚本:提供配置生成功能、安装向导与简单的测试用例,方便在本地环境快速上手。
  • 安装步骤

    • 获取代码与依赖
      • 克隆仓库并进入目录
      • 按需执行设置向导或直接安装依赖(如 pip install -e .)
    • 运行 MCP 服务器
      • 使用 Python 模块方式启动(示例路径见仓库中的配置脚本):
        • 通过命令启动:python -m memex_twos_mcp.server
      • 服务器将通过标准输入/输出(stdio)与 MCP 客户端通信,客户端需要提供相应的启动命令和参数。
    • 可选项
      • 若要启用 AI 语义分析(Claude Code),需装配 Claude Code CLI 并在 grooming 流程中开启 --ai-analysis。
      • 通过 README / MCP_SETUP.md 了解数据转换、Grooming、实体分类等工作流。
  • 服务器配置(JSON 配置示例,适用于 Claude Desktop 等 MCP 客户端的连接配置)

    • server_name: memex-twos
    • command: "python"
    • args: ["-m", "memex_twos_mcp.server"]
    • cwd: "<项目根目录>"
    • env: { "PYTHONPATH": "<项目根目录>/src" }

    示例(文本展示,不作为代码块,请将占位符替换为实际路径): { "server_name": "memex-twos", "command": "python", "args": ["-m", "memex_twos_mcp.server"], "cwd": "<项目根目录>", "env": { "PYTHONPATH": "<项目根目录>/src" } } 注释说明:

    • server_name 表示 MCP 客户端在配置中引用的服务器名称,应与实际服务器标识一致。
    • command 与 args 定义了启动服务器的命令及参数;此处使用 Python 模块运行 memex_twos_mcp.server。
    • cwd 指向仓库根目录,确保能够正确定位模块与资源。
    • env 中的 PYTHONPATH 指向仓库的 src 目录,确保模块导入路径正确。
  • 基本使用方法

    • 启动与连接:
      • 以 MCP 客户端(如 Claude Desktop)为对等端,使用上述配置启动连接,客户端将通过 MCP 协议向服务器请求资源、执行工具、获取统计等信息。
    • 常用操作:
      • 列出可用资源与工具
      • 按照工具输入参数执行查询(如按日期范围、关键词搜索、按人物/标签筛选)
      • 读取资源(如数据库统计、人物清单、标签清单)以获得上下文信息
    • 数据流与安全性:
      • 数据处理多在本地完成,虽支持 AI 辅助分析,但 AI 部分也可在本地执行(前提是安装相应工具并获得授权)
      • 服务器通过 stdio 与客户端通信,确保本地隐私和离线使用能力
  • 主要注意事项

    • 运行环境需 Python 3.10+,并确保本地安装所依赖的包(mcp、解析工具、SQLite 驱动等)正确配置。
    • 数据库路径在配置中通过 MEMEX_DB_PATH 或配置文件提供,服务器会以只读方式提供查询能力。
    • 如需使用 Claude Code 进行 AI 分析,确保 Claude Code CLI 已安装且订阅可用。
  • 联系与扩展

    • 若需要扩展更多资源、工具或 Prompts,可以在 server.py 的对应端点与工具列表中添加实现。
    • 未来可将更多数据源接入 MCP 服务器,增强上下文能力与查询能力。

信息

分类

桌面与硬件