Local-first, Agent-agnostic Model Context Protocol (MCP) server for workspace indexing, retrieval, Planning, 검토 워크플로우, Codex 및 기타 OpenAI-powered Agent에서 잘 작동하는 설정 경로.

여기에 새로운? 초심자 빠른 시작으로 시작합니다. · 클라이언트 별 설정 도움말을 원한다면 docs/MCP CLIENT SETUP.md를 참조하십시오. · Windows에 있는 경우에, docs/WINDOWS DEPLOYMENT GUIDE.md를 보십시오. · Historical docs는 docs/archive/INDEX.md에서 오래된 계획 및 마이그레이션 노트가 필요한 경우 살고 있습니다.

OpenAI / 코덱 쇼케이스

이 프로젝트가 OpenAI-style 에이전트 워크플로우에 대해 설명하고 싶다면, 여기를 클릭하십시오:

• 로컬 작업 공간 색인 및 retrieval
• 동일한 MCP 서버의 상단에 레이어링 및 계획 워크플로
• Beginner-friendly 설치 및 클라이언트 설정
• Windows 지원 및 copy-paste 설정 예제
• 자체 설치를 위한 AI-agent-friendly 지시

왜 이 매트

• OpenAI-powered 에이전트가 실제 작업 공간에 연결할 수 있는 방법을 보여줍니다.
• 하나의 MCP 서버 대신 Retrieval, review, Planning을 결합합니다.

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