1.3 KiB
1.3 KiB
type, title, description, tags, timestamp
| type | title | description | tags | timestamp | ||||
|---|---|---|---|---|---|---|---|---|
| Guide | Node Metadata Extraction Tool | Documentation for the Sage Utils node metadata extraction tool. |
|
2026-07-01T00:00:00Z |
Node Metadata Extraction Tool
This tool extracts Sage Utils node metadata from the existing nodes/ implementation.
Purpose
The tool provides a structured view of Sage Utils nodes for documentation generation and node reference purposes.
What it returns
Each node record includes:
node_iddisplay_namedescriptioncategoryinputswithname,type, anddescriptionoutputswithname,type, anddescription
Implementation notes
- The tool reads
NODE_LISTfromnodes_v3.py. - It calls
define_schema()on each node class. - It normalizes the returned
io.Schemaobject. - It is intentionally separated from OKF documentation: the code lives in
tools/, while documentation lives inokf/tools/.
Planned API
list_nodes()— returns a shallow list of node IDs and display names.get_node_metadata(node_ids=None)— returns full metadata for requested nodes or all nodes ifnode_idsis omitted.
Usage
The tool will be useful for generating documentation skeletons, auditing node I/O, and creating an index of Sage Utils nodes.