上下文同步工具

Context Sync 是一个为AI编码工具提供持久性项目记忆层的服务,支持项目身份、技术栈、活动工作、决策、约束和注意事项的存储与检索。

  • by Intina47
  • TypeScript
  • 本地部署
  • 189 星标
  • 更新于
在 GitHub 查看 Intina47/context-sync

使用说明

上下文同步

MCP上AI编码工具的本地首个项目内存。

上下文同步为代理提供了代码库的持久内存层:

  • 项目标识和技术栈
  • 主动工作、决策、约束和注意事项
  • 结构化文件探索
  • git感知上下文
  • 可选只读Notion查找

它的作用

上下文同步是为会话连续性而构建的。它不依赖于模型来记住早期的对话,而是存储重要的项目上下文,并使其可以通过小型MCP工具界面进行检索。

目前的核心工具是:

  • set_project
  • remember
  • recall
  • read_file
  • search
  • structure
  • git
  • notion

安装

全局安装:

npm install -g @context-sync/server

自动配置在全局安装期间运行。安装后,重新启动AI工具。

如果您在本地而不是全局安装,则auto-config不会运行。使用中的手动配置指南 docs/CONFIG.md.

验证

检查一下 context-sync 出现在您的MCP工具列表中:

  • Claude Desktop:打开工具列表
  • 光标:打开工具列表
  • VS代码/副驾驶聊天代理模式:检查工具
  • Continue.dev:打开继续面板
  • Codex CLI: codex mcp list
  • 克劳德代码: claude mcp list

如果自动配置失败,请使用 docs/TROUBLESHOOTING.md 和 docs/CONFIG.md.

可选概念设置

如果要集成Notion,请运行安装向导:

context-sync-setup

或者:

npx context-sync-setup

Notion支持在工具表面是有意只读的:

  • notion({ action: "search", query: "..." })
  • notion({ action: "read", pageId: "..." })

首次工作流程

首先设置项目,开始每个新会话:

1. set_project({ path: "/absolute/path/to/project" })
2. recall()
3. structure({ depth: 2 })
4. read_file({ path: "src/index.ts" })
5. remember({ type: "decision", content: "Use SQLite for local storage" })

推荐模式:

  • set_project 每个项目/会话开始一次
  • recall 恢复上下文
  • structure 和 search 探索
  • read_file 用于集中检查
  • remember 当某件事应该在当前会议中幸存下来时

Git集成

当你奔跑时 set_project 在git存储库中,Context Sync可以安装钩子以自动捕获上下文。

已安装的挂钩:

  • post-commit
  • pre-push
  • post-merge
  • post-checkout

挂钩上标有 Context Sync Auto-Hook,并且首先备份现有的钩子。

这 git 工具支持:

  • status
  • context
  • hotspots
  • coupling
  • blame
  • analysis

数据和配置

默认位置:

  • 数据库: ~/.context-sync/data.db
  • 配置: ~/.context-sync/config.json
  • 安装状态: ~/.context-sync/install-status.json

自定义数据库选项:

  • CLI: context-sync --db-path /absolute/path/to/db
  • ENV 是 : CONTEXT_SYNC_DB_PATH

看 docs/DATA.md 有关存储详细信息。

支持平台

  • 克劳德桌面版
  • 光标
  • VS代码+GitHub副本
  • Continue.dev
  • 泽德
  • 帆板运动
  • 科迪姆
  • 表九
  • Codex CLI
  • 克劳德代码
  • 反重力

文档