上下文引擎MCP服务器
一个本地优先的、与代理无关的模型上下文协议(MCP)服务器,用于工作区索引、检索、规划和审查工作流,其设置路径适用于Codex和其他OpenAI驱动的代理。
新来的?从下面的初学者快速入门开始。 如果您需要特定于客户端的设置帮助,请参阅 docs/MCP_CLIENT_SETUP.md. 如果您使用的是Windows,请参阅 docs/WINDOWS_DEPLOYMENT_GUIDE.md. 历史文档在 docs/archive/INDEX.md 如果你需要旧的规划和迁移说明。
OpenAI/Codex展示
如果你想看看这个项目为OpenAI风格的代理工作流演示了什么,请从这里开始:
- 本地工作区索引和检索
- 在同一MCP服务器上分层审查和规划工作流程
- 初学者友好的安装和客户端设置
- Windows支持和复制粘贴设置示例
- AI代理友好的自我设置说明
为何这很重要
- 它展示了OpenAI驱动的代理如何连接到真实的工作空间并立即开始使用工具。
- 它将检索、审查和规划结合在一个MCP服务器中,而不是依赖于一次性脚本。
- 它为人类和人工智能代理提供了一个简单、可重复的设置路径,使演示和入职更容易。
最快演示路径:
npm install
npm run build
codex mcp add context-engine -- node dist/index.js然后在Codex中,确认工具可见并尝试:
use semantic_search to find authentication logic初学者快速入门
如果你只想让上下文引擎在本地运行,请按照以下步骤操作:
- 安装 Node.js 18+.
- 克隆此存储库,并在存储库根目录的终端中打开它。
- 安装依赖项:
npm install- 构建服务器:
npm run build- 运行验证检查:
npm run verify- 启动MCP服务器:
node dist/index.js默认情况下,Context Engine现在解析工作区如下:
- 明确的
--workspace胜利 - 否则,它将使用当前文件夹
- 如果从git repo中的嵌套文件夹启动,它会回退到最近的git根目录
- 如果不存在git根目录,它将保留在当前文件夹中并记录警告
在第一次运行时,如果索引丢失或过时,启动程序可以自动启动后台索引。服务器仍然首先启动,但在索引完成之前,第一个查询可能会变慢。
将其连接到您的MCP客户端
服务器通过MCP进行通话 stdio,因此大多数客户端都可以使用相同的命令启动它。
首次设置与日常使用
使用此心理模型:
- 首次设置:
在客户端中注册一次MCP服务器。
- 日常使用:
打开任何仓库,让服务器自动解析工作区。
- 仅在需要时覆盖:
通过 --workspace 如果客户端从错误的文件夹启动,或者你故意想要一个不同的仓库。
Codex CLI
codex mcp add context-engine -- node dist/index.jsWindows示例
codex mcp add context-engine -- node "D:\GitProjects\context-engine\dist\index.js"克劳德代码,克劳德桌面,光标,反重力
看 docs/MCP_CLIENT_SETUP.md 为每个客户端复制粘贴配置示例。
即时可用的示例配置文件 示例/mcp客户端/. 人工智能工作流程的可选技能包 示例/技能/.
如果AI代理正在设置此项
如果您希望代理为您进行设置,请将其粘贴到代理中:
为此工作区设置上下文引擎MCP。 1. 跑npm install和npm run build. 1. 注册MCP服务器一次node dist/index.js. 1. 确认客户端从我正在使用的仓库启动MCP服务器。 1. 如果客户端从错误的文件夹启动,请添加--workspace作为覆盖。 1. 确认服务器出现在客户端中,并且tool_manifest()或者等效的工具列表有效。 1. 例如,运行一个快速检索测试semantic_search,以确认连接是否正常工作。 1. 如果启动程序说工作区未建立索引或已过时,请让后台索引完成或运行index_workspace手动。 如果客户端是Codex CLI,请使用:codex mcp add context-engine -- node dist/index.js
启动行为
当服务器启动时没有 --workspace,它试图感知回购:
- repo根启动:使用该repo
- 嵌套仓库文件夹启动:升级到最近的git根目录
- 非git文件夹启动:停留在当前文件夹并明确警告
如果启用了启动自动索引,则丢失或过时的工作区将自动启动后台索引。
操作员超控:
- 使用禁用启动自动索引
CE_AUTO_INDEX_ON_STARTUP=false - 强制使用特定的工作空间
--workspace "D:\path\to\repo"
建筑
此实现遵循干净的5层架构:
┌────────────────────────────┐
│ Coding Agents (Clients) │ Layer 4: Codex, Claude, Cursor, etc.
│ Codex | Claude | Cursor │
└────────────▲───────────────┘
│ MCP (tools)
┌────────────┴───────────────┐
│ MCP Interface Layer │ Layer 3: server.ts, tools/
│ (standardized tool API) │
└────────────▲───────────────┘
│ internal API
┌────────────┴───────────────┐
│ Context Service Layer │ Layer 2: serviceClient.ts
│ (query orchestration) │
└────────────▲───────────────┘
│ domain calls
┌────────────┴───────────────┐
│ Retrieval + Review Engine │ Layer 1: local-native runtime
│ (indexing, retrieval) │
└────────────▲───────────────┘
│ storage/state
┌────────────┴───────────────┐
│ Local State / Artifacts │ Layer 5: workspace state + evidence
│ (index, cache, receipts) │
└────────────────────────────┘层职责
- 第1层:本地原生索引、检索、审查支持和提供者编排
- 第2层:上下文组装、代码段格式化、重复数据删除、限制和缓存
- 第3层:MCP工具、验证和请求/响应合同
- 第4层:使用工具的编码代理和MCP客户端
- 第5层:持久化索引状态、缓存、卷展收据和生成的工件
特性
MCP工具
服务器公开了这些领域的工具:
- 核心上下文和检索
- 记忆
- 规划和执行
- 计划管理
- 代码审查
- 反应性审查
使用 tool_manifest() 在MCP服务器中直接检查当前工具库存。
关键特性
- 用于索引和检索的本地首次运行时,OpenAI支持的计划/审查工作流分层在其上
- 与代理无关的MCP接口
- 本地本地检索提供程序作为活动运行时
- 瘦
context-engine-mcp发射器,方便使用;它启动同一台服务器,不添加功能 - 用于防部署工作流的持久状态和证据工件
- 服务器内置的规划、审查和验证工作流
- 可选的基准测试、对等和治理门,以实现更安全的更改
快速开始
npm install
npm run build
npm run verify
node dist/index.js可选验证命令:
npm run ci:check:no-legacy-provider
npm run ci:check:legacy-capability-parity
npm run ci:check:legacy-capability-parity:strict文档快速链接
- 文档映射: docs/README.md
- 设置: docs/MCP_CLIENT_SETUP.md
- Windows部署: docs/WINDOWS_DEPLOYMENT_GUIDE.md
- 故障排除: docs/archive/TROUBLESHOOTING.md
- 测试: 文档/档案/测试.md
- 架构: 建筑.md
- 内存操作: docs/MEMORY_OPERATIONS_RUNBOOK.md
- 档案文件: docs/archive/INDEX.md
当前状态
- 检索是本地原生的,有索引支持
- 使用OpenAI会话路径进行规划和审查
- 遗留的提供程序引用是历史文档、测试或迁移护栏
- 当前的强化侧重于快速路径、取消和快速效率,而不是供应商更换
