-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathserver.py
More file actions
1077 lines (938 loc) · 42.8 KB
/
Copy pathserver.py
File metadata and controls
1077 lines (938 loc) · 42.8 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
#!/usr/bin/env python3
"""
The Ethspectoor MCP Server.
Serves Ethereum spec data over MCP (Model Context Protocol).
Loads a pre-built catalog.json on startup, answers structured queries
about types, functions, constants, endpoints, and cross-spec references.
Usage:
# stdio transport (for agent integration)
python3 server.py
# With custom catalog path
python3 server.py --catalog docs/catalog.json
# Rebuild indexes before starting (requires repo paths)
python3 server.py --rebuild --repos-dir /path/to/repos
"""
import argparse
import asyncio
import json
import re
import os
import sys
from pathlib import Path
from typing import Optional
from mcp.server import Server
from mcp.server.stdio import stdio_server
from mcp.types import Tool, TextContent
# ── Constants ──────────────────────────────────────────────────────────────
SPEC_REPO_MAP = {
"consensus-specs": "consensus-specs",
"builder-specs": "builder-specs",
"relay-specs": "relay-specs",
"beacon-apis": "beacon-APIs",
"remote-signing-api": "remote-signing-api",
"execution-specs": "execution-specs",
"execution-apis": "execution-apis",
}
# ── Catalog Store ──────────────────────────────────────────────────────────
class SpecStore:
"""In-memory store backed by catalog.json -- the single source of truth
shared with the explorer UI."""
def __init__(self):
self.catalog: dict = {}
self.items: dict = {} # name -> item (already merged/deduped)
self.specs: dict = {} # spec_name -> spec data
self.type_map: dict = {} # name -> canonical source info
self.cross_refs: dict = {} # cross-spec references
self.all_endpoints: dict = {} # ep_key -> (spec_name, endpoint)
self.pr_overlays: dict = {} # spec_name -> {pr_num: overlay}
def load(self, catalog_path: str):
"""Load the unified catalog."""
with open(catalog_path) as f:
try:
self.catalog = json.load(f)
except json.JSONDecodeError as e:
raise ValueError(f"Malformed catalog JSON: {e}") from e
self.items = self.catalog.get("items", {})
self.specs = self.catalog.get("specs", {})
self.type_map = self.catalog.get("type_map", {})
self.cross_refs = self.catalog.get("cross_refs", {})
self.pr_overlays = self.catalog.get("pr_overlays", {})
# Build flat endpoint index
self.all_endpoints = {}
for spec_name, spec_data in self.specs.items():
for ep_key, endpoint in spec_data.get("endpoints", {}).items():
self.all_endpoints[ep_key] = (spec_name, endpoint)
# Pre-build reverse reference index: type_name -> [{spec, item}]
self.used_by_index = {}
for spec_name, spec_data in self.specs.items():
for ref_target, users in spec_data.get("references", {}).items():
if ref_target not in self.used_by_index:
self.used_by_index[ref_target] = []
for user in users:
self.used_by_index[ref_target].append({"spec": spec_name, "item": user})
# ── PR overlay resolution ────────────────────────────────────────
@staticmethod
def parse_pr_fork(fork: str) -> int | None:
"""If fork matches 'pr-NNNN', return the PR number. Else None."""
if fork and fork.startswith("pr-"):
try:
return int(fork[3:])
except ValueError:
pass
return None
def find_pr_overlay(self, pr_number: int) -> dict | None:
"""Find a PR overlay by number across all specs."""
pr_str = str(pr_number)
for spec_name, prs in self.pr_overlays.items():
if pr_str in prs:
return prs[pr_str]
return None
def resolve_pr_item(self, name: str, pr_number: int) -> dict | None:
"""Resolve an item at a PR fork.
If the PR changed this item, returns the overlay version (full post-PR
content) wrapped as a fork entry. Otherwise returns mainline data.
"""
overlay = self.find_pr_overlay(pr_number)
if not overlay:
return None
items_changed = overlay.get("items_changed", {})
if name in items_changed:
return items_changed[name]
return None # item not changed by this PR -- caller falls back to mainline
def list_pr_overlays(self, spec: str = "") -> list[dict]:
"""List all indexed PR overlays, optionally filtered by spec."""
results = []
for spec_name, prs in self.pr_overlays.items():
if spec and spec != spec_name:
continue
for pr_num, overlay in prs.items():
results.append({
"spec": spec_name,
"number": overlay.get("number", int(pr_num)),
"title": overlay.get("title", ""),
"author": overlay.get("author", ""),
"base_fork": overlay.get("base_ref", ""),
"url": overlay.get("url", ""),
"updated_at": overlay.get("updated_at", ""),
"items_changed": len(overlay.get("items_changed", {})),
"constants_changed": len(overlay.get("constants_changed", {})),
})
return results
def specs_summary(self) -> list:
"""Return summary of loaded specs."""
result = []
for name, spec_data in self.specs.items():
meta = spec_data.get("meta", {})
result.append({
"name": name,
"source": meta.get("repo", ""),
"items": meta.get("total_items", 0),
"constants": len(spec_data.get("constants", {})),
"endpoints": len(spec_data.get("endpoints", {})),
"forks": meta.get("fork_order", []),
})
return result
def lookup_type(self, name: str, fork: Optional[str] = None, spec: Optional[str] = None) -> Optional[dict]:
"""Look up a type/function/item by name."""
# Handle PR fork resolution
pr_num = self.parse_pr_fork(fork) if fork else None
if pr_num is not None:
pr_item = self.resolve_pr_item(name, pr_num)
overlay = self.find_pr_overlay(pr_num)
if pr_item:
# Return the PR's version of this item
result = {
"name": name,
"spec": pr_item.get("spec", overlay.get("_meta", {}).get("spec", "")),
"kind": pr_item.get("kind", ""),
"domain": pr_item.get("domain", ""),
"pr": pr_num,
"pr_action": pr_item.get("action", ""),
"fork": pr_item.get("fork", ""),
"diff_summary": pr_item.get("diff_summary", {}),
}
for key in ["fields", "code", "references", "params", "eips",
"return_type", "prose", "github_url"]:
if pr_item.get(key):
result[key] = pr_item[key]
return result
else:
# Item not changed by this PR -- fall through to mainline
# but strip the PR fork so mainline lookup works
fork = None
item = None
if spec:
# Filter to items whose primary or secondary spec matches
candidate = self.items.get(name)
if candidate and spec in candidate.get("specs", []):
item = candidate
else:
item = self.items.get(name)
if not item:
# Fuzzy fallback
matches = self._fuzzy_match(name, list(self.items.keys()), limit=5)
if matches:
return {"error": f"Type '{name}' not found", "suggestions": matches}
return {"error": f"Type '{name}' not found"}
return self._format_item(item, fork)
def _format_item(self, item: dict, fork: Optional[str] = None) -> dict:
"""Format an item for output."""
name = item["name"]
spec_name = item.get("spec", "")
result = {
"name": name,
"spec": spec_name,
"kind": item.get("kind", ""),
"domain": item.get("domain", ""),
"introduced": item.get("introduced", ""),
"modified_in": item.get("modified_in", []),
"forks_available": list(item.get("forks", {}).keys()),
}
# Canonical source from type_map
if name in self.type_map:
result["canonical_source"] = self.type_map[name]["source"]
# Reverse references (who uses this type) -- pre-built index
used_by = self.used_by_index.get(name, [])
if used_by:
result["used_by"] = used_by
forks = item.get("forks", {})
if fork:
fork_data = forks.get(fork)
if fork_data:
result["fork"] = fork
result.update(self._extract_fork_fields(fork_data, forks, fork))
result = {k: v for k, v in result.items() if v or v == 0}
else:
result["error"] = f"Type '{name}' exists but not at fork '{fork}'"
result["forks_available"] = list(forks.keys())
else:
# Return latest fork data
if forks:
latest_fork = list(forks.keys())[-1]
latest = forks[latest_fork]
result["latest_fork"] = latest_fork
result.update(self._extract_fork_fields(latest, forks, latest_fork))
result = {k: v for k, v in result.items() if v or v == 0}
return result
def _extract_fork_fields(self, fork_data: dict, all_forks: dict, fork_name: str) -> dict:
"""Extract displayable fields from a fork entry.
Handles deduped code: if this fork has no 'code' key, inherit from
the most recent prior fork that does."""
out = {}
for key in ["fields", "references", "params", "eips"]:
if fork_data.get(key):
out[key] = fork_data[key]
if fork_data.get("return_type"):
out["return_type"] = fork_data["return_type"]
prose = fork_data.get("prose") or fork_data.get("description") or ""
if prose:
out["prose"] = prose
if fork_data.get("github_url"):
out["github_url"] = fork_data["github_url"]
# Resolve code: catalog dedupes by only storing code when it changes.
# Walk backwards through forks to find the most recent code.
code = fork_data.get("code", "")
if not code:
fork_keys = list(all_forks.keys())
idx = fork_keys.index(fork_name) if fork_name in fork_keys else -1
for i in range(idx - 1, -1, -1):
prev_code = all_forks[fork_keys[i]].get("code", "")
if prev_code:
code = prev_code
break
if code:
out["code"] = code
return out
def lookup_endpoint(self, query: str) -> list:
"""Search endpoints by path, operation, or keyword."""
query_lower = query.lower()
query_norm = self._normalize(query)
results = []
for ep_key, (spec_name, endpoint) in self.all_endpoints.items():
path = endpoint.get("path", "")
op_id = endpoint.get("operation_id", "")
summary = endpoint.get("summary", "")
tags = endpoint.get("tags", [])
if (query_lower in path.lower()
or query_lower in op_id.lower()
or query_lower in summary.lower()
or any(query_lower in t.lower() for t in tags)
or query_norm in self._normalize(path)
or query_norm in self._normalize(op_id)):
result = {
"spec": spec_name,
"method": endpoint.get("method", ""),
"path": path,
"operation_id": op_id,
"summary": summary,
"tags": tags,
"parameters": endpoint.get("parameters", []),
"fork_versioned": endpoint.get("fork_versioned", False),
"fork_variants": endpoint.get("fork_variants", {}),
"ssz_support": endpoint.get("content_negotiation", {}).get("ssz_support", False),
"github_url": endpoint.get("github_url", ""),
"result": endpoint.get("result"),
"errors": endpoint.get("errors"),
"examples": endpoint.get("examples"),
"domain": endpoint.get("domain"),
"introduced_fork": endpoint.get("introduced_fork"),
}
if endpoint.get("request_body"):
result["request_body"] = endpoint["request_body"]
results.append(result)
return results
def what_changed(self, fork: str, spec: Optional[str] = None) -> dict:
"""Return what changed in a specific fork."""
# Handle PR fork
pr_num = self.parse_pr_fork(fork)
if pr_num is not None:
overlay = self.find_pr_overlay(pr_num)
if not overlay:
return {"error": f"No PR overlay found for #{pr_num}. Run pr_index.py first."}
result = {
"pr": pr_num,
"title": overlay.get("title", ""),
"author": overlay.get("author", ""),
"url": overlay.get("url", ""),
"base_fork": overlay.get("base_ref", ""),
}
items = overlay.get("items_changed", {})
if items:
result["items_changed"] = {
name: {
"action": data.get("action", ""),
"kind": data.get("kind", ""),
"domain": data.get("domain", ""),
"diff_summary": data.get("diff_summary", {}),
}
for name, data in items.items()
}
consts = overlay.get("constants_changed", {})
if consts:
result["constants_changed"] = consts
return result
result = {}
specs_to_check = [spec] if spec and spec in self.specs else list(self.specs.keys())
for spec_name in specs_to_check:
spec_data = self.specs[spec_name]
fs = spec_data.get("fork_summary", {}).get(fork)
if fs:
entry = {
"new": fs.get("new", []),
"modified": fs.get("modified", []),
"total": fs.get("total_definitions", 0),
}
if fs.get("new_methods"):
entry["new_methods"] = fs["new_methods"]
if fs.get("new_constants"):
entry["new_constants"] = fs["new_constants"]
if fs.get("eips"):
entry["fork_eips"] = fs["eips"]
result[spec_name] = entry
# EIP index
eip_index = spec_data.get("eip_index", {})
fork_eips = {}
for eip_num, eip_data in eip_index.items():
fork_items = [i for i in eip_data.get("items", []) if i.get("fork") == fork]
if fork_items:
fork_eips[f"EIP-{eip_num}"] = fork_items
if fork_eips:
result.setdefault(spec_name, {})["eips"] = fork_eips
if not result:
all_forks = set()
for sdata in self.specs.values():
all_forks.update(sdata.get("meta", {}).get("fork_order", []))
return {"error": f"No changes found for fork '{fork}'", "available_forks": sorted(all_forks)}
return result
def trace_type(self, name: str) -> dict:
"""Trace a type across spec boundaries."""
result = {
"name": name,
"defined_in": [],
"used_by": [],
"cross_spec_refs": [],
}
# Where is it defined?
item = self.items.get(name)
if item:
for s in item.get("specs", []):
result["defined_in"].append({
"spec": s,
"kind": item.get("kind", ""),
"introduced": item.get("introduced", ""),
"forks": list(item.get("forks", {}).keys()),
})
# Reverse references
for spec_name, spec_data in self.specs.items():
refs = spec_data.get("references", {})
if name in refs:
for user in refs[name]:
result["used_by"].append({
"spec": spec_name,
"item": user,
})
# Cross-spec references
for ref_key, ref_data in self.cross_refs.items():
if isinstance(ref_data, dict):
if ref_data.get("to_type") == name or ref_data.get("from_item") == name:
result["cross_spec_refs"].append(ref_data)
# Canonical source
if name in self.type_map:
result["canonical_source"] = self.type_map[name]
return result
def search(self, query: str, limit: int = 20) -> dict:
"""Search across all items, constants, endpoints."""
query_lower = query.lower()
query_norm = self._normalize(query)
results = {"items": [], "constants": [], "endpoints": [], "type_aliases": []}
# Search unified items
for item_name, item in self.items.items():
if (query_lower in item_name.lower()
or query_norm in self._normalize(item_name)
or query_lower in item.get("domain", "").lower()):
results["items"].append({
"name": item_name,
"spec": item.get("spec", ""),
"kind": item.get("kind", ""),
"domain": item.get("domain", ""),
"introduced": item.get("introduced", ""),
})
# Search per-spec constants, type_aliases, endpoints
for spec_name, spec_data in self.specs.items():
for const_name, entry in spec_data.get("constants", {}).items():
if query_lower in const_name.lower() or query_norm in self._normalize(const_name):
results["constants"].append({
"name": const_name,
"spec": spec_name,
"value": entry.get("value", "") if isinstance(entry, dict) else "",
})
for alias_name, entry in spec_data.get("type_aliases", {}).items():
if query_lower in alias_name.lower() or query_norm in self._normalize(alias_name):
results["type_aliases"].append({
"name": alias_name,
"spec": spec_name,
"ssz_equivalent": entry.get("ssz_equivalent", "") if isinstance(entry, dict) else "",
})
for ep_key, ep in spec_data.get("endpoints", {}).items():
if (query_lower in ep.get("path", "").lower()
or query_lower in ep.get("summary", "").lower()
or query_lower in ep.get("operation_id", "").lower()
or query_norm in self._normalize(ep.get("path", ""))
or query_norm in self._normalize(ep.get("operation_id", ""))):
results["endpoints"].append({
"spec": spec_name,
"method": ep.get("method", ""),
"path": ep.get("path", ""),
"summary": ep.get("summary", ""),
})
# Trim
for key in results:
results[key] = results[key][:limit]
results["total"] = sum(len(v) for v in results.values())
return results
@staticmethod
def _normalize(s: str) -> str:
"""Normalize for matching."""
s = re.sub(r'([a-z])([A-Z])', r'\1_\2', s)
return s.lower().replace("_", "").replace("-", "")
def _fuzzy_match(self, query: str, candidates: list, limit: int = 5) -> list:
"""Simple subsequence fuzzy match."""
query_lower = query.lower()
scored = []
for name in candidates:
name_lower = name.lower()
if query_lower in name_lower:
pos = name_lower.index(query_lower)
score = (100 - pos) + (100 - abs(len(name) - len(query)))
scored.append((score, name))
else:
qi = 0
for c in name_lower:
if qi < len(query_lower) and c == query_lower[qi]:
qi += 1
if qi == len(query_lower):
scored.append((qi * 10, name))
scored.sort(reverse=True)
return [name for _, name in scored[:limit]]
# ── MCP Server ─────────────────────────────────────────────────────────────
def create_server(store: SpecStore, catalog_path: str, indexes_dir: Optional[str] = None, repos_dir: Optional[str] = None) -> Server:
"""Create the MCP server with all tool registrations."""
server = Server("ethspectoor")
@server.list_tools()
async def handle_list_tools() -> list[Tool]:
return [
Tool(
name="list_specs",
description="List all loaded Ethereum spec indexes with item counts, endpoint counts, and available forks.",
inputSchema={
"type": "object",
"properties": {},
},
),
Tool(
name="lookup_type",
description="Look up an Ethereum spec type, function, or container by name. Returns fields, code, source link, references, and EIP associations. Supports fuzzy matching.",
inputSchema={
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Type or function name (e.g., 'BuilderBid', 'process_block', 'BeaconState')",
},
"fork": {
"type": "string",
"description": "Optional fork to get definition at (e.g., 'electra', 'deneb'). Omit for latest.",
},
"spec": {
"type": "string",
"description": "Optional spec to search in (e.g., 'consensus-specs', 'builder-specs'). Omit to search all.",
},
},
"required": ["name"],
},
),
Tool(
name="lookup_endpoint",
description="Search Ethereum API endpoints by path, operation name, or keyword. Returns parameters, response types, SSZ support, and fork variants.",
inputSchema={
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "Search query -- path fragment (e.g., 'header', 'blinded_blocks'), operation ID (e.g., 'getHeader'), or keyword (e.g., 'validator', 'status')",
},
},
"required": ["query"],
},
),
Tool(
name="what_changed",
description="Show what types, functions, and constants were added or modified in a specific fork. Includes EIP associations.",
inputSchema={
"type": "object",
"properties": {
"fork": {
"type": "string",
"description": "Fork name (e.g., 'electra', 'deneb', 'fulu')",
},
"spec": {
"type": "string",
"description": "Optional: limit to a specific spec (e.g., 'builder-specs'). Omit for all specs.",
},
},
"required": ["fork"],
},
),
Tool(
name="trace_type",
description="Trace a type across spec boundaries. Shows where it's defined, who uses it, and cross-spec references. Essential for understanding data flow between protocol layers.",
inputSchema={
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Type name to trace (e.g., 'ExecutionPayloadHeader', 'SignedBuilderBid')",
},
},
"required": ["name"],
},
),
Tool(
name="search",
description="Fuzzy search across all Ethereum spec items, constants, type aliases, and endpoints.",
inputSchema={
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "Search query (e.g., 'blob', 'attestation', 'withdrawal', 'ssz')",
},
"limit": {
"type": "integer",
"description": "Max results per category (default: 20)",
},
},
"required": ["query"],
},
),
Tool(
name="diff_type",
description="Compare a type or function between two forks. Shows field additions, removals, and code changes.",
inputSchema={
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Type or function name",
},
"from_fork": {
"type": "string",
"description": "Earlier fork (e.g., 'deneb')",
},
"to_fork": {
"type": "string",
"description": "Later fork (e.g., 'electra')",
},
},
"required": ["name", "from_fork", "to_fork"],
},
),
Tool(
name="list_prs",
description="List indexed PR overlays. Shows PR number, title, author, and what changed. Use PR forks (e.g. 'pr-1234') in lookup_type, diff_type, and what_changed.",
inputSchema={
"type": "object",
"properties": {
"spec": {
"type": "string",
"description": "Optional: filter to a specific spec (e.g., 'consensus-specs').",
},
},
},
),
Tool(
name="index_pr",
description="Index a GitHub PR as a virtual fork. Fetches the branch, extracts spec changes, diffs against mainline, and makes it queryable via pr-NNNN fork syntax. After indexing, use lookup_type(fork='pr-NNNN'), diff_type(to_fork='pr-NNNN'), or what_changed(fork='pr-NNNN') to inspect the PR.",
inputSchema={
"type": "object",
"properties": {
"spec": {
"type": "string",
"description": "Spec name (e.g., 'consensus-specs', 'builder-specs').",
},
"pr": {
"type": "integer",
"description": "PR number to index.",
},
},
"required": ["spec", "pr"],
},
),
Tool(
name="reindex",
description="Rebuild spec indexes from source repos and reload. Requires repos directory to be configured.",
inputSchema={
"type": "object",
"properties": {
"specs": {
"type": "array",
"items": {"type": "string"},
"description": "Optional: list of specs to rebuild (e.g., ['builder-specs', 'consensus-specs']). Omit to rebuild all.",
},
},
},
),
]
@server.call_tool()
async def handle_call_tool(name: str, arguments: dict) -> list[TextContent]:
try:
if name == "list_specs":
result = store.specs_summary()
elif name == "lookup_type":
result = store.lookup_type(
name=arguments["name"],
fork=arguments.get("fork"),
spec=arguments.get("spec"),
)
elif name == "lookup_endpoint":
result = store.lookup_endpoint(arguments["query"])
elif name == "what_changed":
result = store.what_changed(
fork=arguments["fork"],
spec=arguments.get("spec"),
)
elif name == "trace_type":
result = store.trace_type(arguments["name"])
elif name == "search":
result = store.search(
query=arguments["query"],
limit=arguments.get("limit", 20),
)
elif name == "diff_type":
result = _diff_type(
store,
name=arguments["name"],
from_fork=arguments["from_fork"],
to_fork=arguments["to_fork"],
)
elif name == "list_prs":
result = store.list_pr_overlays(spec=arguments.get("spec", ""))
elif name == "index_pr":
result = await _index_pr(
store, catalog_path, indexes_dir, repos_dir,
spec=arguments["spec"],
pr_number=arguments["pr"],
)
elif name == "reindex":
result = await _reindex(
store, catalog_path, indexes_dir, repos_dir,
specs=arguments.get("specs"),
)
else:
result = {"error": f"Unknown tool: {name}"}
return [TextContent(type="text", text=json.dumps(result, indent=2))]
except Exception as e:
return [TextContent(type="text", text=json.dumps({"error": str(e)}))]
return server
def _diff_type(store: SpecStore, name: str, from_fork: str, to_fork: str) -> dict:
"""Compare a type between two forks (supports PR forks like 'pr-1234')."""
item = store.items.get(name)
if not item:
return {"error": f"Type '{name}' not found"}
forks = item.get("forks", {})
# Resolve PR forks
def resolve_fork_data(fork_name):
pr_num = store.parse_pr_fork(fork_name)
if pr_num is not None:
pr_item = store.resolve_pr_item(name, pr_num)
if pr_item:
return pr_item, True # (data, is_pr)
# Item not changed by PR -- use mainline at the PR's base fork
overlay = store.find_pr_overlay(pr_num)
base = overlay.get("base_ref", "") if overlay else ""
# Try to find the item at the latest mainline fork
if forks:
return forks.get(list(forks.keys())[-1], {}), False
return None, False
return forks.get(fork_name), False
from_data, from_is_pr = resolve_fork_data(from_fork)
to_data, to_is_pr = resolve_fork_data(to_fork)
if not from_data:
avail = list(forks.keys())
return {"error": f"'{name}' not found at fork '{from_fork}'", "available": avail}
if not to_data:
avail = list(forks.keys())
return {"error": f"'{name}' not found at fork '{to_fork}'", "available": avail}
result = {
"name": name,
"spec": item.get("spec", ""),
"from_fork": from_fork,
"to_fork": to_fork,
}
# Diff fields
from_fields = {f["name"]: f for f in from_data.get("fields", [])}
to_fields = {f["name"]: f for f in to_data.get("fields", [])}
added = [to_fields[f] for f in to_fields if f not in from_fields]
removed = [from_fields[f] for f in from_fields if f not in to_fields]
changed = []
for f in from_fields:
if f in to_fields and from_fields[f].get("type") != to_fields[f].get("type"):
changed.append({
"name": f,
"from_type": from_fields[f].get("type"),
"to_type": to_fields[f].get("type"),
})
if added or removed or changed:
result["fields_added"] = added
result["fields_removed"] = removed
result["fields_changed"] = changed
# Code diff -- resolve deduped code for both forks
fork_keys = list(forks.keys())
def resolve_code(fork_name, fork_data, is_pr):
# PR data or direct data always has full code
code = fork_data.get("code", "")
if code:
return code
if is_pr:
return ""
# Mainline dedup: walk backwards through forks
idx = fork_keys.index(fork_name) if fork_name in fork_keys else -1
for i in range(idx - 1, -1, -1):
prev = forks[fork_keys[i]].get("code", "")
if prev:
return prev
return ""
from_code = resolve_code(from_fork, from_data, from_is_pr)
to_code = resolve_code(to_fork, to_data, to_is_pr)
if from_code != to_code:
result["code_changed"] = True
result["from_code"] = from_code
result["to_code"] = to_code
else:
result["code_changed"] = False
# Source links
result["from_url"] = from_data.get("github_url", "")
result["to_url"] = to_data.get("github_url", "")
return result
async def _index_pr(store: SpecStore, catalog_path: str, indexes_dir: Optional[str],
repos_dir: Optional[str], spec: str, pr_number: int) -> dict:
"""Index a single PR: fetch, extract, diff, rebuild catalog, reload."""
if not repos_dir:
return {"error": "No repos directory configured. Start server with --repos-dir."}
if not indexes_dir:
return {"error": "No indexes directory configured."}
base_dir = Path(__file__).parent
pr_script = str(base_dir / "pr_index.py")
catalog_script = str(base_dir / "build_catalog.py")
if spec not in SPEC_REPO_MAP:
return {"error": f"Unknown spec: {spec}. Available: {', '.join(SPEC_REPO_MAP.keys())}"}
repo_path = os.path.join(repos_dir, SPEC_REPO_MAP[spec])
if not os.path.isdir(repo_path):
return {"error": f"Repo not found: {repo_path}"}
result = {}
# Step 1: Run pr_index.py
token = os.environ.get("GITHUB_TOKEN", "")
cmd = [
sys.executable, pr_script,
"--spec", spec,
"--repo-dir", repo_path,
"--indexes-dir", indexes_dir,
"--pr", str(pr_number),
]
if token:
cmd.extend(["--github-token", token])
try:
proc = await asyncio.create_subprocess_exec(
*cmd, stdout=asyncio.subprocess.PIPE, stderr=asyncio.subprocess.PIPE,
)
_, stderr = await proc.communicate()
stderr_text = stderr.decode()
if proc.returncode == 0:
result["index"] = {"status": "ok", "output": stderr_text[-500:]}
else:
return {"error": f"pr_index.py failed: {stderr_text[-500:]}"}
except Exception as e:
return {"error": f"pr_index.py error: {str(e)}"}
# Step 2: Rebuild catalog with PR overlays
catalog_cmd = [
sys.executable, catalog_script,
"--indexes-dir", indexes_dir,
"--output", catalog_path,
"--include-prs",
]
try:
proc = await asyncio.create_subprocess_exec(
*catalog_cmd, stdout=asyncio.subprocess.PIPE, stderr=asyncio.subprocess.PIPE,
)
await proc.communicate()
result["catalog"] = {"status": "ok" if proc.returncode == 0 else "error"}
except Exception as e:
result["catalog"] = {"status": "error", "message": str(e)}
# Step 3: Reload
store.load(catalog_path)
result["reload"] = {"status": "ok", "items": len(store.items)}
# Step 4: Return a summary of what the PR changes
overlay = store.find_pr_overlay(pr_number)
if overlay:
items_changed = overlay.get("items_changed", {})
result["pr"] = {
"number": pr_number,
"title": overlay.get("title", ""),
"author": overlay.get("author", ""),
"items_changed": len(items_changed),
"summary": {
name: info.get("diff_summary", {})
for name, info in list(items_changed.items())[:10]
},
}
if len(items_changed) > 10:
result["pr"]["summary"]["..."] = f"and {len(items_changed) - 10} more"
else:
result["pr"] = {"number": pr_number, "items_changed": 0, "note": "No spec changes detected"}
return result
async def _reindex(store: SpecStore, catalog_path: str, indexes_dir: Optional[str],
repos_dir: Optional[str], specs: Optional[list] = None) -> dict:
"""Rebuild indexes, rebuild catalog, and reload."""
if not repos_dir:
return {"error": "No repos directory configured. Start server with --repos-dir."}
if not indexes_dir:
return {"error": "No indexes directory configured. Start server with --indexes-dir."}
base_dir = Path(__file__).parent
build_script = str(base_dir / "build.py")
link_script = str(base_dir / "link.py")
catalog_script = str(base_dir / "build_catalog.py")
spec_branches = {
"consensus-specs": "dev",
}
specs_to_build = specs or list(SPEC_REPO_MAP.keys())
results = {}
for spec_name in specs_to_build:
if spec_name not in SPEC_REPO_MAP:
results[spec_name] = {"status": "error", "message": f"Unknown spec: {spec_name}"}
continue
repo_path = os.path.join(repos_dir, SPEC_REPO_MAP[spec_name])
if not os.path.isdir(repo_path):
results[spec_name] = {"status": "error", "message": f"Repo not found: {repo_path}"}
continue
branch = spec_branches.get(spec_name, "main")
cmd = [
sys.executable, build_script,
"--profile", spec_name,
"--repo-dir", repo_path,
"--output-dir", indexes_dir,
"--branch", branch,
]
try:
proc = await asyncio.create_subprocess_exec(
*cmd, stdout=asyncio.subprocess.PIPE, stderr=asyncio.subprocess.PIPE,
)
_, stderr = await proc.communicate()
if proc.returncode == 0:
results[spec_name] = {"status": "ok"}
else:
results[spec_name] = {"status": "error", "message": stderr.decode()[-500:]}
except Exception as e:
results[spec_name] = {"status": "error", "message": str(e)}