Code Knowledge Tool

这是一个使用向量嵌入技术管理代码仓库知识的工具。该工具通过高级嵌入技术帮助维护和查询有关您的代码库的知识。

构建与安装

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许可证