使用说明
- 项目简介
- Context Engine MCP 服务器是一个完整的后端实现,按 Model Context Protocol (MCP) 构建,核心职责包括:托管和管理 Resources(资源)、注册与执行 Tools(工具)、定义和渲染 Prompt Templates(提示模板),并通过 JSON-RPC 与 MCP 客户端通信,支持多种传输模式(StdIO、HTTP、WebSocket 等),提供会话管理、能力声明与安全、可扩展的上下文服务框架。
- 主要功能点
- MCP 接口层:实现标准化的工具暴露、I/O 校验、I/O 映射,提供对客户端的统一访问入口。
- 服务层:协调上下文服务、格式化片段、去重、限制处理、上下文打包与缓存策略。
- 核心引擎(Auggie SDK):处理工作区的向量索引、检索、代码上下文抽取等。
- 工具集合:38+ 积木工具用于代码检索、获取文件、获取上下文、增强 Prompt、计划/执行等,支持扩展。
- 计划与执行:提供计划的创建、保存、执行、可视化、历史对比、回滚等能力。
- 内部缓存与并行执行:多层缓存(内存/提交/文件哈希)与并行执行优化,提升大规模 PR 的处理效率。
- 离线策略与本地化:本地-first、无云依赖,强烈支持企业化本地部署。
- 安装步骤
-
- 安装 Node.js 18+。
-
- 下载并进入项目根目录。
-
- 安装依赖:npm install。
-
- 构建产物:npm run build。
-
- 启动服务器(两种模式任选):
- 仅标准 MCP(StdIO)模式:node dist/index.js --workspace /path/to/your/project
- 同时开启 HTTP API 模式(便于 VSCode 插件等客户端):node dist/index.js --workspace /path/to/your/project --http
- 如需仅 HTTP 模式或结合 Codex/其他 MCP 客户端,请参考 README 中的快速启动与配置。
-
- 运行完成后,若希望使用 Codex CLI 将服务器注册为 MCP 服务,请参考 QUICKSTART 文档中的注册步骤。
-
- 服务器配置(供 MCP 客户端连接使用)
说明:MCP 客户端需要知道如何启动服务器(命令和参数)来连接 MCP 服务。以下为配置示例(以 JSON 形式给出,并附注释说明)。请将占位值替换为实际路径与工作区信息,客户端无需此示例中的注释。
{
"serverName": "context-engine",
"command": "node",
"args": [
"/absolute/path/to/context-engine/dist/index.js",
"--workspace",
"/path/to/your/project"
],
"description": "Context Engine MCP 服务器实例(用于 MCP 客户端连接)"
}
说明与注释:
- serverName: MCP 服务器的名称,客户端在配置中以该名称区分不同的 MCP 服务。
- command: 启动服务器所使用的命令,通常为 node。
- args: 启动命令的参数,包含服务器入口脚本路径以及必要的工作区参数,例如 --workspace。
- 以上配置仅供 MCP 客户端在连接时使用,实际部署时请确保路径准确并指向已构建的 dist/index.js。
- 基本使用方法
- 连接与交互
- 将 MCP 客户端(如 Codex CLI、Claude Desktop、Cursor 等)配置为连接此 MCP 服务器。客户端通过 JSON-RPC 交互,请求包括读取资源、调用工具、获取 Prompt 等,服务器返回 JSON-RPC 响应或发送通知。
- 会话与能力
- 服务器会维护会话、能力声明及资源上下文,支持多客户端并发访问,确保上下文数据本地化、可控和可扩展。
- 安全与离线策略
- 支持离线模式、内置的缓存策略、以及本地化的上下文引擎,确保本地数据不会泄漏到云端。
- 集成扩展
- 与 Auggie SDK 的对接使得可以扩展新的工具、提示模板以及 Plan/Execution 模块,便于后续功能扩展。
- 连接与交互
信息
分类
AI与计算