项目介绍
CodeArchitect MCP
你的AI对话不应消失。 CodeArchitect MCP 自动保存并检索你与AI助手的讨论,解决了开发者上下文连续性的问题。无需重复解释架构决策或代码解决方案。基于模型上下文协议(MCP)构建,与Cursor和VS Code无缝集成。扩展到全面的系统设计和架构辅助。
快速开始
1. 安装Node.js
从nodejs.org下载(v18+)。打开终端 → 输入 node --version 验证。
2. 安装包
npm install -g codearchitect-mcp
3. 配置IDE
<details>
<summary><b>📘 Cursor用户 - 完整设置指南</b></summary>
步骤1:打开Cursor设置
- 打开Cursor(代码编辑器)
- 查看左下角 - 点击齿轮图标 ⚙️(或在Windows/Linux上按
Ctrl+,,在Mac上按 Cmd+,)
- 这将打开设置
步骤2:查找MCP设置
- 在顶部的设置搜索框中输入:“MCP” 或 “模型上下文协议”
- 应该能看到“工具及MCP”部分
- 点击它
步骤3:添加CodeArchitect服务器
- 查找“MCP服务器”或“添加服务器”按钮
- 点击“添加服务器”或“+”按钮
- 将出现一个表单。填写如下内容:
- 名称:
codearchitect(或你喜欢的任何名称)
- 命令:
npx
- 参数:
-y codearchitect-mcp@latest
- 点击保存或确定
或者(替代方法 - 手动配置文件):
- 关闭Cursor
- 打开文件资源管理器(Windows)或Finder(Mac)
- 转到您的主文件夹:
- Windows:
C:\Users\YourName\.cursor\(如果不存在,请创建.cursor文件夹)
- Mac/Linux:
~/.cursor/(如果不存在,请创建.cursor文件夹)
- 在该文件夹中创建名为
mcp.json的文件
- 使用任何文本编辑器打开它,并粘贴以下内容:
{
"mcpServers": {
"codearchitect": {
"command": "npx",
"args": ["-y", "codearchitect-mcp@latest"]
}
}
}
- 保存文件
- 再次打开Cursor
步骤4:验证是否正常工作
- 在Cursor底部的状态栏查看
- 应该看到“MCP”或“codearchitect”带有绿色点(连接状态)
- 如果看到红色或黄色,则出现问题 - 参见下方故障排除
步骤5:重新加载Cursor
- 按
Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(Mac)
- 输入:“重载窗口”
- 按回车键
- Cursor将重启 - 等待其完成加载
步骤6:测试是否正常工作
- 在Cursor中打开任何聊天/对话
- 输入:“使用codearchitect”
- 应该看到功能列表和工作流程指南
- 如果看到错误,请参见下方故障排除
导出聊天(如何保存对话)
- 在Cursor聊天中,查看右上角
- 点击三个点菜单(⋯)
- 点击“导出聊天”
- 出现保存对话框
- 导航至:
C:\Users\YourName\.codearchitect\exports\(Windows)或~/.codearchitect/exports/(Mac/Linux)
- 点击“保存”
- 文件将以
.md格式保存(这是正常的)
需要帮助?
卡在任何步骤了吗? 联系Tair:
</details>
<details>
<summary><b>📘 VS Code用户 - 完整设置指南</b></summary>
步骤1:打开命令面板
- 打开VS Code(Visual Studio Code)
- 按
Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(Mac)
- 顶部会出现一个框 - 这是命令面板
步骤2:添加MCP服务器
- 在命令面板框中输入:“MCP: 添加服务器”
- 应该能看到“MCP: 添加服务器...”出现在列表中
- 点击它(或按回车键)
步骤3:选择安装方式
- 出现一个菜单询问如何安装
- 选择:“通过npm包下载”(点击它)
- 另一个框会询问包名
步骤4:输入包名
- 精确输入:
codearchitect-mcp
- 按回车键
- VS Code将下载并安装它(等待几秒钟)
步骤5:验证是否正常工作
- 查看VS Code右下角
- 应该看到“MCP”或“codearchitect”带有绿色指示符(连接状态)
- 如果看到红色或错误,请参见下方故障排除
步骤6:重新加载VS Code
- 再次按
Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(Mac)
- 输入:“开发者:重载窗口”
- 按回车键
- VS Code将重启 - �等待其完成加载
步骤7:测试是否正常工作
- 在VS Code中打开任何聊天/对话
- 输入:“使用codearchitect”
- 应该看到功能列表和工作流程指南
- 如果看到错误,请参见下方故障排除
导出聊天(如何保存对话)
- 在VS Code聊天中,按
Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(Mac)
- 输入:“导出聊天”
- 从列表中点击“导出聊天”
- 出现保存对话框
- 重要:给文件命名有意义的内容,如:
auth-implementation.json
database-design.json
api-routes.json
- (使用
.json作为结尾 - VS Code会自动添加)
- 导航至:
C:\Users\YourName\.codearchitect\exports\(Windows)或~/.codearchitect/exports/(Mac/Linux)
- 点击“保存”
- 文件将以
.json格式保存(这是正常的 - CodeArchitect支持这种格式!)
需要帮助?
卡在任何步骤了吗? 联系Tair:
- 电子邮件:查看GitHub个人资料获取联系方式
- GitHub问题:[github.com/tairqaldy/codearchitect-mcp/issues](https://github.com/t
tairqaldy/codearchitect-mcp/issues)
- 提及您所在步骤以及遇到的情况
</details>
4. 验证设置
- 检查MCP状态:应在IDE中显示绿色/已连接
- 测试:输入
"使用codearchitect" - 应看到功能列表
- 如果未正常工作:重新加载IDE并检查MCP日志 / 联系Tair
5. 开始使用
"使用codearchitect" - 查看功能和工作流程指南
"使用codearchitect存储会话" - 保存对话
"使用codearchitect获取会话" - 检索会话
存储
主要位置:~/.codearchitect/sessions/(始终)
- Windows:
C:\Users\YourName\.codearchitect\sessions\
- Linux/Mac:
~/.codearchitect/sessions/
可选:也保存到项目文件夹(指定projectDir)
导出:~/.codearchitect/exports/(用于检测导出文件)
工作流
- 导出聊天 → 保存到
~/.codearchitect/exports/
- 存储会话 →
"使用codearchitect存储会话"
- 检索 →
"使用codearchitect获取会话 [主题]"
- 重复 → 迭代构建知识库
文档
链接
由Tair Kaldybayev精心制作 ❤️