Local Knowledge

April 4, 2025 · View on GitHub

Local Knowledge是一个基于Model Context Protocol (MCP)的服务，用于管理和提供本地知识库。

简介

本服务允许进行有项目区分地、有索引地、动态地保存、更新和查询本地知识，将不同的知识作用于不同的工作区，以便大语言模型能够访问与当前工作区有关的知识。知识以JSON格式存储，并支持多种内容获取方式：直接内容、文件读取和脚本动态生成。

功能

列出所有知识描述，获取相关知识索引
根据索引查询知识详情
添加新知识
更新已有知识

工作目标

让mcp客户端根据已解决的问题总结知识，并马上将知识作用于接下来的问题解决中。

通过描述和索引机制，降低与当前问题无关的知识对上下文窗口的污染，节约token。

安装

可以从下载页面下载不同版本的wheel文件，使用pip进行安装：

pip install local_knowledge-0.1.0-py3-none-any.whl

本地构建

# 本地构建安装包
python setup.py sdist bdist_wheel

使用方法

配置

典型的cline mcp配置

"mcpServers": {
  "local_knowledge": {
    "command": "python",
    "args": ["-m", "local_knowledge"]
  }
}

提示词示例

可以在 mcp 客户端的 rules（例如.clinerules）中添加：

每次用户有新的任务需求时，为了了解解决用户问题有哪些注意事项和可以参考的知识点，需要率先在local_knowledge mcp服务中进行查找，发现是否有需要遵循的规则或者与用户问题相关的可以利用的知识。

完成任务后：

请回忆上述任务需求，总结完成任务的过程中，遇到了哪些阻碍，有哪些值得关注、需要长期记录，以便后续解决问题时，可以遵循或者借鉴的经验或者规范。将总结的内容，使用local_knowledge mcp服务进行记录，或者更新其中已存在的相似类型的知识。

tips:

可以将“完成任务后”的规则也写进rules中，但最好添加让mcp客户端向用户进行确认的步骤，以便审核和修改保存的内容，防止存入过多无效的信息

机制

文件结构

知识库默认保存在工作目录的.knowledge文件中，以JSON格式存储。

由于每个工作目录的知识库文件是不同的，所以对于不同的工作区，可以访问不同的本地知识库

每条知识条目包含以下字段：

index: 知识的唯一序号
description: 知识的大体描述，用于让模型判断是否需要查询该条知识
detail: (可选) 知识的具体内容
detail_file: (可选) 知识内容的文件路径
detail_script: (可选) 获取知识内容的脚本路径

字段协同工作机制

在查询知识详情时，系统会按照以下逻辑处理这些字段：

description字段：始终会被包含在返回结果中，作为知识的描述部分。
detail字段：如果存在，系统直接将其内容添加到结果中。这适用于简短且静态的知识内容。
detail_file字段：如果存在，系统会尝试读取指定文件的内容并添加到结果中。
- 可以使用相对路径（相对于知识库文件目录）或绝对路径
- 如果文件不存在或读取失败，会返回相应的错误信息
detail_script字段：如果存在，系统会：
- 加载指定的Python脚本（可以是相对路径或绝对路径）
- 调用脚本中的detail()函数
- 将函数返回的内容添加到结果中
- 如果脚本执行失败，会返回相应的错误信息
优先级与组合：这三种内容获取方式（detail、detail_file、detail_script）不互斥，可以同时存在。系统会按顺序处理并将所有获取到的内容组合成一个完整的知识详情返回。

示例：一个知识条目可能同时包含基本说明（detail）、详细文档（detail_file）和动态生成的最新数据（detail_script）。

{
  "index": 1,
  "description": "产品A的规格说明",
  "detail": "产品A是一款高性能设备，支持...",
  "detail_file": "docs/productA_details.md",
  "detail_script": "scripts/get_latest_specs.py"
}