Сервер локального, агентно-агностического протокола контекста модели (MCP) для индексации рабочего пространства, поиска, планирования и обзора рабочих процессов с настройкой, которая хорошо работает для Codex и других агентов с поддержкой OpenAI.

Новый здесь? Начните с быстрого старта ниже.

Если вам нужна помощь в настройке для конкретного клиента, см. docs/MCP CLIENT SETUP.md.

Если вы находитесь в Windows, см. docs/WINDOWS DEPLOYMENT GUIDE.md.

Исторические документы живут в docs/archive/INDEX.md, если вам нужны старые заметки о планировании и миграции.

OpenAI / Codex Showcase

Если вы хотите увидеть, что этот проект демонстрирует для рабочих процессов агентов в стиле OpenAI, начните здесь:

• Местная индексация рабочего пространства и поиск Обзор и планирование рабочих процессов, расположенных поверх того же сервера MCP
• Удобная для начинающих установка и настройка клиента Поддержка Windows и примеры настройки копирования
• Инструкции для ИИ-агента для самонастройки

Почему это важно

Он показывает, как агент с поддержкой OpenAI может подключиться к реальному рабочему пространству и сразу же начать использовать инструменты. Он сочетает в себе поиск, обзор и планирование на одном MCP-сервере вместо того, чтобы полагаться на одноразовые скрипты.

Context Engine MCP Server

A local-first, agent-agnostic Model Context Protocol (MCP) server for workspace indexing, retrieval, planning, and review workflows, with a setup path that works well for Codex and other OpenAI-powered agents.

New here? Start with the beginner quick start below.

If you want client-specific setup help, see docs/MCP_CLIENT_SETUP.md.

If you are on Windows, see docs/WINDOWS_DEPLOYMENT_GUIDE.md.

Historical docs live in docs/archive/INDEX.md if you need the old planning and migration notes.

OpenAI / Codex Showcase

If you want to see what this project demonstrates for OpenAI-style agent workflows, start here:

• Local workspace indexing and retrieval
• Review and planning workflows layered on top of the same MCP server
• Beginner-friendly install and client setup
• Windows support and copy-paste setup examples
• AI-agent-friendly instructions for self-setup

Why This Matters

• It shows how an OpenAI-powered agent can connect to a real workspace and start using tools right away.
• It combines retrieval, review, and planning in one MCP server instead of relying on one-off scripts.
• It gives both humans and AI agents a simple, repeatable setup path, which makes demos and onboarding easier.

Fastest demo path:

npm install
npm run build
codex mcp add context-engine -- node dist/index.js

Then in Codex, confirm the tools are visible and try:

use semantic_search to find authentication logic

Beginner Quick Start

If you just want to get Context Engine running locally, follow these steps:

1. Install Node.js 18+.
2. Clone this repository and open it in a terminal at the repo root.
3. Install dependencies:

npm install

4. Build the server:

npm run build

5. Run the verification checks:

npm run verify

6. Start the MCP server:

node dist/index.js

By default, Context Engine now resolves the workspace like this:

• explicit --workspace wins
• otherwise it uses the current folder
• if you launched from a nested folder inside a git repo, it falls back to the nearest git root
• if no git root exists, it stays on the current folder and logs a warning

On first run, if the index is missing or stale, startup can kick off background indexing automatically. The server still starts first, but the first query may be slower until indexing finishes.

Connect It To Your MCP Client

The server speaks MCP over stdio, so most clients can launch it with the same command.

First-Time Setup vs Daily Use

Use this mental model:

1. First-time setup: Register the MCP server once in your client.
2. Daily use: Open any repo and let the server resolve the workspace automatically.
3. Override only when needed: Pass --workspace if the client launches from the wrong folder or you want a different repo on purpose.

Codex CLI