KK

kanna12580/kk-knowledge-agent

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

52 stars 5 forks 质量 59 趋势 17

轻量级知识库系统,支持知识库管理、文本/txt 上传、语义检索、流式返回,并将检索能力封装为 MCP Server,供 Agent 调用。

概览

轻量级知识库 Agent 项目,支持知识库管理、文本/txt 上传、分块向量化、语义检索、流式返回,并通过 MCP Server 暴露给 Agent 调用。 前端知识库和文档工作流程: - 带分页的知识库CRUD。- 直接文本文档上传。- .txt文件上传。- 分块和本地多语言嵌入。- ChromaDB 语义检索。- SSE 流式搜索。- MCP 工具:search_knowledge_base。- 使用 pytest 进行基础测试。 请遵循 AGENTS.md 分阶段实施计划。 关于详细的后端、前端和MCP服务器设置,请参见docs/LOCAL_INSTALLATION.md。 - 添加 Docker Compose,实现单命令本地部署。- 用 PostgreSQL 替代 SQLite,用于生产环境。- 用 Qdrant 或 Milvus 替代 ChromaDB,以实现更大向量工作负载。- 增加 PDF/DOCX 上传功能。- 增加 BM25 + 矢量混合检索与重新排序支持。- 添加带有引用高亮的答案生成功能。

概述(AI 翻译)

轻量级知识库 Agent 项目,支持知识库管理、文本/txt 上传、分块向量化、语义检索、流式返回,并通过 MCP Server 暴露给 Agent 调用。

建筑

仓库布局

演示截图

前端知识库和文档工作流程:

Codex MCP 知识库工具调用:

本地设置

后端

API文档:

前端

演示应用:

MCP服务器

MCP 配置示例:

MVP范围

  • 带分页的知识库 CRUD。
  • 直接上传文本文档。
  • .txt 文件上传。
  • 分块与局部多语言嵌入。
  • ChromaDB 语义检索。
  • SSE流媒体搜索。
  • MCP工具:search_knowledge_base。
  • 基本测试,使用pytest。

发展顺序

请遵循 AGENTS.md 分阶段实施计划。

本地安装

关于详细的后端、前端和MCP服务器设置,请参见docs/LOCAL_INSTALLATION.md。

未来改进

  • 添加 Docker Compose,实现单命令本地部署。
  • 用 PostgreSQL 替代 SQLite 用于生产环境。
  • 用 Qdrant 或 Milvus 替代 ChromaDB,以处理更大的向量工作负载。
  • 添加PDF/DOCX上传。
  • 增加BM25 + 矢量混合检索和重新排序支持。
  • 添加带有引用高亮的答案生成功能。

本页由 AI 翻译,技术细节请以原文为准。

README

kk-knowledge-agent

轻量级知识库 Agent 项目,支持知识库管理、文本/txt 上传、分块向量化、语义检索、流式返回,并通过 MCP Server 暴露给 Agent 调用。

Architecture

Frontend
   |
   | HTTP
   v
Backend API
   |
   +--> SQLite
   +--> ChromaDB
   +--> sentence-transformers

Agent / Claude Code / OpenClaw / Hermas Agent
   |
   | MCP Tool Call
   v
MCP Server
   |
   | HTTP
   v
Backend API

Repository Layout

backend/       FastAPI API service
frontend/      React + Vite demo app
mcp-server/    MCP adapter server
examples/      Demo txt documents
AGENTS.md      Phased development guide for Codex/Agent

Demo Screenshots

Frontend knowledge base and document workflow:

Codex MCP knowledge base tool call:

Local Setup

Backend

cd backend
python -m venv .venv
.venv\Scripts\activate
pip install -r requirements.txt
copy .env.example .env
uvicorn app.main:app --reload --port 8000

API docs:

http://localhost:8000/docs

Frontend

cd frontend
npm install
npm run dev

Demo app:

http://localhost:5173

MCP Server

cd mcp-server
python -m venv .venv
.venv\Scripts\activate
pip install -r requirements.txt
copy .env.example .env
python server.py

MCP config example:

{
  "mcpServers": {
    "kk-knowledge": {
      "command": "python",
      "args": ["mcp-server/server.py"]
    }
  }
}

MVP Scope

  • Knowledge base CRUD with pagination.
  • Direct text document upload.
  • .txt file upload.
  • Chunking and local multilingual embedding.
  • ChromaDB semantic retrieval.
  • SSE streaming search.
  • MCP tool: search_knowledge_base.
  • Basic tests with pytest.

Development Order

Follow AGENTS.md for the phased implementation plan.

Local Installation

See docs/LOCAL_INSTALLATION.md for detailed Backend, Frontend, and MCP Server setup.

Future Improvements

  • Add Docker Compose for one-command local deployment.
  • Replace SQLite with PostgreSQL for production usage.
  • Replace ChromaDB with Qdrant or Milvus for larger vector workloads.
  • Add PDF/DOCX upload.
  • Add BM25 + vector hybrid retrieval and rerank support.
  • Add answer generation with citation highlights.
在 GitHub 查看完整 README

安装

This server does not publish a one-line install command.

Open the repository installation guide 新手?先看 mcpskill.org 教程 →

配置

{ "mcpServers": { "kk-knowledge": { "command": "python", "args": ["mcp-server/server.py"] } } }