Repository navigation
Expand file tree
/
Copy pathREADME.html
More file actions
1326 lines (1322 loc) · 72.3 KB
/
Copy pathREADME.html
File metadata and controls
1326 lines (1322 loc) · 72.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>cpp-semantic-graph</title>
<style>
html {
color: #1a1a1a;
background-color: #fdfdfd;
}
body {
margin: 0 auto;
max-width: 36em;
padding-left: 50px;
padding-right: 50px;
padding-top: 50px;
padding-bottom: 50px;
hyphens: auto;
overflow-wrap: break-word;
text-rendering: optimizeLegibility;
font-kerning: normal;
}
@media (max-width: 600px) {
body {
font-size: 0.9em;
padding: 12px;
}
h1 {
font-size: 1.8em;
}
}
@media print {
html {
background-color: white;
}
body {
background-color: transparent;
color: black;
font-size: 12pt;
}
p, h2, h3 {
orphans: 3;
widows: 3;
}
h2, h3, h4 {
page-break-after: avoid;
}
}
p {
margin: 1em 0;
}
a {
color: #1a1a1a;
}
a:visited {
color: #1a1a1a;
}
img {
max-width: 100%;
}
h1, h2, h3, h4, h5, h6 {
margin-top: 1.4em;
}
h5, h6 {
font-size: 1em;
font-style: italic;
}
h6 {
font-weight: normal;
}
ol, ul {
padding-left: 1.7em;
margin-top: 1em;
}
li > ol, li > ul {
margin-top: 0;
}
blockquote {
margin: 1em 0 1em 1.7em;
padding-left: 1em;
border-left: 2px solid #e6e6e6;
color: #606060;
}
code {
font-family: Menlo, Monaco, Consolas, 'Lucida Console', monospace;
font-size: 85%;
margin: 0;
hyphens: manual;
}
pre {
margin: 1em 0;
overflow: auto;
}
pre code {
padding: 0;
overflow: visible;
overflow-wrap: normal;
}
.sourceCode {
background-color: transparent;
overflow: visible;
}
hr {
background-color: #1a1a1a;
border: none;
height: 1px;
margin: 1em 0;
}
table {
margin: 1em 0;
border-collapse: collapse;
width: 100%;
overflow-x: auto;
display: block;
font-variant-numeric: lining-nums tabular-nums;
}
table caption {
margin-bottom: 0.75em;
}
tbody {
margin-top: 0.5em;
border-top: 1px solid #1a1a1a;
border-bottom: 1px solid #1a1a1a;
}
th {
border-top: 1px solid #1a1a1a;
padding: 0.25em 0.5em 0.25em 0.5em;
}
td {
padding: 0.125em 0.5em 0.25em 0.5em;
}
header {
margin-bottom: 4em;
text-align: center;
}
#TOC li {
list-style: none;
}
#TOC ul {
padding-left: 1.3em;
}
#TOC > ul {
padding-left: 0;
}
#TOC a:not(:hover) {
text-decoration: none;
}
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: min(4vw, 1.5em);}
div.column{flex: auto; overflow-x: auto;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
/* The extra [class] is a hack that increases specificity enough to
override a similar rule in reveal.js */
ul.task-list[class]{list-style: none;}
ul.task-list li input[type="checkbox"] {
font-size: inherit;
width: 0.8em;
margin: 0 0.8em 0.2em -1.6em;
vertical-align: middle;
}
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
/* CSS for syntax highlighting */
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
}
pre.numberSource code
{ counter-reset: source-line 0; }
pre.numberSource code > span
{ position: relative; left: -4em; counter-increment: source-line; }
pre.numberSource code > span > a:first-child::before
{ content: counter(source-line);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
color: #aaaaaa;
}
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
div.sourceCode
{ }
@media screen {
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
}
code span.al { color: #ff0000; font-weight: bold; } /* Alert */
code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code span.at { color: #7d9029; } /* Attribute */
code span.bn { color: #40a070; } /* BaseN */
code span.bu { color: #008000; } /* BuiltIn */
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code span.ch { color: #4070a0; } /* Char */
code span.cn { color: #880000; } /* Constant */
code span.co { color: #60a0b0; font-style: italic; } /* Comment */
code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code span.do { color: #ba2121; font-style: italic; } /* Documentation */
code span.dt { color: #902000; } /* DataType */
code span.dv { color: #40a070; } /* DecVal */
code span.er { color: #ff0000; font-weight: bold; } /* Error */
code span.ex { } /* Extension */
code span.fl { color: #40a070; } /* Float */
code span.fu { color: #06287e; } /* Function */
code span.im { color: #008000; font-weight: bold; } /* Import */
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
code span.kw { color: #007020; font-weight: bold; } /* Keyword */
code span.op { color: #666666; } /* Operator */
code span.ot { color: #007020; } /* Other */
code span.pp { color: #bc7a00; } /* Preprocessor */
code span.sc { color: #4070a0; } /* SpecialChar */
code span.ss { color: #bb6688; } /* SpecialString */
code span.st { color: #4070a0; } /* String */
code span.va { color: #19177c; } /* Variable */
code span.vs { color: #4070a0; } /* VerbatimString */
code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
</style>
</head>
<body>
<header id="title-block-header">
<h1 class="title">cpp-semantic-graph</h1>
</header>
<h1 id="cpp-semantic-graph">cpp-semantic-graph</h1>
<blockquote>
<p>A C++ semantic knowledge graph — let AI understand your C++ codebase
precisely</p>
</blockquote>
<p><a href="README_zh.md">中文文档</a></p>
<p>Builds a semantic knowledge graph of a C++ codebase for AI coding
assistants (Claude Code, Cursor, Windsurf, etc.) and exposes it through
9 query tools over the <a href="https://modelcontextprotocol.io/">MCP
protocol</a>. The AI can then search class definitions, look up
inheritance, trace call chains, and analyze the blast radius of a change
— no file hopping, no grep.</p>
<h2 id="why-this-project-exists-clang-not-tree-sitter">Why this project
exists: clang, not tree-sitter</h2>
<p>Most general-purpose code-graph tooling parses source with
<strong>tree-sitter</strong> — a fast, incremental
<strong>syntax</strong> parser. That choice is fine for many languages,
but it is the wrong tool for a <strong>C++ semantic</strong> graph.</p>
<p><strong>The distinction is syntax vs. semantics:</strong></p>
<ul>
<li>A <strong>syntax parser</strong> answers <em>“do these tokens form a
valid C++ program, and what does the tree look like?”</em> — it does
<strong>not</strong> resolve what a name refers to.</li>
<li><strong>Semantic analysis</strong> (what a compiler front-end does)
answers <em>“which entity does this symbol denote, what is its type, and
how does it relate to others?”</em> — this requires <strong>type
resolution and name lookup</strong>.</li>
</ul>
<p>C++ is a language where a great deal of information lives <strong>in
the type system, not on the page</strong>. Consider:</p>
<div class="sourceCode" id="cb1"><pre
class="sourceCode cpp"><code class="sourceCode cpp"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="kw">namespace</span> nv <span class="op">{</span></span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="kw">struct</span> Base <span class="op">{</span> <span class="kw">virtual</span> <span class="dt">void</span> PerformUpdate<span class="op">()</span> <span class="op">=</span> <span class="dv">0</span><span class="op">;</span> <span class="op">};</span></span>
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="kw">template</span><span class="op"><</span><span class="kw">typename</span> T<span class="op">></span> <span class="kw">struct</span> Middle <span class="op">:</span> <span class="kw">virtual</span> Base <span class="op">{</span> <span class="co">// virtual inheritance + template</span></span>
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">void</span> PerformUpdate<span class="op">()</span> <span class="kw">override</span> <span class="op">{}</span></span>
<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a><span class="op">};</span></span>
<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a><span class="kw">struct</span> ChipUpdate <span class="op">:</span> Middle<span class="op"><</span>SoC<span class="op">>,</span> NonCopyable<span class="op">,</span> <span class="kw">public</span> Logger <span class="op">{};</span> <span class="co">// multiple inheritance</span></span>
<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>A syntax parser (tree-sitter) can see that <code>ChipUpdate</code> is
a class followed by three base-specifier text fragments. It
<strong>cannot</strong> determine:</p>
<ul>
<li>That <code>Middle<SoC></code> is the specialization
<code>nv::Middle<SoC></code> — requires <strong>template
instantiation</strong>.</li>
<li>Which namespace <code>Logger</code> lives in — requires <strong>name
lookup</strong>.</li>
<li>That the root of the chain is <code>virtual Base</code> — requires
<strong>expanding the template and following the referenced
declaration</strong>.</li>
<li>Which base-class method <code>PerformUpdate() override</code>
actually overrides — requires <strong>cross-class virtual-function
matching</strong>.</li>
</ul>
<p>These all require type resolution, which is exactly what a compiler
front-end (clang) provides and what a syntax parser structurally cannot.
This is not tree-sitter being “bad” — it is intentionally type-free,
single-file, and fast, designed for syntax highlighting and code
folding. Using it to build a C++ <em>semantic</em> graph is simply the
wrong tool for the job.</p>
<p><strong>This project uses clang/libclang’s semantic AST
instead.</strong> The difference is visible in the parser:</p>
<ul>
<li><code>base_spec.referenced</code> — resolves a base class to its
<strong>real declaration cursor</strong> across files and namespaces
(<code>parser/ast_visitor.py</code>).</li>
<li><code>clang_isVirtualBase</code> — detects <strong>virtual
inheritance</strong>, the C++-specific diamond-inheritance semantics
that syntax trees have no notion of.</li>
<li><code>cursor.is_virtual_method()</code> /
<code>is_pure_virtual_method()</code> — virtual-function semantics.</li>
<li><code>access_specifier</code> — distinguishes
public/protected/private inheritance.</li>
<li>Cross-TU override matching — base and derived classes often live in
different files; clang’s <code>referenced</code> cursor links them,
which a per-file syntax parse cannot.</li>
</ul>
<h2 id="why-do-you-need-it">Why do you need it?</h2>
<p>Common pain points when an AI assistant tries to understand C++
code:</p>
<table>
<colgroup>
<col style="width: 28%" />
<col style="width: 71%" />
</colgroup>
<thead>
<tr class="header">
<th>Pain point</th>
<th>cpp-semantic-graph’s answer</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>“Where is this class defined?”</td>
<td><code>cpp_search_class("FirmwareUpdate")</code> → namespace + file
location</td>
</tr>
<tr class="even">
<td>“Who calls this function?”</td>
<td><code>cpp_get_callers("QueryBootChain")</code> → all callers</td>
</tr>
<tr class="odd">
<td>“What does changing this header affect?”</td>
<td>Incremental update recursively walks include deps, re-parses only
affected TUs</td>
</tr>
<tr class="even">
<td>“Which overrides exist for this virtual?”</td>
<td><code>cpp_get_overrides("PerformUpdate", "DeviceAdapter")</code> →
all implementations</td>
</tr>
<tr class="odd">
<td>“What does this module’s architecture look like?”</td>
<td><code>cpp_traverse_graph("FirmwareUpdate")</code> → multi-hop
traversal</td>
</tr>
</tbody>
</table>
<h2 id="core-features">✨ Core features</h2>
<ul>
<li><strong>9 MCP tools</strong>: class search, function search,
inheritance, call chains (caller/callee), overrides, file symbols,
multi-hop traversal, doc search</li>
<li><strong>Incremental updates</strong>: based on the
include-dependency graph, a single <code>.cpp</code> change refreshes in
seconds (16× faster than a full rebuild)</li>
<li><strong>Doc fusion</strong>: bidirectional linking between project
docs and code; searching docs auto-locates related code</li>
<li><strong>Plug-and-play</strong>: one YAML config +
<code>compile_commands.json</code> to start; the MCP server
auto-registers with AI tools</li>
<li><strong>Project-agnostic</strong>: no project-specific hardcoding in
the schema or tool definitions — portable to any C++ project</li>
</ul>
<h2 id="quick-start">🚀 Quick start</h2>
<h3 id="prerequisites">Prerequisites</h3>
<ul>
<li>Python 3.10+</li>
<li>libclang (matching your LLVM version)</li>
<li><code>compile_commands.json</code> (generated by CMake/Bear)</li>
</ul>
<h3 id="install">1. Install</h3>
<div class="sourceCode" id="cb2"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> clone https://github.com/FS-Yuao/cpp-semantic-graph.git</span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="bu">cd</span> cpp-semantic-graph</span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a><span class="co"># 一键创建 venv 并安装核心依赖 (推荐)</span></span>
<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a><span class="ex">./setup_env.sh</span></span>
<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a><span class="co"># 默认在项目内创建 .venv;可选:</span></span>
<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a><span class="co"># ./setup_env.sh /path/to/venv 指定 venv 路径</span></span>
<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a><span class="co"># ./setup_env.sh --with-docs 同时装 doc embedding 依赖 (含 torch,体积大)</span></span>
<span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb2-10"><a href="#cb2-10" aria-hidden="true" tabindex="-1"></a><span class="co"># 或手动创建:</span></span>
<span id="cb2-11"><a href="#cb2-11" aria-hidden="true" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> venv .venv</span>
<span id="cb2-12"><a href="#cb2-12" aria-hidden="true" tabindex="-1"></a><span class="bu">source</span> .venv/bin/activate</span>
<span id="cb2-13"><a href="#cb2-13" aria-hidden="true" tabindex="-1"></a><span class="ex">pip</span> install <span class="at">-r</span> requirements.txt</span></code></pre></div>
<blockquote>
<p><strong>前置</strong>: 系统 libclang (匹配 LLVM 版本;Ubuntu:
<code>apt install libclang-18-dev</code>)。 clang bindings 版本须与系统
libclang 一致 (本机 libclang-18 对应 <code>clang>=18,<19</code>,换
LLVM 版本时同步改 <code>requirements.txt</code>)。</p>
</blockquote>
<h3 id="prepare-compile_commands.json">2. Prepare
compile_commands.json</h3>
<p>If your project builds with CMake:</p>
<div class="sourceCode" id="cb3"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="fu">cmake</span> <span class="at">-DCMAKE_EXPORT_COMPILE_COMMANDS</span><span class="op">=</span>ON ...</span></code></pre></div>
<p>Without CMake, use <a
href="https://github.com/rizsotto/Bear">Bear</a> to intercept build
commands:</p>
<div class="sourceCode" id="cb4"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bear</span> <span class="at">--</span> make</span></code></pre></div>
<h3 id="write-the-config-file">3. Write the config file</h3>
<p>Create <code>cpp_semantic_graph.yaml</code> (the only file you need
to edit):</p>
<div class="sourceCode" id="cb5"><pre
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="fu">project</span><span class="kw">:</span></span>
<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> </span><span class="st">"your_project"</span></span>
<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">compile_commands</span><span class="kw">:</span><span class="at"> </span><span class="st">"/path/to/your/project/compile_commands.json"</span></span>
<span id="cb5-4"><a href="#cb5-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb5-5"><a href="#cb5-5" aria-hidden="true" tabindex="-1"></a><span class="co"># Source scope — decides what counts as "project code"</span></span>
<span id="cb5-6"><a href="#cb5-6" aria-hidden="true" tabindex="-1"></a><span class="fu">source_paths</span><span class="kw">:</span></span>
<span id="cb5-7"><a href="#cb5-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="st">"src"</span></span>
<span id="cb5-8"><a href="#cb5-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="st">"include"</span></span>
<span id="cb5-9"><a href="#cb5-9" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb5-10"><a href="#cb5-10" aria-hidden="true" tabindex="-1"></a><span class="co"># Generated-code paths (e.g. ARA COM src-gen, protobuf)</span></span>
<span id="cb5-11"><a href="#cb5-11" aria-hidden="true" tabindex="-1"></a><span class="fu">generated_paths</span><span class="kw">:</span></span>
<span id="cb5-12"><a href="#cb5-12" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="st">"src-gen"</span></span>
<span id="cb5-13"><a href="#cb5-13" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb5-14"><a href="#cb5-14" aria-hidden="true" tabindex="-1"></a><span class="co"># Paths to ignore entirely</span></span>
<span id="cb5-15"><a href="#cb5-15" aria-hidden="true" tabindex="-1"></a><span class="fu">exclude_paths</span><span class="kw">:</span></span>
<span id="cb5-16"><a href="#cb5-16" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="st">"thirdparty"</span></span>
<span id="cb5-17"><a href="#cb5-17" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="st">"build"</span></span>
<span id="cb5-18"><a href="#cb5-18" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="st">"test/mock"</span></span>
<span id="cb5-19"><a href="#cb5-19" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb5-20"><a href="#cb5-20" aria-hidden="true" tabindex="-1"></a><span class="co"># libclang path (adjust for your system)</span></span>
<span id="cb5-21"><a href="#cb5-21" aria-hidden="true" tabindex="-1"></a><span class="fu">libclang_path</span><span class="kw">:</span><span class="at"> </span><span class="st">"/usr/lib/llvm-18/lib/libclang.so.1"</span></span>
<span id="cb5-22"><a href="#cb5-22" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb5-23"><a href="#cb5-23" aria-hidden="true" tabindex="-1"></a><span class="fu">parse_options</span><span class="kw">:</span></span>
<span id="cb5-24"><a href="#cb5-24" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">skip_function_bodies</span><span class="kw">:</span><span class="at"> </span><span class="ch">false</span><span class="co"> # must be false to extract call relations</span></span>
<span id="cb5-25"><a href="#cb5-25" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">max_workers</span><span class="kw">:</span><span class="at"> </span><span class="dv">4</span><span class="co"> # parallel parse processes</span></span></code></pre></div>
<h3 id="full-parse">4. Full parse</h3>
<blockquote>
<p>⚠️ <strong>Important</strong>: stop the MCP server before a full
parse, or the DB connection it holds will cause write failures
(<code>disk I/O error</code>). Stop with
<code>pkill -f "run_server.py"</code>, or disable the MCP server in
Claude Code settings and restart.</p>
</blockquote>
<div class="sourceCode" id="cb6"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="co"># 1. Stop the MCP server (required!)</span></span>
<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a><span class="ex">pkill</span> <span class="at">-f</span> <span class="st">"run_server.py"</span></span>
<span id="cb6-3"><a href="#cb6-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb6-4"><a href="#cb6-4" aria-hidden="true" tabindex="-1"></a><span class="co"># 2. Full parse</span></span>
<span id="cb6-5"><a href="#cb6-5" aria-hidden="true" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> cpp_semantic_graph full-parse <span class="dt">\</span></span>
<span id="cb6-6"><a href="#cb6-6" aria-hidden="true" tabindex="-1"></a> <span class="at">--config</span> cpp_semantic_graph.yaml <span class="dt">\</span></span>
<span id="cb6-7"><a href="#cb6-7" aria-hidden="true" tabindex="-1"></a> <span class="at">--db</span> semantic_graph_full.db</span>
<span id="cb6-8"><a href="#cb6-8" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb6-9"><a href="#cb6-9" aria-hidden="true" tabindex="-1"></a><span class="co"># 3. Restart the MCP server (after parsing finishes)</span></span></code></pre></div>
<p>After parsing, the database contains: - <strong>Nodes</strong>:
classes, structs, functions (with signature, namespace, file location) -
<strong>Edges</strong>: inheritance, calls, overrides, belongs_to, type
aliases (<code>type_alias</code>), using-declarations
(<code>using_decl</code>), friends (<code>friend_of</code>), etc. (the
<code>instantiates</code> template-instantiation edge is not yet enabled
due to libclang AST shape — see <a
href="#-complex-scenarios-templatealiasfriend">Complex scenarios</a>) -
<strong>Include dependencies</strong>: the include graph between
translation units - <strong>Doc associations</strong>: doc sections ↔︎
code entities (optional)</p>
<h3 id="start-the-mcp-server">5. Start the MCP server</h3>
<div class="sourceCode" id="cb7"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Set the database path</span></span>
<span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">CPP_GRAPH_DB</span><span class="op">=</span>/path/to/semantic_graph_full.db</span>
<span id="cb7-3"><a href="#cb7-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb7-4"><a href="#cb7-4" aria-hidden="true" tabindex="-1"></a><span class="co"># Start the MCP server (stdio transport)</span></span>
<span id="cb7-5"><a href="#cb7-5" aria-hidden="true" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> cpp_semantic_graph.mcp_server.server</span></code></pre></div>
<h3 id="register-with-ai-tools">6. Register with AI tools</h3>
<h4 id="claude-code">Claude Code</h4>
<p>Edit <code>~/.claude.json</code>, add under
<code>mcpServers</code>:</p>
<div class="sourceCode" id="cb8"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">"mcpServers"</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb8-3"><a href="#cb8-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">"cpp-semantic-graph"</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb8-4"><a href="#cb8-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">"type"</span><span class="fu">:</span> <span class="st">"stdio"</span><span class="fu">,</span></span>
<span id="cb8-5"><a href="#cb8-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">"command"</span><span class="fu">:</span> <span class="st">"python3"</span><span class="fu">,</span></span>
<span id="cb8-6"><a href="#cb8-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">"args"</span><span class="fu">:</span> <span class="ot">[</span><span class="st">"/absolute/path/to/cpp-semantic-graph/mcp_server/run_server.py"</span><span class="ot">]</span><span class="fu">,</span></span>
<span id="cb8-7"><a href="#cb8-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">"env"</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb8-8"><a href="#cb8-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">"CPP_GRAPH_DB"</span><span class="fu">:</span> <span class="st">"/absolute/path/to/semantic_graph_full.db"</span></span>
<span id="cb8-9"><a href="#cb8-9" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
<span id="cb8-10"><a href="#cb8-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
<span id="cb8-11"><a href="#cb8-11" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
<span id="cb8-12"><a href="#cb8-12" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<h4 id="cursor">Cursor</h4>
<p>Edit <code>.cursor/mcp.json</code>:</p>
<div class="sourceCode" id="cb9"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">"mcpServers"</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb9-3"><a href="#cb9-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">"cpp-semantic-graph"</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb9-4"><a href="#cb9-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">"command"</span><span class="fu">:</span> <span class="st">"python3"</span><span class="fu">,</span></span>
<span id="cb9-5"><a href="#cb9-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">"args"</span><span class="fu">:</span> <span class="ot">[</span><span class="st">"/absolute/path/to/cpp-semantic-graph/mcp_server/run_server.py"</span><span class="ot">]</span><span class="fu">,</span></span>
<span id="cb9-6"><a href="#cb9-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">"env"</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb9-7"><a href="#cb9-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">"CPP_GRAPH_DB"</span><span class="fu">:</span> <span class="st">"/absolute/path/to/semantic_graph_full.db"</span></span>
<span id="cb9-8"><a href="#cb9-8" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
<span id="cb9-9"><a href="#cb9-9" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
<span id="cb9-10"><a href="#cb9-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
<span id="cb9-11"><a href="#cb9-11" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<h4 id="windsurf-other-mcp-clients">Windsurf / other MCP clients</h4>
<p>Configuration is similar; refer to each tool’s MCP docs. The core
parameters: - <strong>command</strong>: <code>python3</code> -
<strong>args</strong>:
<code>["/path/to/mcp_server/run_server.py"]</code> -
<strong>env.CPP_GRAPH_DB</strong>: absolute path to the database</p>
<blockquote>
<p>💡 <strong>Tip</strong>: the <code>CPP_GRAPH_PROJECT</code> env var
sets the project name (used in MCP instructions); if unset it is
inferred from the DB path.</p>
</blockquote>
<hr />
<h2 id="mcp-tools">🛠️ 11 MCP tools</h2>
<table>
<colgroup>
<col style="width: 8%" />
<col style="width: 16%" />
<col style="width: 25%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="header">
<th>#</th>
<th>Tool</th>
<th>Purpose</th>
<th>Typical scenario</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>1</td>
<td><code>cpp_search_class</code></td>
<td>Search class definitions by name</td>
<td>“Where is FirmwareUpdate defined?”</td>
</tr>
<tr class="even">
<td>2</td>
<td><code>cpp_search_function</code></td>
<td>Search function definitions by name</td>
<td>“What’s the signature of PerformUpdate?”</td>
</tr>
<tr class="odd">
<td>3</td>
<td><code>cpp_get_inheritance</code></td>
<td>Query a class’s inheritance</td>
<td>“Which classes derive from DeviceAdapter?”</td>
</tr>
<tr class="even">
<td>4</td>
<td><code>cpp_get_callers</code></td>
<td>Who calls a given function</td>
<td>“Who calls QueryBootChain?”</td>
</tr>
<tr class="odd">
<td>5</td>
<td><code>cpp_get_callees</code></td>
<td>What a given function calls</td>
<td>“What does PerformUpdate call internally?”</td>
</tr>
<tr class="even">
<td>6</td>
<td><code>cpp_get_overrides</code></td>
<td>All overrides of a virtual function</td>
<td>“Which overrides exist for PerformUpdate?”</td>
</tr>
<tr class="odd">
<td>7</td>
<td><code>cpp_get_file_symbols</code></td>
<td>All symbols in a file</td>
<td>“What’s in chip_update.cpp?”</td>
</tr>
<tr class="even">
<td>8</td>
<td><code>cpp_traverse_graph</code></td>
<td>Multi-hop graph traversal</td>
<td>“What does changing FirmwareUpdate affect?”</td>
</tr>
<tr class="odd">
<td>9</td>
<td><code>cpp_search_docs</code></td>
<td>Search project docs (-> related code)</td>
<td>“The OTA upgrade-flow design doc”</td>
</tr>
<tr class="even">
<td>10</td>
<td><code>cpp_blast_radius</code></td>
<td>Blast radius of a change (recursive callers + override expansion +
file aggregation)</td>
<td>“I’m changing PerformUpdate — which files must I review?”</td>
</tr>
<tr class="odd">
<td>11</td>
<td><code>cpp_get_code_docs</code></td>
<td>Reverse: code symbol -> docs describing it</td>
<td>“What design docs describe PerformUpdate?”</td>
</tr>
</tbody>
</table>
<h3 id="tool-details">Tool details</h3>
<h4
id="cpp_search_classname-exactfalse"><code>cpp_search_class(name, exact=False)</code></h4>
<p>Search C++ class definitions by name. Supports fuzzy matching.</p>
<pre><code>cpp_search_class("FirmwareUpdate")
-> ## Search results: class "FirmwareUpdate" (1)
### update::FirmwareUpdate
- File: chip_update.h:15-120</code></pre>
<h4
id="cpp_search_functionname-class_name"><code>cpp_search_function(name, class_name="")</code></h4>
<p>Search function definitions by name. Optionally restrict by owning
class.</p>
<pre><code>cpp_search_function("PerformUpdate", class_name="FirmwareUpdate")
-> ## Search results: function "PerformUpdate" (1)
### FirmwareUpdate::PerformUpdate [virtual, override]
- Signature: void PerformUpdate() override
- File: chip_update.cpp:45</code></pre>
<h4
id="cpp_get_inheritanceclass_name-directiondown-depth1"><code>cpp_get_inheritance(class_name, direction="down", depth=1)</code></h4>
<p>Query inheritance. <code>direction="down"</code> for subclasses,
<code>"up"</code> for base classes. <code>depth=-1</code> recurses
fully.</p>
<pre><code>cpp_get_inheritance("DeviceAdapter", direction="down", depth=-1)
-> ## Subclasses of DeviceAdapter (4)
- update::FirmwareUpdate --public--> DeviceAdapter
- update::McuUpdate --public--> DeviceAdapter
- ...</code></pre>
<h4
id="cpp_get_callersfunction_name-class_name"><code>cpp_get_callers(function_name, class_name="")</code></h4>
<p>Who calls a given function (impact analysis).</p>
<pre><code>cpp_get_callers("QueryBootChain")
-> ## Code that calls "QueryBootChain" (3)
### UpdateManager::CheckBootChain
- File: update_manager.cpp:128
- Call type: calls_direct</code></pre>
<h4
id="cpp_get_calleesfunction_name-class_name"><code>cpp_get_callees(function_name, class_name="")</code></h4>
<p>What a given function calls (call-chain analysis).</p>
<pre><code>cpp_get_callees("PerformUpdate", class_name="FirmwareUpdate")
-> ## Code called by "PerformUpdate" (8)
...</code></pre>
<h4
id="cpp_get_overridesfunction_name-class_name"><code>cpp_get_overrides(function_name, class_name)</code></h4>
<p>All override implementations of a virtual function.
<code>class_name</code> is the base class that declares the virtual
(required).</p>
<pre><code>cpp_get_overrides("PerformUpdate", class_name="DeviceAdapter")
-> ## Overrides of "PerformUpdate" (4)
### update::FirmwareUpdate::PerformUpdate
- Signature: void PerformUpdate() override
- File: chip_update.cpp:45
- Overrides base: DeviceAdapter</code></pre>
<h4
id="cpp_get_file_symbolsfile_path"><code>cpp_get_file_symbols(file_path)</code></h4>
<p>All class and function symbols in a file. <code>file_path</code>
supports partial matching.</p>
<pre><code>cpp_get_file_symbols("chip_update.h")
-> ## File symbols: chip_update.h (12 total)
### Classes/structs (2)
1. ### [class] update::FirmwareUpdate
### Functions (10)
...</code></pre>
<h4
id="cpp_traverse_graphstart-relation_typesnone-directionoutgoing-depth3-max_results50"><code>cpp_traverse_graph(start, relation_types=None, direction="outgoing", depth=3, max_results=50)</code></h4>
<p>Multi-hop graph traversal — the most flexible query. Walks related
nodes along specified relation types.</p>
<p>Common relation types: <code>inherits_public</code>,
<code>inherits_protected</code>, <code>overrides</code>,
<code>belongs_to</code>, <code>calls_direct</code>,
<code>calls_virtual</code>, <code>calls_callback</code>,
<code>doc_describes_code</code>, <code>code_refers_to_doc</code></p>
<pre><code>cpp_traverse_graph("FirmwareUpdate", depth=2, max_results=30)
-> ## Traversal results: from "FirmwareUpdate" (18 nodes)
Depth: 2, edges traversed: 22
### Related nodes
- [class] update::FirmwareUpdate (chip_update.h)
- [class] update::DeviceAdapter (base_device_update.h)
- [function] update::FirmwareUpdate::PerformUpdate (chip_update.cpp)
...</code></pre>
<h4
id="cpp_search_docskeyword-tag-max_results10-min_confidence0.7"><code>cpp_search_docs(keyword, tag="", max_results=10, min_confidence=0.7)</code></h4>
<p>Search project docs, returns doc sections + associated code.</p>
<pre><code>cpp_search_docs("升级", tag="架构设计")
-> ## Doc search: "升级" (3 results)
### OTA complete upgrade flow
- File: docs/OTA_flow/OTA_COMPLETE_FLOW.md
- Word count: 2450
- Tags: 架构设计, OTA
Associated code:
- [class] DeviceAdapter confidence=0.92
- [class] FirmwareUpdate confidence=0.88</code></pre>
<p>Note: default <code>min_confidence=0.7</code> filters low-quality
co-occurrence associations (confidence=0.6 makes up 63%, mostly noise
like “刷写” matching Data/Response). Pass 0.0 to see all
associations.</p>
<h4
id="cpp_get_code_docssymbol-min_confidence0.0-max_results10"><code>cpp_get_code_docs(symbol, min_confidence=0.0, max_results=10)</code></h4>
<p>Reverse lookup: given a code symbol, returns doc sections describing
it (design docs / HLD / architecture docs). Complement of
<code>cpp_search_docs</code> — pass a code symbol directly without
thinking of keywords.</p>
<pre><code>cpp_get_code_docs("PerformUpdate")
-> ## Docs describing "PerformUpdate" (6 sections)
### 3. Current flow
- Doc: SOC A/B partition switch design
- File: AB_Switch/AB_PARTITION_SWITCH_DESIGN.md:62-81
- Tags: 架构设计, A/B分区
### 4.3 Components
- File: ADC4.0_System_architecture/ADC4.0_OTA_SW_HLD.md:342-578
- Tags: 系统架构</code></pre>
<p>Note: reverse associations are mostly content_scan (confidence=0.6).
Unlike forward, code symbols appearing in docs are usually genuinely
about them, so 0.6 is typically valid. Default returns all, rely on
<code>max_results</code> to bound.</p>
<hr />
<h2 id="cli-usage">📖 CLI usage</h2>
<p>Besides MCP tools, a CLI is provided for direct queries:</p>
<div class="sourceCode" id="cb20"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb20-1"><a href="#cb20-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Search a class</span></span>
<span id="cb20-2"><a href="#cb20-2" aria-hidden="true" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> cpp_semantic_graph search-class <span class="st">"FirmwareUpdate"</span></span>
<span id="cb20-3"><a href="#cb20-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb20-4"><a href="#cb20-4" aria-hidden="true" tabindex="-1"></a><span class="co"># Query inheritance</span></span>
<span id="cb20-5"><a href="#cb20-5" aria-hidden="true" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> cpp_semantic_graph inheritance <span class="st">"DeviceAdapter"</span> <span class="at">--direction</span> down <span class="at">--depth</span> <span class="at">-1</span></span>
<span id="cb20-6"><a href="#cb20-6" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb20-7"><a href="#cb20-7" aria-hidden="true" tabindex="-1"></a><span class="co"># Search a function</span></span>
<span id="cb20-8"><a href="#cb20-8" aria-hidden="true" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> cpp_semantic_graph search-func <span class="st">"PerformUpdate"</span></span>
<span id="cb20-9"><a href="#cb20-9" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb20-10"><a href="#cb20-10" aria-hidden="true" tabindex="-1"></a><span class="co"># File symbols</span></span>
<span id="cb20-11"><a href="#cb20-11" aria-hidden="true" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> cpp_semantic_graph file-symbols <span class="st">"chip_update.cpp"</span></span>
<span id="cb20-12"><a href="#cb20-12" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb20-13"><a href="#cb20-13" aria-hidden="true" tabindex="-1"></a><span class="co"># Include dependencies</span></span>
<span id="cb20-14"><a href="#cb20-14" aria-hidden="true" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> cpp_semantic_graph include <span class="st">"base_device_update.h"</span> <span class="at">--mode</span> all</span>
<span id="cb20-15"><a href="#cb20-15" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb20-16"><a href="#cb20-16" aria-hidden="true" tabindex="-1"></a><span class="co"># DB stats</span></span>
<span id="cb20-17"><a href="#cb20-17" aria-hidden="true" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> cpp_semantic_graph stats</span></code></pre></div>
<h3 id="incremental-update">Incremental update</h3>
<p>After a code change, the incremental update re-parses only affected
translation units:</p>
<div class="sourceCode" id="cb21"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb21-1"><a href="#cb21-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Based on git diff (default HEAD~1)</span></span>
<span id="cb21-2"><a href="#cb21-2" aria-hidden="true" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> cpp_semantic_graph incremental <span class="at">--base</span> HEAD~1</span>
<span id="cb21-3"><a href="#cb21-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb21-4"><a href="#cb21-4" aria-hidden="true" tabindex="-1"></a><span class="co"># Specify files manually</span></span>
<span id="cb21-5"><a href="#cb21-5" aria-hidden="true" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> cpp_semantic_graph incremental <span class="at">--files</span> chip_update.cpp,base_device_update.h</span>
<span id="cb21-6"><a href="#cb21-6" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb21-7"><a href="#cb21-7" aria-hidden="true" tabindex="-1"></a><span class="co"># Detect only, don't execute</span></span>
<span id="cb21-8"><a href="#cb21-8" aria-hidden="true" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> cpp_semantic_graph incremental <span class="at">--files</span> chip_update.cpp <span class="at">--dry-run</span></span>
<span id="cb21-9"><a href="#cb21-9" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb21-10"><a href="#cb21-10" aria-hidden="true" tabindex="-1"></a><span class="co"># Skip doc-association rebuild (faster)</span></span>
<span id="cb21-11"><a href="#cb21-11" aria-hidden="true" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> cpp_semantic_graph incremental <span class="at">--files</span> chip_update.cpp <span class="at">--skip-associations</span></span></code></pre></div>
<hr />
<h2 id="architecture">📐 Architecture</h2>
<pre><code>┌─────────────────────────────────────────────────┐
│ AI tool layer │
│ Claude Code / Cursor / Windsurf / other MCP │
└────────────────────┬────────────────────────────┘
│ MCP protocol (stdio)
┌────────────────────▼────────────────────────────┐
│ MCP Server (9 tools) │
│ FastMCP + Lazy-init DB connection + Markdown │
└────────────────────┬────────────────────────────┘
│ Python API
┌────────────────────▼────────────────────────────┐
│ Query layer (query/) │
│ GraphQuery │ CallQuery │ PolymorphismQuery │
│ TraverseQuery │ DocQuery │ IncludeQuery │
└────────────────────┬────────────────────────────┘
│
┌────────────────────▼────────────────────────────┐
│ Data layer (db/) │
│ SQLite + 9 indexes + CASCADE constraints │
│ node │ edge │ include_dep │ parse_status │
└─────────────────────────────────────────────────┘
┌─────────────────────────────────────────────────┐
│ Parser layer (parser/) │
│ AST Visitor (libclang) │ CompileDB │ Config │
│ ChangeDetector │ ImpactAnalyzer │
└─────────────────────────────────────────────────┘</code></pre>
<h3 id="core-data-model">Core data model</h3>
<p><strong>Nodes (node table)</strong>: classes, structs, functions —
with namespace, file location, signature, etc.</p>
<p><strong>Edges (edge table)</strong>: relations between nodes;
direction convention: - <code>inherits</code>: from=subclass → to=base
class - <code>calls</code>: from=caller → to=callee -
<code>belongs_to</code>: from=function → to=owning class -
<code>overrides</code>: from=derived function → to=base function</p>
<p><strong>include_dep table</strong>: include dependencies between
translation units — the core basis for incremental updates.</p>
<hr />
<h2 id="complex-scenarios-templatealiasfriend">🧩 Complex scenarios
(template/alias/friend)</h2>
<table>
<colgroup>
<col style="width: 23%" />
<col style="width: 38%" />
<col style="width: 20%" />
<col style="width: 17%" />
</colgroup>
<thead>
<tr class="header">
<th>Feature</th>
<th>Relation edge</th>
<th>Status</th>
<th>Notes</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Type alias <code>using Alias = T</code></td>
<td><code>type_alias</code></td>
<td>✅ Enabled</td>
<td>Alias node stored + edge links to target; when the target comes from
an external library the edge may be dropped as dangling, but the alias
node keeps <code>target_type</code> metadata</td>
</tr>
<tr class="even">
<td>using-declaration <code>using B::func</code></td>
<td><code>using_decl</code></td>
<td>✅ Enabled</td>
<td>Subclass function → base function; this project’s source has no
ordinary using-declarations, only 1 literal operator not extracted</td>
</tr>
<tr class="odd">
<td>Friend <code>friend class F</code></td>
<td><code>friend_of</code></td>
<td>✅ Enabled</td>
<td>friend → host class; this project’s source has no friend
declarations, 0 edges as expected</td>
</tr>
<tr class="even">
<td>Template instantiation</td>
<td><code>instantiates</code></td>
<td>⏸️ Not yet enabled</td>
<td>libclang does not produce a standalone CLASS_DECL node for template
specializations (the specialization name only appears in the spelling of
CONSTRUCTOR/TYPE_REF), so <code>walk_preorder</code> finds no class
declaration containing <code><</code> and extraction yields nothing.
The extractor code is retained, to be enabled once we switch to
LibTooling or rebuild from TYPE_REF</td>
</tr>
</tbody>
</table>
<blockquote>
<p>This area previously had “extractors written but not wired into the
pipeline” (dead code). AliasExtractor/FriendExtractor are now integrated
into <code>SemanticExtractor.parse()</code>, and output was verified
against clangd.</p>
</blockquote>
<hr />
<h2 id="incremental-update-mechanism">🔄 Incremental-update
mechanism</h2>
<pre><code>1. ChangeDetector ──-> detect file changes (git diff / manual)
2. ImpactAnalyzer ──-> analyze blast radius (.h -> recursive includers)
3. Delete stale data ──-> delete out-edges (not shared nodes) + include_dep + parse_status
4. Re-parse ──-> SemanticExtractor.parse() × affected TUs
5. Upsert new data ──-> node update / edge dedup
6. Cleanup remnants ──-> delete functions/classes no longer in the file
7. Rebuild doc links ──-> content_scan (optional embedding)</code></pre>
<p><strong>Core deletion strategy</strong>: only out-edges (edges whose
from_id is in that file) are deleted; in-edges are kept; nodes are
updated via upsert. This ensures classes/functions shared in headers are
never mistakenly deleted.</p>
<table>
<colgroup>
<col style="width: 27%" />
<col style="width: 36%" />
<col style="width: 36%" />
</colgroup>
<thead>
<tr class="header">
<th>Scenario</th>
<th>Affected TUs</th>
<th>Update time</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Single .cpp change</td>
<td>1</td>
<td>~11s</td>
</tr>
<tr class="even">
<td>Single .h change</td>
<td>recursive includers</td>
<td>depends on TU count (7 TUs ~76s)</td>
</tr>
<tr class="odd">
<td>Idempotency (second run)</td>
<td>unchanged</td>
<td>edge count stable ✅</td>
</tr>
</tbody>
</table>
<blockquote>
<p><strong>Note</strong>: the git-diff auto-detect mode
(<code>--base HEAD~1</code>) may not work under Android
repo-tool-managed repos (<code>_ensure_repo_root</code> finds the repo
top-level <code>.git</code> rather than the sub-repo’s). Using
<code>--files</code> to specify changed files manually is more
reliable.</p>
</blockquote>
<hr />
<h2 id="doc-fusion">📚 Doc fusion</h2>
<p>Bidirectionally links project docs (Markdown) with code entities, so
searching docs auto-locates related code.</p>
<p><strong>This project has doc fusion configured</strong>: 58 docs →
546 sections → 1,756 association edges (doc_describes_code +
code_refers_to_doc). <code>cpp_search_docs</code> works out of the
box.</p>
<h3 id="configuration">Configuration</h3>
<p>Create <code>config/doc_config.yaml</code>:</p>
<div class="sourceCode" id="cb24"><pre
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb24-1"><a href="#cb24-1" aria-hidden="true" tabindex="-1"></a><span class="fu">doc_dirs</span><span class="kw">:</span></span>
<span id="cb24-2"><a href="#cb24-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="st">"docs/"</span></span>
<span id="cb24-3"><a href="#cb24-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb24-4"><a href="#cb24-4" aria-hidden="true" tabindex="-1"></a><span class="fu">exclude_patterns</span><span class="kw">:</span></span>
<span id="cb24-5"><a href="#cb24-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="st">"*.html"</span></span>
<span id="cb24-6"><a href="#cb24-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="st">"*/build/*"</span></span>
<span id="cb24-7"><a href="#cb24-7" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb24-8"><a href="#cb24-8" aria-hidden="true" tabindex="-1"></a><span class="co"># Auto-tag by directory</span></span>
<span id="cb24-9"><a href="#cb24-9" aria-hidden="true" tabindex="-1"></a><span class="fu">tag_rules</span><span class="kw">:</span></span>
<span id="cb24-10"><a href="#cb24-10" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">path_pattern</span><span class="kw">:</span><span class="at"> </span><span class="st">"architecture/**"</span></span>
<span id="cb24-11"><a href="#cb24-11" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">tags</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="st">"架构设计"</span><span class="kw">]</span></span>
<span id="cb24-12"><a href="#cb24-12" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">path_pattern</span><span class="kw">:</span><span class="at"> </span><span class="st">"api/**"</span></span>
<span id="cb24-13"><a href="#cb24-13" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">tags</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="st">"接口规约"</span><span class="kw">]</span></span>
<span id="cb24-14"><a href="#cb24-14" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb24-15"><a href="#cb24-15" aria-hidden="true" tabindex="-1"></a><span class="fu">section_split</span><span class="kw">:</span></span>
<span id="cb24-16"><a href="#cb24-16" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">min_level</span><span class="kw">:</span><span class="at"> </span><span class="dv">2</span><span class="co"> # split on ##</span></span>
<span id="cb24-17"><a href="#cb24-17" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">min_word_count</span><span class="kw">:</span><span class="at"> </span><span class="dv">20</span><span class="co"> # sections under 20 words are merged</span></span>
<span id="cb24-18"><a href="#cb24-18" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb24-19"><a href="#cb24-19" aria-hidden="true" tabindex="-1"></a><span class="co"># Manual precise links (no intrusion into doc text)</span></span>
<span id="cb24-20"><a href="#cb24-20" aria-hidden="true" tabindex="-1"></a><span class="fu">manual_links</span><span class="kw">:</span></span>
<span id="cb24-21"><a href="#cb24-21" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">doc</span><span class="kw">:</span><span class="at"> </span><span class="st">"architecture/UPDATE_FLOW.md"</span></span>
<span id="cb24-22"><a href="#cb24-22" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">heading</span><span class="kw">:</span><span class="at"> </span><span class="st">"Update flow"</span></span>
<span id="cb24-23"><a href="#cb24-23" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">code</span><span class="kw">:</span></span>
<span id="cb24-24"><a href="#cb24-24" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="st">"DeviceAdapter"</span></span>
<span id="cb24-25"><a href="#cb24-25" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="st">"FirmwareUpdate"</span></span>
<span id="cb24-26"><a href="#cb24-26" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="st">"PerformUpdate"</span></span></code></pre></div>
<h3 id="embedding-association-optional-experimental">Embedding
association (optional, experimental)</h3>
<blockquote>
<p>⚠️ <strong>Experimental — not validated.</strong> The embedding
pipeline has not been tested end-to-end. It is retained from the design
phase but excluded from the default association strategy. Results and
accuracy are unknown.</p>
</blockquote>
<p>After installing <code>sentence-transformers</code>, docs and code
can be auto-associated by semantic similarity. This is <strong>not
enabled by default</strong> — pass <code>--rebuild-embeddings</code> to
<code>incremental</code> or call
<code>ingest_embedding_associations()</code> explicitly:</p>
<div class="sourceCode" id="cb25"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb25-1"><a href="#cb25-1" aria-hidden="true" tabindex="-1"></a><span class="ex">pip</span> install sentence-transformers</span></code></pre></div>
<p>Defaults to <code>all-MiniLM-L6-v2</code>. For Chinese projects,
<code>bge-small-zh-v1.5</code> or <code>multilingual-e5-small</code> is
recommended.</p>
<hr />
<h2 id="memory-layer-findings-stop-re-deriving-the-same-conclusions">🧠
Memory layer (findings) — stop re-deriving the same conclusions</h2>
<p>The <code>doc_graph/</code> sub-project extends doc fusion into a
<strong>team memory hub</strong>: durable conclusions from AI sessions
(constraints, lessons, decisions, facts, risks) are stored as
first-class records, <strong>anchored to code symbols</strong>, and
automatically surfaced whenever those symbols are queried.</p>
<pre><code>Session derives a conclusion
→ record_finding_tool (idempotent, symbol-anchored)
→ next session queries the symbol → finding surfaces automatically
→ code evolves → check_finding_freshness marks it stale</code></pre>
<p><strong>What it adds on top of doc fusion:</strong></p>
<table>
<colgroup>
<col style="width: 70%" />
<col style="width: 29%" />
</colgroup>
<thead>
<tr class="header">
<th>Capability</th>
<th>How</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Finding store</td>
<td>Independent SQLite tables (finding / finding_symbol / finding_fts),
survives full graph rebuilds</td>
</tr>
<tr class="even">
<td>Symbol anchoring</td>
<td>Findings link to code symbols; any doc-graph query touching that
symbol brings them back</td>
</tr>
<tr class="odd">
<td>3-way RRF retrieval</td>
<td>FTS5 + LIKE + symbol backref run in parallel, fused with Reciprocal
Rank Fusion</td>
</tr>