mirror of
https://github.com/DeusData/codebase-memory-mcp.git
synced 2026-11-04 10:48:20 +00:00
Fix clang-format in merged PR #79 + update CONTRIBUTING.md
- Fix formatting in mcp.c protocol version negotiation (from PR #79 merge) - Rewrite CONTRIBUTING.md for pure C project (was still describing Go, causing contributors to submit Go PRs that can't be merged)
This commit is contained in:
Martin Vogel committed
1 parent
92275ffa95
commit
de427776c0
2 files changed
+63
-34
No files matched your search
+62
-32
@@ -2,76 +2,106 @@
|
||||
|
||||
Contributions are welcome. This guide covers setup, testing, and PR guidelines.
|
||||
|
||||
> **Important**: This project is a **pure C binary** (rewritten from Go in v0.5.0). Please submit C code, not Go. Go PRs may be ported but cannot be merged directly.
|
||||
|
||||
## Build from Source
|
||||
|
||||
**Prerequisites**: Go 1.26+, a C compiler (gcc or clang — needed for tree-sitter CGO bindings), Git.
|
||||
**Prerequisites**: C compiler (gcc or clang), make, zlib, Git. Optional: Node.js 22+ (for graph UI).
|
||||
|
||||
```bash
|
||||
git clone https://github.com/DeusData/codebase-memory-mcp.git
|
||||
cd codebase-memory-mcp
|
||||
CGO_ENABLED=1 go build -o codebase-memory-mcp ./cmd/codebase-memory-mcp/
|
||||
scripts/build.sh
|
||||
```
|
||||
|
||||
macOS: `xcode-select --install` provides clang.
|
||||
Linux: `sudo apt install build-essential` (Debian/Ubuntu) or `sudo dnf install gcc` (Fedora).
|
||||
Linux: `sudo apt install build-essential zlib1g-dev` (Debian/Ubuntu) or `sudo dnf install gcc zlib-devel` (Fedora).
|
||||
|
||||
The binary is output to `build/c/codebase-memory-mcp`.
|
||||
|
||||
## Run Tests
|
||||
|
||||
```bash
|
||||
go test ./... -count=1
|
||||
scripts/test.sh
|
||||
```
|
||||
|
||||
Key test files:
|
||||
- `internal/pipeline/langparity_test.go` — 125+ language parity cases
|
||||
- `internal/pipeline/astdump_test.go` — 90+ AST structure cases
|
||||
- `internal/pipeline/pipeline_test.go` — integration tests
|
||||
This builds with ASan + UBSan and runs all tests (~2040 cases). Key test files:
|
||||
- `tests/test_pipeline.c` — pipeline integration tests
|
||||
- `tests/test_httplink.c` — HTTP route extraction and linking
|
||||
- `tests/test_mcp.c` — MCP protocol and tool handler tests
|
||||
- `tests/test_store_*.c` — SQLite graph store tests
|
||||
|
||||
## Run Linter
|
||||
|
||||
```bash
|
||||
golangci-lint run ./...
|
||||
scripts/lint.sh
|
||||
```
|
||||
|
||||
Runs clang-tidy, cppcheck, and clang-format. All must pass before committing (also enforced by pre-commit hook).
|
||||
|
||||
## Run Security Audit
|
||||
|
||||
```bash
|
||||
make -f Makefile.cbm security
|
||||
```
|
||||
|
||||
Runs 8 security layers: static allow-list audit, binary string scan, UI audit, install audit, network egress test, MCP robustness (fuzz), vendored dependency integrity, and frontend integrity.
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
cmd/codebase-memory-mcp/ Entry point (MCP server + CLI + install/update)
|
||||
internal/
|
||||
lang/ Language specs (63 languages, tree-sitter node types)
|
||||
parser/ Tree-sitter grammar loading
|
||||
pipeline/ Multi-pass indexing pipeline
|
||||
httplink/ Cross-service HTTP route matching
|
||||
cypher/ Cypher query engine
|
||||
store/ SQLite graph storage
|
||||
tools/ MCP tool handlers (12 tools)
|
||||
watcher/ Background auto-sync
|
||||
discover/ File discovery with .cgrignore
|
||||
fqn/ Qualified name computation
|
||||
src/
|
||||
foundation/ Arena allocator, hash table, string utils, platform compat
|
||||
store/ SQLite graph storage (WAL mode, FTS5)
|
||||
cypher/ Cypher query → SQL translation
|
||||
mcp/ MCP server (JSON-RPC 2.0 over stdio, 14 tools)
|
||||
pipeline/ Multi-pass indexing pipeline
|
||||
pass_*.c Individual pipeline passes (definitions, calls, usages, etc.)
|
||||
httplink.c HTTP route extraction (Go/Express/Laravel/Ktor/Python)
|
||||
discover/ File discovery with gitignore support
|
||||
watcher/ Git-based background auto-sync
|
||||
cli/ CLI subcommands (install, update, uninstall, config)
|
||||
ui/ Graph visualization HTTP server (mongoose)
|
||||
internal/cbm/ Tree-sitter AST extraction (64 languages, vendored C grammars)
|
||||
vendored/ sqlite3, yyjson, mongoose, mimalloc, xxhash, tre
|
||||
graph-ui/ React/Three.js frontend for graph visualization
|
||||
scripts/ Build, test, lint, security audit scripts
|
||||
tests/ All C test files
|
||||
```
|
||||
|
||||
## Adding or Fixing Language Support
|
||||
|
||||
Most language issues are in `internal/lang/<name>.go` (node type configuration) or `internal/pipeline/` (extraction logic).
|
||||
Language support is split between two layers:
|
||||
|
||||
1. **Tree-sitter extraction** (`internal/cbm/`): Grammar loading, AST node type configuration in `lang_specs.c`, function/call/import extraction in `extract_*.c`
|
||||
2. **Pipeline passes** (`src/pipeline/`): Call resolution, usage tracking, HTTP route linking
|
||||
|
||||
**Workflow for language fixes:**
|
||||
|
||||
1. Find the relevant language spec in `internal/lang/`
|
||||
2. Use AST dump tests to see actual tree-sitter node types:
|
||||
```bash
|
||||
go test ./internal/pipeline/ -run TestASTDump -v
|
||||
```
|
||||
3. Compare configured node types vs actual AST output
|
||||
4. Update the language spec and add/fix parity test cases
|
||||
5. Verify with a real open-source repo (see `BENCHMARK_REPORT.md` for test repos per language)
|
||||
1. Check the language spec in `internal/cbm/lang_specs.c`
|
||||
2. Use regression tests to verify extraction: `tests/test_extraction.c`
|
||||
3. Check parity tests: `internal/cbm/regression_test.go` (legacy, being migrated)
|
||||
4. Add a test case in `tests/test_pipeline.c` for integration-level fixes
|
||||
5. Verify with a real open-source repo
|
||||
|
||||
## Pull Request Guidelines
|
||||
|
||||
- One logical change per PR
|
||||
- **C code only** — this project was rewritten from Go to pure C in v0.5.0. Go PRs will be acknowledged and potentially ported, but cannot be merged directly.
|
||||
- One logical change per PR — don't bundle unrelated features
|
||||
- Include tests for new functionality
|
||||
- Run `go test ./... -count=1` and `golangci-lint run` before submitting
|
||||
- Run `scripts/test.sh` and `scripts/lint.sh` before submitting
|
||||
- Keep PRs focused — avoid unrelated reformatting or refactoring
|
||||
- Reference the issue number in your PR description
|
||||
|
||||
## Security
|
||||
|
||||
We take security seriously. All PRs go through:
|
||||
- Manual security review (dangerous calls, network access, file writes, prompt injection)
|
||||
- Automated 8-layer security audit in CI
|
||||
- Vendored dependency integrity checks
|
||||
|
||||
If you add a new `system()`, `popen()`, `fork()`, or network call, it must be justified and added to `scripts/security-allowlist.txt`.
|
||||
|
||||
## Good First Issues
|
||||
|
||||
Check [issues labeled `good first issue`](https://github.com/DeusData/codebase-memory-mcp/labels/good%20first%20issue) for beginner-friendly tasks with clear scope and guidance.
|
||||
|
||||
+1
-2
@@ -361,8 +361,7 @@ char *cbm_mcp_initialize_response(const char *params_json) {
|
||||
if (params_json) {
|
||||
yyjson_doc *pdoc = yyjson_read(params_json, strlen(params_json), 0);
|
||||
if (pdoc) {
|
||||
yyjson_val *pv =
|
||||
yyjson_obj_get(yyjson_doc_get_root(pdoc), "protocolVersion");
|
||||
yyjson_val *pv = yyjson_obj_get(yyjson_doc_get_root(pdoc), "protocolVersion");
|
||||
if (pv && yyjson_is_str(pv)) {
|
||||
const char *requested = yyjson_get_str(pv);
|
||||
for (int i = 0; i < SUPPORTED_VERSION_COUNT; i++) {
|
||||
|
||||
Reference in new issue
Block a user