Skip to content

Commit 5b27296

Browse files
committed
docs: add README with skills installation guide and source removal notice
1 parent 3d58cf6 commit 5b27296

File tree

1 file changed

+130
-0
lines changed

1 file changed

+130
-0
lines changed

README.md

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
<p align="center">
2+
<img src="static/logo.svg" width="80" alt="Context Engine" />
3+
</p>
4+
5+
<h1 align="center">Context Engine</h1>
6+
7+
<p align="center">
8+
<strong>Semantic code search, memory, and symbol intelligence for AI coding assistants.</strong>
9+
</p>
10+
11+
<p align="center">
12+
<a href="https://context-engine.ai">Website</a> · <a href="https://context-engine.ai">Get Started</a> · <a href="LICENSE">License</a>
13+
</p>
14+
15+
---
16+
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+
41+
## Install Skills
42+
43+
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.
44+
45+
### Claude Code / Claude Desktop
46+
47+
The skill is auto-loaded when you connect Context Engine as an MCP server. No manual installation needed.
48+
49+
If you want to add the rules file manually:
50+
51+
```bash
52+
# Copy the skill to your project
53+
cp -r skills/context-engine/ your-project/.claude/
54+
55+
# Or reference GEMINI.md / .cursorrules directly — they contain the same rules
56+
```
57+
58+
### Cursor
59+
60+
Context Engine rules are included in `.cursorrules` at the root of your workspace. Cursor picks this up automatically when the file is present.
61+
62+
```bash
63+
# Copy to your project root
64+
cp .cursorrules your-project/.cursorrules
65+
```
66+
67+
### Windsurf / Codex
68+
69+
```bash
70+
# Codex skills
71+
cp -r .codex/skills/ your-project/.codex/skills/
72+
73+
# Or use the generic skill file
74+
cp skills/context-engine/SKILL.md your-project/.context-engine-skill.md
75+
```
76+
77+
### Augment Code
78+
79+
```bash
80+
cp -r .augment/ your-project/.augment/
81+
```
82+
83+
### Gemini
84+
85+
```bash
86+
cp GEMINI.md your-project/GEMINI.md
87+
```
88+
89+
### Any Other Assistant
90+
91+
The core skill file works with any AI assistant that supports custom instructions:
92+
93+
```bash
94+
cp skills/context-engine/SKILL.md your-project/
95+
```
96+
97+
Then tell your assistant: *"Read SKILL.md for instructions on using Context Engine MCP tools."*
98+
99+
---
100+
101+
## What Do the Skills Do?
102+
103+
The skills teach your AI assistant to:
104+
105+
- **Use `search` as the default tool** — auto-routes queries to the best backend (semantic search, Q&A, symbol graph, tests, config)
106+
- **Navigate code with `symbol_graph`** — find callers, callees, definitions, importers, subclasses
107+
- **Run batch queries**`batch_search`, `batch_symbol_graph`, `batch_graph_query` for 75%+ token savings
108+
- **Store and recall knowledge**`memory_store` and `memory_find` for persistent context across sessions
109+
- **Trace cross-repo flows**`cross_repo_search` with boundary tracing for multi-repo codebases
110+
- **Find structural patterns**`pattern_search` for retry loops, error handling, singletons across languages
111+
- **Search git history**`search_commits_for` and `change_history_for_path`
112+
113+
See [`skills/context-engine/SKILL.md`](skills/context-engine/SKILL.md) for the complete tool reference.
114+
115+
---
116+
117+
## Getting Started
118+
119+
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
123+
124+
---
125+
126+
## License
127+
128+
[Context-Engine Source Available License 1.0](LICENSE)
129+
130+
© 2025 Context Engine Inc. and John Donalson.

0 commit comments

Comments
 (0)