DevMind MCP
DevMind MCP 是一个智能上下文感知记忆系统,为AI助手提供持久的记忆能力。通过模型上下文协议(MCP),它使AI能够在对话中记住上下文,自动跟踪开发活动,并智能地检索相关信息。
MCP 服务配置
复制以下 JSON 到 OPClaw 或其他 MCP 客户端的配置文件中即可使用
{
"mcpServers": {
"devmind": {
"args": [
"-y",
"devmind-mcp@latest"
],
"command": "npx"
}
}
}
服务介绍
DevMind MCP
为AI助手打造的智能上下文感知记忆系统
为什么选择 DevMind MCP?
- 纯 MCP 工具 - 通过模型上下文协议与 AI 助手无缝集成
- 混合搜索 - 语义 40% + 关键词 30% + 质量 20% + 新鲜度 10%
- 100% 私密 - 所有数据本地存储在 SQLite,零云端传输
- 14 个 MCP 工具 - 完整的记忆管理和项目分析工具集
- 跨平台支持 - 兼容 Claude Desktop、Cursor 及所有 MCP 客户端
目录
概览
什么是 DevMind MCP?
DevMind MCP 通过模型上下文协议(MCP)为AI助手提供持久性记忆功能。它使AI能够跨对话记住上下文,自动跟踪开发活动,并智能检索相关信息。
核心特性
主要功能
- 类型驱动自动记忆 - 基于上下文类型的简化智能记录
- Tier 1: 自动记录技术执行(bug_fix、feature_add、code_modify)- 静默
- Tier 2: 自动记录并通知(solution、design、documentation)- 可删除
- Tier 3: 不自动记录(conversation、error)- 除非 force_remember=true
- 智能记忆 - 通过 MCP 协议实现 AI 驱动的上下文记录
- 语义搜索 - AI驱动的向量嵌入搜索,查找相关上下文
- 持久存储 - 基于SQLite的本地存储,完全私密
- 混合搜索 - 结合关键词和语义搜索,获得最佳结果
- 实时响应 - 开发过程中记录,即时检索
- 跨工具支持 - 兼容多个MCP客户端和开发环境
- 专业文档生成 - AI驱动的项目分析和DEVMIND.md生成
- 多语言支持 - 自动检测生成中文/英文文档
- 统一会话 - 每个项目一个主会话,保持上下文一致
技术特性
- 完整的MCP协议实现
- 统一会话管理(每个项目一个主会话)
- 自动会话重新激活
- 可自定义存储路径和行为
- 高效处理数千个上下文
- 自动清理和内存优化
- 健壮的错误处理和恢复
架构设计
┌──────────────────────────────────────────────────────────────┐
│ AI 助手 │
│ (Claude Desktop / Cursor / 等) │
└────────────────────────┬─────────────────────────────────────┘
│ MCP 协议 (stdio)
▼
┌──────────────────────────────────────────────────────────────┐
│ DevMind MCP 服务器 │
│ ┌─────────────────┐ ┌─────────────────┐ ┌──────────────┐│
│ │ 14 MCP 工具 │ │ 类型驱动记忆 │ │ 混合搜索 ││
│ │ │ │ │ │ ││
│ │ • 会话 (4) │ │ │ │ • 语义搜索 ││
│ │ • 上下文 (6) │ │ • 3个层级 │ │ • 关键词 ││
│ │ • 项目 (2) │ │ • 智能类型 │ │ • 质量评分 ││
│ │ • 可视化 (1) │ │ • 懒加载评分 │ │ • 新鲜度 ││
│ │ • 状态 (1) │ │ │ │ ││
│ └─────────────────┘ └─────────────────┘ └──────────────┘│
└────────────────────────┬─────────────────────────────────────┘
│
▼
┌──────────────────────────────────────────────────────────────┐
│ SQLite 本地存储 │
│ Projects • Sessions • Contexts • Relations • Embeddings │
│ + 自动生成质量评分 (懒加载更新,每24小时) │
└──────────────────────────────────────────────────────────────┘
核心组件:
- 14 个 MCP 工具 - 会话管理 (4)、上下文操作 (6)、项目功能 (2)、可视化 (1)、状态 (1)
- 类型驱动自动记忆 - 基于上下文类型的简化3层策略
- 混合搜索 - 多维度评分:语义 40% + 关键词 30% + 质量 20% + 新鲜度 10%
- 本地存储 - SQLite 数据库,包含向量嵌入和全文搜索索引
📍 项目结构
devmind-mcp/
├── src/
│ ├── mcp-server.ts # MCP协议服务器
│ ├── database.ts # SQLite存储引擎
│ ├── vector-search.ts # 语义搜索(嵌入向量)
│ ├── session-manager.ts # 会话与上下文管理
│ ├── content-extractor.ts # 代码分析与提取
│ ├── content-quality-assessor.ts # 内容质量评分
│ ├── quality-score-calculator.ts # 多维度质量评分
│ ├── auto-record-filter.ts # 智能去重
│ ├── context-file-manager.ts # 文件变更追踪
│ ├── types.ts # 类型定义
│ ├── index.ts # 主入口
│ │
│ ├── memory-graph/ # 记忆图谱可视化
│ │ ├── index.ts # 图谱生成器主入口
│ │ ├── types.ts # 图谱类型定义
│ │ ├── data/
│ │ │ ├── GraphDataExtractor.ts # 数据库数据提取
│ │ │ ├── NodeBuilder.ts # 节点构建与标签生成
│ │ │ └── EdgeBuilder.ts # 边/关系构建
│ │ └── templates/
│ │ └── HTMLGenerator.ts # HTML可视化生成器
│ │
│ ├── utils/
│ │ ├── file-path-detector.ts # 智能文件检测
│ │ ├── git-diff-parser.ts # Git diff解析
│ │ ├── path-normalizer.ts # 跨平台路径处理
│ │ └── query-enhancer.ts # 搜索查询增强
│ │
│ └── project-indexer/
│ ├── index.ts # 项目分析器入口
│ ├── core/
│ │ └── ProjectMemoryOptimizer.ts
│ ├── strategies/
│ │ ├── SmartIndexingStrategy.ts
│ │ └── SecurityStrategy.ts
│ ├── tools/
│ │ ├── FileScanner.ts
│ │ ├── ContentExtractor.ts
│ │ └── ProjectAnalyzer.ts
│ └── types/
│ └── IndexingTypes.ts
│
├── dist/ # 编译输出
├── scripts/ # 维护脚本
└── docs/zh/ # 中文文档
---
## 快速开始
### 环境要求
- **Node.js** ≥ 20.0.0
- **MCP兼容客户端** (Claude Desktop、Cursor等)
### 安装
选择适合您的安装方式:
| 安装方式 | 命令 | 适用场景 | 自动更新 |
|:-------------|:-----------------------------|:------------------|:--------:|
| **NPX** | `npx -y devmind-mcp@latest` | 快速测试、首次使用 | 是 |
| **全局安装** | `npm install -g devmind-mcp` | 日常开发 | 否 |
| **源码安装** | `git clone + npm install` | 贡献代码、定制开发 | 否 |
### 逐步配置
#### 步骤 1: 添加到 MCP 客户端
编辑您的MCP客户端配置文件:
**配置文件位置:**
- **Windows**: `C:\Users\<用户名>\.claude.json` 或 `%USERPROFILE%\.claude.json`
- **macOS**: `~/.claude.json`
- **Linux**: `~/.claude.json`
**添加以下配置:**
```json
{
"mcpServers": {
"devmind": {
"command": "npx",
"args": ["-y", "devmind-mcp@latest"]
}
}
}
使用全局安装? 替换为: {"command": "devmind-mcp"}
步骤 2: 重启 MCP 客户端
重启Claude Desktop或您的MCP客户端以加载DevMind。
步骤 3: 尝试第一个命令
在您的AI助手中尝试:
"使用 semantic_search 查找有关身份验证的信息"
完成! DevMind现在正在用持久记忆增强您的AI。
下一步
使用指南
MCP工具速查
DevMind为您的AI助手提供 14个强大工具 和 1个专业提示:
项目分析
| 工具 | 用途 | 使用示例 |
|---|---|---|
project_analysis_engineer |
[PRIMARY] 全面项目分析 | 生成DEVMIND.md文档 |
注意: 此工具也可作为Prompt手动触发。
项目管理
| 工具 | 用途 | 使用示例 |
|---|---|---|
list_projects |
[RECOMMENDED] 列出所有项目和统计信息 | 查看跟踪项目 |
会话管理
| 工具 | 用途 | 使用示例 |
|---|---|---|
create_session |
创建新的开发会话 | 开始新功能开发 |
get_current_session |
获取当前活跃会话信息 | 检查当前上下文 |
end_session |
结束开发会话 | 完成工作 |
delete_session |
删除会话及所有上下文 | 清理旧会话 |
注意: DevMind自动管理每个项目的主会话。会话会在需要时自动创建并跨对话重新激活。
上下文操作
|| 工具 | 用途 | 使用示例 |
||------------------|---------------------|-----------------|
|| record_context | 存储开发上下文 | 保存bug修复方案 |
|| list_contexts | 列出所有上下文 | 查看项目历史 |
|| delete_context | 删除特定上下文 | 移除过时信息 |
|| update_context | 更新上下文内容/标签 | 完善文档 |
搜索与发现
|| 工具 | 用途 | 使用示例 |
||------------------------|------------------|--------------|
|| semantic_search | AI驱动的语义搜索 | 查找相关实现 |
|| get_related_contexts | 查找相关上下文 | 探索关联性 |
注意: Embedding自动生成于record_context。质量评分在搜索时自动更新(懒加载,每24小时)。
可视化
| 工具 | 用途 | 使用示例 |
|---|---|---|
export_memory_graph |
导出垂直时间轴图谱 (v1.19) | 6列类型分组的时间轴可视化 |
v1.19 新功能:记忆图谱采用清晰的垂直时间轴布局,固定节点位置,性能优化。
使用示例
存储上下文信息
// 存储开发上下文
await record_context({
content: "使用JWT令牌和刷新令牌实现用户身份验证",
type: "implementation",
tags: ["auth", "jwt", "security", "api"]
});
搜索和检索
// 查找相关上下文
const results = await semantic_search({
query: "我们是如何实现身份验证的?",
limit: 10
});
更新现有上下文
// 更新上下文信息
await update_context(contextId, {
content: "更新身份验证以支持OAuth2和SAML",
tags: ["auth", "jwt", "oauth2", "saml", "security"]
});
上下文化搜索
// 在特定时间范围内搜索
const results = await semantic_search({
query: "数据库优化",
timeRange: { days: 7 }
});
专业文档生成
概述
DevMind 的项目分析工程师使用AI自动分析您的代码库并生成全面、专业的文档。这种强大的基于提示的方法提供了比传统静态分析更深入的洞察。
主要特性
- AI驱动分析 - 深入理解代码模式、架构和业务逻辑
- 多语言支持 - 自动检测并生成中文或英文文档
- 专业品质 - 生成具有技术深度的DEVMIND.md格式文档
- 自动保存到记忆 - 文档自动保存到您项目的记忆中以便未来参考
- 可自定义焦点 - 针对架构、API、业务逻辑或安全等特定领域
- 多种格式 - 支持DEVMIND.md、技术规格和README格式
工作原理
项目扫描 → 代码分析 → AI处理 → 专业文档 → 记忆存储
│ │ │ │ │
智能文件 提取技术 生成深入 创建 DEVMIND.md 自动保存到
选择 洞察 分析 文档 可搜索数据库
使用方法
自然语言生成
中文:
- "为这个项目生成专业的DevMind文档"
- "创建全面的技术分析,使用DEVMIND.md格式"
- "分析这个代码库并生成专业文档"
英文:
- "Generate professional DevMind documentation for this project"
- "Create comprehensive technical analysis with DEVMIND.md format"
- "Analyze this codebase and generate professional documentation"
直接提示使用
// 中文文档
const analysis = await project_analysis_engineer({
project_path: "./my-project",
doc_style: "devmind",
language: "zh"
});
// 英文文档(自动检测)
const analysis = await project_analysis_engineer({
project_path: "./english-project",
doc_style: "devmind",
language: "en"
});
配置设置
基础配置
在项目根目录创建 .devmind.json:
{
"database_path": "~/.devmind/memory.db",
"max_contexts": 1000,
"search_limit": 20,
"auto_cleanup": true,
"vector_dimensions": 1536
}
配置选项
| 选项 | 类型 | 默认值 | 描述 |
|---|---|---|---|
database_path |
string | ~/.devmind/memory.db |
SQLite数据库文件位置 |
max_contexts |
number | 1000 |
最大存储上下文数量 |
search_limit |
number | 20 |
默认搜索结果限制 |
auto_cleanup |
boolean | true |
启用旧上下文自动清理 |
vector_dimensions |
number | 1536 |
向量嵌入维度 |
智能记录指南
DevMind 使用 3层类型驱动自动记忆策略:
Tier 1 (静默自动记录):
bug_fix、feature_add、feature_update、code_modify、code_refactor、code_optimize- 技术执行自动记录,无需确认
Tier 2 (通知自动记录):
solution、design、learning、documentation- 自动记录并提示删除通知(用户可根据需要移除)
Tier 3 (不自动记录):
conversation、error- 仅当force_remember=true时记录
最佳实践:
- 回答技术问题前使用
semantic_search - 单文件:使用
file_path+line_ranges - 多文件:使用
files_changed数组 - 用户说“记住这个”:设置
force_remember=true
完整MCP配置示例
使用NPX (推荐):
{
"mcpServers": {
"devmind": {
"command": "npx",
"args": ["-y", "devmind-mcp@latest"]
}
}
}
使用全局安装:
{
"mcpServers": {
"devmind": {
"command": "devmind-mcp"
}
}
}
重要提示: 配置更改后需要重启MCP客户端。
API参考
核心方法
record_context(context: ContextData): Promise<string>
存储新的上下文信息。
参数:
content(string) - 主要内容文本type(string) - 内容类型:solution、code、error、documentation、test、configurationtags(string[]) - 关联标签metadata(object) - 附加元数据
返回: 上下文ID字符串
示例:
const id = await record_context({
content: "修复WebSocket连接处理器中的内存泄漏",
type: "solution",
tags: ["websocket", "memory-leak", "bug-fix"]
});
project_analysis_engineer(options: AnalysisOptions): Promise<AnalysisPrompt>
新功能! 使用AI驱动的分析生成专业项目文档。
参数:
project_path(string) - 项目目录路径analysis_focus(string) - 关注领域:architecture,entities,apis,business_logicdoc_style(string) - 文档风格:devmind、claude、technical、readmelanguage(string) - 文档语言:en、zh、auto(默认: 自动检测)auto_save(boolean) - 自动保存分析结果到内存 (默认: true)
返回: 用于AI生成全面文档的分析提示
示例:
// 英文文档
const analysis = await project_analysis_engineer({
project_path: "./my-project",
doc_style: "devmind",
language: "en"
});
// 中文文档(自动检测或明确指定)
const analysis = await project_analysis_engineer({
project_path: "./my-chinese-project",
doc_style: "devmind",
language: "zh"
});
自然语言示例:
- "为这个项目生成专业的DevMind文档"
- "Generate professional DevMind documentation for this project" (英文)
- "创建全面的技术分析,使用DEVMIND.md格式"
semantic_search(query: SearchQuery): Promise<Context[]>
使用语义理解搜索相关上下文。
参数:
query(string) - 搜索查询limit(number) - 最大结果数 (默认: 20)type(string) - 按内容类型过滤tags(string[]) - 按标签过滤timeRange(object) - 时间范围过滤:{ days: 7 }
返回: 匹配上下文数组
示例:
const results = await semantic_search({
query: "身份验证实现",
limit: 10,
type: "implementation"
});
retrieve(id: string): Promise<Context | null>
通过ID获取特定上下文。
update_context(id: string, updates: Partial<ContextData>): Promise<boolean>
更新现有上下文。
示例:
await update_context(contextId, {
tags: ["websocket", "memory-leak", "bug-fix", "resolved"]
});
delete_context(id: string): Promise<boolean>
通过ID删除上下文。
实用方法
cleanup(): Promise<void>
执行数据库清理和优化。
stats(): Promise<DatabaseStats>
获取数据库统计信息和健康状态。
export(format: 'json' | 'csv'): Promise<string>
将所有上下文导出为指定格式。
使用场景
软件开发
- 跟踪实现决策和技术选择
- 跨开发会话维护上下文
- 存储和检索代码模式与片段
- 记录架构决策及其原因
研究与学习
- 从多个来源积累知识
- 建立相关概念之间的联系
- 在数周或数月内维护研究上下文
- 创建可搜索的个人知识库
项目管理
- 跟踪项目演进和关键决策
- 跨团队会议维护上下文
- 存储项目相关的见解和经验
- 记录事后总结和回顾
AI助手增强
- 为AI对话提供持久记忆
- 基于历史启用上下文感知响应
- 维护用户偏好和项目细节
- 支持与AI的长期关系建立
最佳实践
AI工具推荐用户规则
为了最大化 DevMind MCP 的效果,建议将以下规则添加到你的 AI 助手配置中(例如 Claude Desktop、Cursor、Warp 规则):
## DevMind Memory System
### Usage Principles
1. **Search First**: Use semantic_search when answering technical questions
2. **Record Immediately**: Call record_context after completing work, before responding to user
3. **Proactive Recording**: Don't wait for user to ask
### Critical Recording Point
**After editing any files** - This is the most important trigger, never skip.
### Content Requirements
- Markdown format with structure
- Match project language (Chinese/English)
- Concise and professional
为什么需要这些规则?
- 确保 AI 在回答前主动搜索记忆
- 强化完成任务后立即记录的行为
- 保持所有记录使用一致的 Markdown 格式
- 减少遗忘记录,提高记忆质量
在哪里添加:
- Claude Desktop:添加到自定义指令或系统规则
- Cursor:添加到项目根目录的
.cursorrules文件 - Warp:添加到 AI 规则/工作流
- 其他工具:添加到系统提示词或用户偏好设置
开发指南
环境设置
# 克隆仓库
git clone https://github.com/JochenYang/Devmind.git
cd Devmind
# 安装依赖
npm install
# 开发模式(带监听)
npm run dev
# 运行测试
npm test
# 类型检查
npm run type-check
# 代码检查
npm run lint
测试
# 运行所有测试
npm test
# 带覆盖率运行
npm run test:coverage
# 运行特定测试套件
npm test -- --grep "搜索功能"
构建
# 生产构建
npm run build
# 开发构建(带监听)
npm run build:dev
# 清理构建产物
npm run clean
🤝 贡献指南
我们欢迎为DevMind MCP做出贡献!请遵循以下步骤:
开发流程
- Fork 仓库
- 创建 功能分支:
git checkout -b feature/amazing-feature - 提交 更改:
git commit -m 'Add amazing feature' - 推送 到分支:
git push origin feature/amazing-feature - 打开 Pull Request
代码标准
- 遵循TypeScript最佳实践
- 维持80%以上的测试覆盖率
- 使用约定式提交消息
- 为所有公共API编写文档
- 为新功能添加测试
📄 许可证
本项目采用MIT许可证。详情请参阅LICENSE文件。
🔗 支持
- 问题反馈: GitHub Issues
- 讨论交流: GitHub Discussions
- NPM包: devmind-mcp
DevMind MCP - 为AI助手打造的智能上下文感知记忆系统
Made with ❤️ by Jochen