Set Schematic Component Property
set_schematic_component_propertyAdd or update a single custom property (e.g., MPN, DigiKey_PN, Voltage) on a schematic component in a .kicad_sch file. Create the property if it doesn't exist or overwrite the existing value.
Instructions
Add or update a single custom property on a placed schematic symbol.
This is a focused convenience wrapper around edit_schematic_component for the very common case of attaching one BOM / sourcing field at a time. The property is created if it does not already exist on the component.
Typical custom properties: • MPN, Manufacturer, Manufacturer_PN — manufacturer part number metadata • DigiKey, DigiKey_PN, Mouser_PN, LCSC, JLCPCB_PN — distributor part numbers • Voltage, Tolerance, Power, Dielectric, Temperature_Coefficient — passive parameters • Description, Notes — free-form documentation • Any custom field your BOM exporter expects.
These properties are written into the .kicad_sch file as standard KiCad property records, are exported by export_bom, and are picked up by the JLCPCB and Digi-Key sourcing tools. Newly-created properties default to hidden — set hide=false to display the value on the schematic canvas.
For batch updates of multiple properties at once, use edit_schematic_component
with the properties parameter instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| x | No | Label X position in mm (default: component X) | |
| y | No | Label Y position in mm (default: component Y) | |
| hide | No | Hide the property text on the schematic canvas. Defaults to true for newly-created custom properties. | |
| name | Yes | Property name (e.g. 'MPN', 'Manufacturer', 'DigiKey_PN', 'Voltage', 'Dielectric') | |
| angle | No | Label rotation in degrees (default: 0) | |
| value | Yes | Property value to write (use empty string to clear) | |
| justify | No | Text justification for the property label. KiCad alignment keywords: "left", "right", "center", "top", "bottom", or combined e.g. "left top". Omit to leave unchanged. Pass "center" to reset to the KiCad default. | |
| fontSize | No | Font size in mm for the label (default: 1.27) | |
| reference | Yes | Reference designator of the component (e.g. R1, U3) | |
| schematicPath | Yes | Path to the .kicad_sch file |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |