使用说明
🧠 第二脑MCP
你的代码,但像记忆一样可搜索。停止唠叨,开始记忆。语义搜索MCP服务器为您的代码库——问自然的问题,得到聪明的答案。
太长,读不下去了
第二脑MCP 是一个本地服务器,它为您的代码和其他基于文本的文件建立索引,允许您使用自然语言执行语义搜索。它作为模型上下文协议(MCP)服务器运行,因此您可以从任何兼容MCP的客户端与它进行交互。它使用OpenAI的嵌入模型来理解代码的含义,而不仅仅是关键字。
🛠️ 技术栈
这个项目是一个基于TypeScript的Node.js应用程序。
| 组件 | 技术 | 关键库/框架 |
|---|---|---|
| 应用程序运行时 | Node.js | TypeScript, @modelcontextprotocol/sdk |
| 数据库 | SQLite | better-sqlite3 |
| 嵌入 | OpenAI | openai |
| 发展 | 包管理器 | npm |
🚀 快速开始
以下说明针对Linux环境(Ubuntu/Debian)进行了优化。
先决条件
你必须有 Node.js(v20+) 和 npm 安装。
-
克隆仓库
git clone https://github.com/RyanMaxiemus/second-brain-mcp.git cd second-brain-mcp -
配置环境变量
您将需要一个OpenAI API密钥。您可以将其设置为环境变量:
export OPENAI_API_KEY="YOUR_OPENAI_API_KEY" -
安装依赖项
安装所有必需的Node.js依赖项。
npm install -
构建应用程序
将TypeScript代码编译为JavaScript。
npm run build -
运行应用程序
启动MCP服务器。
npm start服务器将运行并准备接受来自MCP客户端的连接。
🤝 贡献
发现bug了吗?有新功能的想法吗?我们欢迎所有的贡献!
- 打开问题: 在提交Pull Request之前,请打开一个问题来讨论您正在处理的错误或功能。这有助于防止重复工作,并确保与项目目标保持一致。
- 叉和分支: 分叉存储库并为您的贡献创建一个新分支。
- 代码和提交: 编写干净、文档齐全的代码。提交消息应该是描述性的,并遵循传统格式(例如。,
feat: add support for local embeddings). - 提交PR: 提交针对以下对象的拉取请求
main支。我们会尽快进行审查。
让我们一起让Second Brain成为最直观的代码搜索工具。
