代码知识工具

一个使用向量嵌入的代码仓库知识管理工具。该工具通过使用先进的嵌入技术，帮助维护和查询关于你的代码库的知识。

构建和安装

1. 构建包

首先，你需要构建分发文件：

# 克隆仓库
git clone https://github.com/yourusername/code-knowledge-tool.git
cd code-knowledge-tool

# 创建并激活虚拟环境
python -m venv venv
source venv/bin/activate

# 安装构建工具
python -m pip install --upgrade pip build

# 构建包
python -m build

这将在 dist/ 目录下创建两个文件：

• code_knowledge_tool-0.1.0-py3-none-any.whl (用于安装的 wheel 文件)
• code_knowledge_tool-0.1.0.tar.gz (源代码分发包)

2. 安装包

前提条件

1. 确保 Ollama 已安装并运行：

# 安装 Ollama (如果尚未安装)
curl https://ollama.ai/install.sh | sh

# 启动 Ollama 服务
ollama serve

2. 安装包：

选项 1：从 wheel 文件安装 (推荐用于使用)

# 导航到你构建包的位置
cd /path/to/code_knowledge_tool

# 从 wheel 文件安装
pip install dist/code_knowledge_tool-0.1.0-py3-none-any.whl

选项 2：以可编辑模式安装 (推荐用于开发)

如果你想修改该工具或为其开发做出贡献，此选项是最佳选择：

# 假设你已经在 code-knowledge-tool 目录中
# 并且已经激活了你的虚拟环境

# 以可编辑模式安装，并包含开发依赖项
pip install -e ".[dev]"

与 RooCode/Cline 集成

1. 将 MCP 配置复制到你的设置中：

对于 Cline (VSCode)：

# 打开设置文件
open ~/Library/Application\ Support/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json

添加以下配置：

{
  "mcpServers": {
    "code_knowledge": {
      "command": "python",
      "args": ["-m", "code_knowledge_tool.mcp_tool"],
      "env": {
        "PYTHONPATH": "${workspaceFolder}"
      }
    }
  }
}

对于 RooCode：

# 打开设置文件
open ~/Library/Application\ Support/RooCode/roocode_config.json

添加与上面相同的配置。

2. 重启 RooCode/Cline 以加载新工具。

用作记忆库和 RAG 上下文提供者

此工具可以用作你项目的记忆库和 RAG 上下文提供者。要设置此功能：

1. 将提供的模板复制到你的项目：

cp clinerules_template.md /path/to/your/project/.clinerules

2. 根据你项目的需要自定义 .clinerules 中的规则和模式

该模板包含以下方面的全面说明：

• 知识库管理
• 基于 RAG 的开发工作流程
• 代码质量指南
• 内存管理实践

有关完整的配置和使用详情，请参阅 clinerules_template.md。

功能特性

• 用于代码知识的本地向量存储
• 使用 Ollama 的高效嵌入生成
• 支持多种文件类型
• 上下文感知的代码理解
• 通过 MCP 与 RooCode 和 Cline 集成
• 基于 RAG 的上下文增强
• 持久的知识存储

要求

• Python 3.8 或更高版本
• 本地运行的 Ollama 服务
• chromadb 用于向量操作

开发

运行测试

该项目遵循集成优先的测试方法，侧重于端到端的功能和 MCP 合同的合规性。测试套件包括：

1. MCP 合同测试

   • 工具注册和执行
   • 资源管理
   • 知识操作
   • 错误处理

2. 包构建测试

   • 安装验证
   • 依赖项解析
   • MCP 服务器初始化
   • 基本功能

要运行测试：

# 安装测试依赖项
pip install -e ".[dev]"

# 运行所有测试
pytest

# 运行特定的测试套件
pytest tests/integration/test_mcp_contract.py -v  # MCP 功能
pytest tests/integration/test_package_build.py -v  # 安装验证

测试环境要求：

# 确保 Ollama 正在运行
ollama serve

测试使用一个临时目录 (test_knowledge_store)，该目录在测试运行之间自动清理。

有关测试策略和模式的更多详细信息，请参阅 docs/ 中的文档。

未来分发

如果你想通过 pip 提供此软件包（即 pip install code-knowledge-tool），你需要：

1. 在 PyPI 上注册一个帐户
2. 安装 twine：pip install twine
3. 上传你的分发包：twine upload dist/*

但是，目前，请使用上面描述的本地构建和安装方法。

许可证

MIT 许可证