Skip to content

Commit 179e643

Browse files
committed
README: annotate each tool with field origin (extraction / LLM / metadata)
1 parent 86d5a8e commit 179e643

1 file changed

Lines changed: 28 additions & 22 deletions

File tree

README.md

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -54,28 +54,34 @@ Key environment variables:
5454

5555
Data comes from the vtk-knowledge artifact; the query helpers are implemented in vtk-validate's tool layer.
5656

57-
| Tool | Description |
58-
|---|---|
59-
| `vtk_get_class_info(class_name)` | Full class record (all fields below as one call) |
60-
| `vtk_search_classes(query, limit)` | Search classes by name or keyword |
61-
| `vtk_get_class_doc(class_name)` | Docstring for a class |
62-
| `vtk_get_class_synopsis(class_name)` | One-sentence synopsis |
63-
| `vtk_get_class_role(class_name)` | Pipeline role (`source` / `filter` / `mapper` / …) |
64-
| `vtk_get_class_input_datatype(class_name)` | Expected input data type |
65-
| `vtk_get_class_output_datatype(class_name)` | Produced output data type |
66-
| `vtk_get_class_methods(class_name)` | All methods with signatures |
67-
| `vtk_get_class_semantic_methods(class_name)` | Non-boilerplate callable methods |
68-
| `vtk_get_method_info(class_name, method_name)` | Full method record |
69-
| `vtk_get_method_doc(class_name, method_name)` | Method docstring |
70-
| `vtk_get_method_signature(class_name, method_name)` | Canonical method signature |
71-
| `vtk_get_class_module(class_name)` | `vtkmodules.*` import path |
72-
| `vtk_get_module_classes(module)` | All classes in a module |
73-
| `vtk_is_a_class(class_name)` | Check if a name is a valid VTK class |
74-
| `vtk_get_class_action_phrase(class_name)` | Action phrase (e.g. "mesh smoothing") |
75-
| `vtk_get_class_visibility(class_name)` | Visibility score 0.0–1.0 |
76-
| `vtk_get_class_inheritance(class_name)` | Full MRO chain |
77-
| `vtk_get_class_record_metadata(class_name)` | `{vtk_version, schema_version, content_hash}` |
78-
| `vtk_version_info()` | VTK version and enabled features for the loaded index |
57+
Each field in `VTKDocRecord` has one of three origins:
58+
59+
- **extraction** — parsed directly from the VTK Python runtime (`help()`, introspection, MRO)
60+
- **LLM** — generated by an LLM enrichment pass during artifact build
61+
- **metadata** — versioning and integrity fields added at build time
62+
63+
| Tool | Field(s) | Origin |
64+
|---|---|---|
65+
| `vtk_get_class_info(class_name)` | all fields | — (convenience: full record) |
66+
| `vtk_search_classes(query, limit)` | `class_name`, `module_name`, `synopsis` ||
67+
| `vtk_get_class_doc(class_name)` | `class_doc` | extraction |
68+
| `vtk_get_class_methods(class_name)` | `methods` (name, signatures, doc) | extraction |
69+
| `vtk_get_method_info(class_name, method_name)` | single `VTKMethod` | extraction |
70+
| `vtk_get_method_doc(class_name, method_name)` | `method.doc` | extraction |
71+
| `vtk_get_method_signature(class_name, method_name)` | `method.signatures[0]` | extraction |
72+
| `vtk_get_class_inheritance(class_name)` | `inheritance` (full MRO chain) | extraction |
73+
| `vtk_get_class_role(class_name)` | `role` (`source`, `filter`, `mapper`, `renderer`, `scene`, …) | extraction |
74+
| `vtk_get_class_input_datatype(class_name)` | `input_datatype` | extraction |
75+
| `vtk_get_class_output_datatype(class_name)` | `output_datatype` | extraction |
76+
| `vtk_get_class_module(class_name)` | `module_name` (`vtkmodules.*` path) | extraction |
77+
| `vtk_get_module_classes(module)` | all `class_name`s in a module | extraction |
78+
| `vtk_get_class_semantic_methods(class_name)` | `semantic_methods` (non-inherited) | extraction |
79+
| `vtk_is_a_class(class_name)` | membership check ||
80+
| `vtk_get_class_synopsis(class_name)` | `synopsis` (one sentence, ≤20 words) | LLM |
81+
| `vtk_get_class_action_phrase(class_name)` | `action_phrase` (noun phrase, ≤5 words) | LLM |
82+
| `vtk_get_class_visibility(class_name)` | `visibility_score` (0.0–1.0) | LLM |
83+
| `vtk_get_class_record_metadata(class_name)` | `vtk_version`, `schema_version`, `content_hash` | metadata |
84+
| `vtk_version_info()` | index-level `vtk_version`, class count, feature flags | metadata |
7985

8086
### Semantic search — via [vtk-index](https://github.com/vicentebolea/vtk-index)
8187

0 commit comments

Comments
 (0)