内容
# 代码思维
用于人工智能开发代理的持久化代码库内存和语义上下文引擎。
代码思维为人工智能代理和大型语言模型提供了一个持久化、实时的内存层，适用于大型代码库。 与其依赖原始的令牌转储或简单的关键词搜索，代码思维将软件架构索引到符号图和抽象语法树（AST）块中。 这使得人工智能工具能够分析依赖关系、跟踪代码更改并轻松导航复杂结构。
---
## 功能特点
- AST感知分块：智能地按结构（类、函数、方法）解析源文件，而不是任意的行数。
- 符号图存储：映射代码库实体之间的关系、交叉引用和依赖关系。
- 模型上下文协议（MCP）集成：直接连接到与MCP兼容的客户端，如Claude Desktop、Cursor或自定义代理框架。
- 自动文件扫描器：跟踪代码库更改并保持索引管道更新。
---
## 前置条件
在安装代码思维之前，请确保您的机器已具备以下条件：
- Python 3.10+
- Git
- 虚拟环境工具（venv 或 conda）
---
## 安装步骤
### 1. 克隆仓库
git clone https://github.com/twly7ho2/codemind.git
cd codemind
---
### 2. 设置虚拟环境
建议使用虚拟环境来管理与主系统隔离的依赖项。
在 Windows 上：
python -m venv venv
venv\Scripts\activate
在 macOS / Linux 上：
python3 -m venv venv
source venv/bin/activate
---
### 3. 安装包和依赖项
使用 pyproject.toml 以可编辑模式安装代码思维和所需包：
pip install --upgrade pip
pip install -e .
---
## 使用和执行
### 运行MCP服务器
代码思维公开了一个MCP服务器接口，以便直接与人工智能代理客户端进行通信。
要直接从终端启动服务器：
python -m codemind.mcp.server
---
### 本地MCP配置示例
要将代码思维连接到Claude Desktop或其他MCP客户端，请在 claude_desktop_config.json 中添加以下条目：
{
"mcpServers": {
"codemind": {
"command": "python",
"args": [
"-m",
"codemind.mcp.server"
],
"env": {
"PYTHONPATH": "C:\\Users\\YOUR_USERNAME\\codemind"
}
}
}
}
---
## 仓库结构
codemind/
|-- codemind/
| |-- indexer/
| | |-- engine.py # 主要索引编排引擎
| | `-- scanner.py # 代码库文件爬虫和变更检测
| |-- parser/
| | `-- chunker.py # 基于AST的语法块处理逻辑
| |-- storage/
| | `-- graph_store.py # 符号图和依赖存储
| `-- mcp/
| `-- server.py # 模型上下文协议服务器端点
|-- pyproject.toml # 构建系统和元数据配置
|-- .gitignore # 忽略的文件（venv、缓存、索引）
`-- README.md # 项目文档
---
## 贡献
欢迎贡献、问题和功能请求！
1. 分叉项目。
2. 创建功能分支（git checkout -b feature/AmazingFeature）。
3. 提交更改（git commit -m 'Add some AmazingFeature'）。
4. 推送到分支（git push origin feature/AmazingFeature）。
5. 打开拉取请求。
---
## 许可证
在MIT许可证下分发。有关更多信息，请参见LICENSE。
