Node Validator¶
akms.tools.node_validator
¶
AKMS Node Validator — validate drafted .md node files against the v2 schema.
Usage
Validate a single file¶
python validate_nodes.py path/to/node.md
Validate all .md files in a directory¶
python validate_nodes.py path/to/nodes/
Validate with cross-reference checking against known inventory¶
python validate_nodes.py path/to/nodes/ --inventory inventory.json [inventory2.json ...]
Validate a raw NotebookLM output file (multiple nodes separated by ═══ FILE: ... ═══)¶
python validate_nodes.py --raw-batch output.txt --split-dir ./split_nodes/
Strict mode: treat warnings as errors¶
python validate_nodes.py path/to/nodes/ --strict
Quiet mode: only show errors¶
python validate_nodes.py path/to/nodes/ --quiet
JSON output to stdout (for CI / MCP tool consumption)¶
python validate_nodes.py path/to/nodes/ --json
JSON output to file¶
python validate_nodes.py path/to/nodes/ -o report.json
Auto-fix mechanical issues (schema version, experiential fields, etc.)¶
python validate_nodes.py path/to/nodes/ --fix
Preview fixes without writing¶
python validate_nodes.py path/to/nodes/ --fix --dry-run
Fix, then re-validate to confirm clean output¶
python validate_nodes.py path/to/nodes/ --fix --revalidate
Rename files to match node ids (separate from --fix)¶
python validate_nodes.py path/to/nodes/ --fix-filenames
Issue
¶
Bases: BaseModel
A single validation issue.
EdgeModel
¶
Bases: BaseModel
Schema for a single structural edge.
Mirrors akms.schema.models.StructuralEdge but without extra="forbid", so that unknown edge fields produce warnings rather than hard errors.
NodeFrontmatter
¶
Bases: BaseModel
Full schema for an AKMS v2 global or local node frontmatter.
Mirrors akms.schema.models.GlobalNodeFrontmatter for field names and types.
IMPORTANT: Unlike GlobalNodeFrontmatter, this model deliberately does NOT
use model_config = {"extra": "forbid"}. Unknown fields are instead
detected by validate_frontmatter() and surfaced as WARNING-level issues
rather than hard Pydantic errors. This graduated feedback is the whole
point of the validator — do NOT add extra="forbid" here.
parse_md_file
¶
Parse a .md file into (frontmatter_dict, body_text, parse_issues).
Uses the python-frontmatter library (same as schema/validators.py)
for robust YAML extraction — handles BOM, leading whitespace, and edge
cases that the previous hand-rolled regex could miss.
Returns (None, "", issues) if the file cannot be parsed.
Source code in packages/akms/src/akms/tools/node_validator.py
split_raw_batch
¶
Split a raw NotebookLM batch output into (filename, content) pairs. Expects separator lines like: ═══ FILE: node-id.md ═══
Source code in packages/akms/src/akms/tools/node_validator.py
validate_frontmatter
¶
validate_frontmatter(
fm: dict[str, Any],
body: str,
known_ids: set[str] | None = None,
) -> tuple[NodeFrontmatter | None, list[Issue]]
Validate a parsed frontmatter dict against the AKMS v2 schema. Returns (parsed_model_or_None, issues).
Source code in packages/akms/src/akms/tools/node_validator.py
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 | |
validate_body
¶
Check markdown body for required/recommended sections.
Source code in packages/akms/src/akms/tools/node_validator.py
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 | |
check_batch_consistency
¶
check_batch_consistency(
results: dict[
str, tuple[NodeFrontmatter | None, list[Issue]]
],
) -> list[Issue]
Cross-file checks: duplicate ids, orphaned within-batch edge targets, etc.
Source code in packages/akms/src/akms/tools/node_validator.py
load_known_ids
¶
Load known node ids from inventory JSON files and/or existing .md files.
Source code in packages/akms/src/akms/tools/node_validator.py
print_report
¶
print_report(
results: dict[
str, tuple[NodeFrontmatter | None, list[Issue]]
],
batch_issues: list[Issue],
quiet: bool = False,
use_color: bool = True,
) -> tuple[int, int, int]
Print the full validation report. Returns (error_count, warning_count, info_count).
Source code in packages/akms/src/akms/tools/node_validator.py
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 | |
build_json_report
¶
build_json_report(
results: dict[
str, tuple[NodeFrontmatter | None, list[Issue]]
],
batch_issues: list[Issue],
) -> dict[str, Any]
Build a machine-readable JSON report from validation results.
The output schema is stable and suitable for CI pipelines and MCP tools.
Source code in packages/akms/src/akms/tools/node_validator.py
apply_fixes
¶
Apply deterministic auto-corrections to a node file.
Returns a list of human-readable change descriptions.
Does NOT write to disk if dry_run=True.
Auto-fixable issues (no human judgment needed):
- akms_schema missing or != v2 → set to v2
- Experiential fields in frontmatter → strip them
- source: generated → change to hybrid
- Trailing whitespace in id or edge to → strip
- Duplicate tags → deduplicate (preserve order)
- Missing note on edges → set to ""
Source code in packages/akms/src/akms/tools/node_validator.py
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 1001 1002 | |
fix_filenames
¶
fix_filenames(
results: dict[
str, tuple[NodeFrontmatter | None, list[Issue]]
],
dry_run: bool = False,
) -> list[tuple[str, str]]
Rename files to match their node id.
Returns list of (old_path, new_path) pairs.
Separated from apply_fixes because renames change file paths
and would confuse batch tracking if mixed with content fixes.