项目简介

KeepInMind是一款智能命令行个人助理,旨在通过直观的命令行界面简化联系人和笔记管理。它结合了传统软件工程的优势与前沿的AI能力,支持自然语言理解,并能够通过Model Context Protocol (MCP) 与大型语言模型(LLM)客户端无缝集成,提供上下文信息和功能。

主要功能点

  • 联系人管理: 存储姓名、电话、电子邮件、地址和生日,支持智能搜索和生日提醒。
  • 笔记组织: 创建带标题和内容的富文本笔记,支持灵活的标签系统和全文搜索。
  • AI自然语言处理 (NLP): 理解自然语言命令,进行意图识别和实体提取,使交互更自然。
  • MCP 服务器集成: 作为MCP服务器,向LLM客户端(如Claude Desktop)暴露39个工具,实现AI驱动的命令执行和数据同步。
  • 多种运行模式: 提供传统命令行模式、AI驱动的NLP模式,以及基于Gradio的Web UI模式。
  • 数据持久化: 支持SQLite(默认)、JSON和Pickle等多种存储选项,确保数据安全和可读性。

安装步骤

  1. Python 环境准备: 确保您的系统已安装 Python 3.10 或更高版本,以及 'pip' 包管理器。
  2. 克隆仓库: 打开终端或命令行工具,执行以下命令克隆项目仓库:
    git clone https://github.com/kms-engineer/assistant-bot.git
    cd assistant-bot
  3. 安装依赖: 切换到项目目录后,安装所有必需的Python依赖:
    pip install -r requirements.txt
  4. 启动(经典模式):
    python3 -m src.presentation.cli.main
  5. 启动(NLP AI模式):
    python3 -m src.presentation.cli.main --nlp
    首次运行NLP模式时,会自动下载ML模型(约400MB)。

服务器配置 (用于MCP客户端)

要将此助手作为MCP服务器与兼容的LLM客户端(如Claude Desktop)连接,您需要配置客户端。以下是配置 'claude_desktop_config.json' 文件的示例和说明:

  1. 找到配置文件:

    • macOS/Linux: '~/Library/Application Support/Claude/claude_desktop_config.json'
    • Windows: '%APPDATA%\Claude\claude_desktop_config.json'
  2. 添加 MCP 服务器配置: 在 'mcpServers' 部分添加 'assistant-bot' 的配置。请将 'cwd' (current working directory) 路径替换为您克隆 'assistant-bot' 仓库的绝对路径。您可以在仓库根目录运行 'pwd' 命令获取此路径。

    {
      "mcpServers": {
        "assistant-bot": {
          "command": "python3",
          "args": ["-m", "src.web.server_stdio"],
          "cwd": "/absolute/path/to/assistant-bot"  // <-- 请替换为您的项目绝对路径
        }
      }
    }
  3. 重启 Claude Desktop: 保存配置后,重启您的Claude Desktop应用程序,即可通过AI助手与您的个人助理机器人互动。

基本使用方法 (通过LLM客户端)

配置完成后,您可以通过与LLM客户端(如Claude)对话来控制此助手,例如:

  • "添加一个名为Sarah的联系人,电话号码是555-1234。" (Add a contact named Sarah with phone 555-1234)
  • "显示我所有的联系人。" (Show all my contacts)
  • "创建一个笔记:明天给Sarah打电话。" (Create a note: Call Sarah tomorrow) LLM客户端将自动调用 'assistant-bot' 的MCP工具来执行这些操作,并将结果返回给您。

信息

分类

生产力应用