使用说明
项目简介
Kips 是一个个人数据管理服务器,它实现了 Model Context Protocol (MCP),旨在为大型语言模型 (LLM) 提供结构化的个人数据访问能力。通过 Kips,你可以将笔记、任务、账户密码、对话记录等个人信息存储在本地 SQLite 数据库中,并允许支持 MCP 协议的 LLM 客户端(如 Claude Desktop)安全地访问和利用这些数据。
主要功能点
- 资源管理: 将 SQLite 数据库中的表作为资源暴露给 MCP 客户端,客户端可以获取表的结构信息(Schema)。
- 工具 (SQL 查询): 提供 "query" (只读查询), "insert", "update" 三种工具,允许 LLM 客户端通过执行 SQL 语句来查询、插入和更新数据库中的数据。
- 数据导入: 提供命令行工具,支持从 CSV 或文本文件导入 'auth' (认证信息), 'note' (笔记), 'conversation' (对话), 'task' (任务) 等类型的数据,并支持添加标签进行分类。
- Claude Desktop 集成: 特别为 Claude Desktop 设计,可以通过简单的配置使其能够连接到 Kips 服务器,从而让 Claude 具备访问和操作你个人数据的能力。
安装步骤
- 安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm (Node.js 包管理器)。
- 安装 Kips: 在命令行终端中,使用 npm 全局安装 kips:
或者,如果你想在本地项目中使用,可以克隆仓库后在项目目录下运行 'npm install'。npm install -g kips
服务器配置
MCP 服务器是为 MCP 客户端(例如 Claude Desktop)提供服务的。要让 Claude Desktop 连接到 Kips 服务器,你需要配置 Claude Desktop 的 MCP 服务器设置。
打开 Claude Desktop 的设置,找到 "MCP Servers" 或类似的选项(通常在 "Integrations" 或 "Advanced" 设置中)。点击 "Add Server" 或 "+" 按钮,并按照以下信息配置 Kips 服务器:
- Server Name: 'kips' (可以自定义,但建议使用 'kips' 以便识别)
- Command: 'npx'
- Arguments: 'kips serve'
配置信息 (JSON 格式,无需手动配置,Claude Desktop 客户端会自动处理):
{ "mcpServers": { "kips": { "command": "npx", "args": [ "kips", "serve" ] } } }
参数注释:
- '"command": "npx"': 指定启动 MCP 服务器的命令为 'npx'。'npx' 允许你运行本地安装或全局安装的 npm 包的可执行文件。
- '"args": ["kips", "serve"]': 指定传递给 'npx' 命令的参数。
- '"kips"': 调用 'kips' 命令行工具。
- '"serve"': 指示 'kips' 运行 MCP 服务器模式。
Windows 用户配置 (如果 Claude Desktop 和 Kips 运行在 Windows 系统上):
由于 Windows 系统执行 'npx' 可能存在路径问题,如果 Claude Desktop 无法连接到 Kips 服务器,可以尝试使用 Node.js 的绝对路径来配置 'command':
- Command: 'C:\Program Files\nodejs\node.exe' (请根据你的 Node.js 安装路径调整)
- Arguments: '[kips 脚本的绝对路径]' 你需要找到 'kips' 安装后的脚本路径。如果你是全局安装的,可以使用 'where kips' 命令在命令行中查找 'kips' 的路径,然后将路径补全为脚本的绝对路径,例如 'C:\Users\YourUsername\AppData\Roaming\npm\node_modules\kips\build\index.js'。
基本使用方法
-
启动 Kips 服务器: 安装并配置 Claude Desktop 后,确保 Kips 服务器已启动。通常,当你运行 'npx kips config' 并成功配置 Claude Desktop 后,Kips 服务器会在后台自动启动。如果未启动,你可以手动在命令行中运行 'npx kips serve' 命令来启动服务器。
-
导入数据: 使用 'kips import' 命令导入你的个人数据。例如:
- 导入笔记:'npx kips import note.txt --type note --tag "工作 想法"'
- 导入密码 (CSV 文件): 'npx kips import passwords.csv --type auth'
- 导入任务 (CSV 文件): 'npx kips import tasks.csv --type task --tag "个人项目"'
-
在 Claude Desktop 中连接资源: 重启 Claude Desktop (如果需要)。在 Claude Desktop 的界面中,你应该能看到一个锤子图标,表示已检测到 MCP 服务器。点击锤子图标,你将看到 Kips 服务器提供的资源列表(例如 'auth table', 'note table' 等)。点击每个资源旁边的 "plug" 图标来连接到该资源。
-
使用 LLM 工具: 连接资源后,你就可以在 Claude Desktop 中指示 Claude 使用 Kips 提供的工具来访问和操作你的数据。例如,你可以问 Claude "查询所有标签为 '工作' 的笔记" 或 "添加一个新任务 '完成 Kips 使用说明文档'"。 Claude 会根据你的指令调用 Kips 服务器的工具来执行相应的操作。
开发
如果你想在本地开发环境中使用 Kips,可以按照 README 中的 "Development" 部分的说明进行操作,使用 'npm run build' 构建项目,并使用 'node ./build/index.js config --debug' 命令配置 Claude Desktop 使用本地构建的脚本。
信息
分类
生产力应用