Skip to content

Commit 3d66fbc

Browse files
committed
README: Add MCP bridge CLI and install docs
Expand README with recommended plugin install commands for Claude/Codex and Windsurf, plus a new "CLI Setup (No VS Code)" section describing the MCP bridge: installation, quick start, daemon management, connect flags, and how to wire up the MCP server (stdio/HTTP). Also update Getting Started to include CLI connection option and clarify skill installation. Minor formatting and copy tweaks to streamline installation guidance.
1 parent 7f3f02c commit 3d66fbc

1 file changed

Lines changed: 85 additions & 37 deletions

File tree

README.md

Lines changed: 85 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -14,45 +14,28 @@
1414

1515
---
1616

17-
## A Note to Our Community
18-
19-
We owe you an honest explanation.
20-
21-
Context Engine was originally open source. We built it in the open because we believed in the community and wanted developers everywhere to benefit from better code search.
22-
23-
Unfortunately, we've seen our work consistently monetized and cloned by others without attribution — entire products built on top of our code and sold commercially. After careful consideration, we've made the difficult decision to remove the source code from this repository.
24-
25-
**We're sorry.** We know this is frustrating, especially for those who contributed, starred, or relied on the public codebase. This wasn't the outcome we wanted, and we take full responsibility for not protecting the project sooner.
26-
27-
**What's still here:**
28-
- AI agent skills for all major coding assistants (see below)
29-
- The Context Engine marketing site ([context-engine.ai](https://context-engine.ai))
30-
- License, legal notices, and attribution files
31-
32-
**What's available through the platform:**
33-
- Full hosted service at [context-engine.ai](https://context-engine.ai)
34-
- VS Code extension on the marketplace
35-
- `ctx-mcp-bridge` on npm
36-
37-
We remain committed to building the best code intelligence tools for developers. If you have questions, reach out at **john@context-engine.ai**.
38-
39-
---
40-
4117
## Install Skills
4218

4319
Context Engine ships AI agent skills that teach your coding assistant how to use 30+ MCP tools for semantic search, symbol graph navigation, memory, and more.
4420

4521
### Claude Code / Claude Desktop
4622

47-
The skill is auto-loaded when you connect Context Engine as an MCP server. No manual installation needed.
23+
**Recommended:** Install natively from the public GitHub repo:
24+
25+
```bash
26+
# Add the marketplace (one-time)
27+
/plugin marketplace add Context-Engine-AI/Context-Engine
28+
29+
# Install the skill
30+
/plugin install context-engine
31+
```
32+
33+
This pulls the skill directly from GitHub and auto-loads MCP tool guidance into your session.
4834

49-
If you want to add the rules file manually:
35+
Alternatively, copy the rules file manually:
5036

5137
```bash
52-
# Copy the skill to your project
5338
cp -r skills/context-engine/ your-project/.claude/
54-
55-
# Or reference GEMINI.md / .cursorrules directly — they contain the same rules
5639
```
5740

5841
### Cursor
@@ -64,14 +47,24 @@ Context Engine rules are included in `.cursorrules` at the root of your workspac
6447
cp .cursorrules your-project/.cursorrules
6548
```
6649

67-
### Windsurf / Codex
50+
### Codex (OpenAI)
51+
52+
**Recommended:** Install natively using the built-in skill installer — just ask Codex:
53+
54+
> "Install the context-engine skill from https://github.com/Context-Engine-AI/Context-Engine"
55+
56+
Codex will pull `.codex/skills/context-engine/` (including `SKILL.md` and reference docs) into `~/.codex/skills/` automatically.
57+
58+
Or install manually:
6859

6960
```bash
70-
# Codex skills
71-
cp -r .codex/skills/ your-project/.codex/skills/
61+
cp -r .codex/skills/context-engine/ ~/.codex/skills/context-engine/
62+
```
63+
64+
### Windsurf
7265

73-
# Or use the generic skill file
74-
cp skills/context-engine/SKILL.md your-project/.context-engine-skill.md
66+
```bash
67+
cp -r .codex/skills/ your-project/.codex/skills/
7568
```
7669

7770
### Augment Code
@@ -98,6 +91,59 @@ Then tell your assistant: *"Read SKILL.md for instructions on using Context Engi
9891

9992
---
10093

94+
## CLI Setup (No VS Code)
95+
96+
If you use Claude Code, Codex, or another terminal-based MCP client, install the **MCP bridge** to connect your codebase to Context Engine without VS Code:
97+
98+
```bash
99+
npm install -g @context-engine-bridge/context-engine-mcp-bridge
100+
```
101+
102+
### Quick start
103+
104+
```bash
105+
# Authenticate, index your codebase, and start watching for changes
106+
ctxce connect <your-api-key> --workspace /path/to/repo
107+
108+
# Run as a background daemon (recommended)
109+
ctxce connect <your-api-key> --workspace /path/to/repo --daemon
110+
```
111+
112+
### Daemon management
113+
114+
```bash
115+
ctxce status # Check if the daemon is running
116+
ctxce stop # Stop the background daemon
117+
```
118+
119+
### Connect flags
120+
121+
| Flag | Alias | Description |
122+
|------|-------|-------------|
123+
| `--workspace <path>` | `-w` | Workspace root (default: cwd) |
124+
| `--daemon` | `-d`, `--bg` | Run as background daemon |
125+
| `--interval <sec>` | | File watch interval in seconds (default: 30) |
126+
| `--no-watch` | `--once` | Index once, don't watch for changes |
127+
| `--skip-index` | `--auth-only` | Authenticate only, skip initial index |
128+
129+
### Wire up the MCP server
130+
131+
Once connected, point your MCP client at the bridge:
132+
133+
```bash
134+
# stdio mode (for Claude Code, Codex, etc.)
135+
ctxce mcp-serve --workspace /path/to/repo
136+
137+
# HTTP mode (for clients that speak HTTP)
138+
ctxce mcp-http-serve --workspace /path/to/repo --port 30810
139+
```
140+
141+
The daemon and MCP server share auth via `~/.ctxce/auth.json`. Logs are at `~/.context-engine/daemon.log`.
142+
143+
For full bridge documentation, see [Context-Engine-MCP-Bridge](https://github.com/Context-Engine-AI/Context-Engine-MCP-Bridge).
144+
145+
---
146+
101147
## What Do the Skills Do?
102148

103149
The skills teach your AI assistant to:
@@ -117,9 +163,11 @@ See [`skills/context-engine/SKILL.md`](skills/context-engine/SKILL.md) for the c
117163
## Getting Started
118164

119165
1. **Sign up** at [context-engine.ai](https://context-engine.ai)
120-
2. **Install the VS Code extension** — search "Context Engine" in the marketplace
121-
3. **Upload your codebase** — the extension handles indexing automatically
122-
4. **Start searching** — your AI assistant now has access to all 30+ MCP tools
166+
2. **Connect your codebase** — choose one:
167+
- **VS Code** — install the [Context Engine Uploader](https://marketplace.visualstudio.com/items?itemName=context-engine.context-engine-uploader) extension
168+
- **CLI**`npm i -g @context-engine-bridge/context-engine-mcp-bridge && ctxce connect <api-key> --daemon`
169+
3. **Install the skill** for your AI assistant (see [Install Skills](#install-skills) above)
170+
4. **Start searching** — your assistant now has access to all 30+ MCP tools
123171

124172
---
125173

0 commit comments

Comments
 (0)