lib_get_component_details
Retrieves complete details for one library component in a single call: metadata, all pins, parameters, models, and label style records. Use it to inspect symbols before wiring or footprint placement.
Instructions
Get full inspection of one library component in a single call.
Returns metadata, every pin, every parameter (as a flat dict),
AND visual-style records for the designator, comment, pins,
and each parameter (font_id, color, is_hidden, x, y,
orientation, justification). The integer font_id can be
expanded to {name, size, bold, italic} via obj_get_font_spec
when style detail is needed; the round-trip default keeps it
compact.
If library_path is provided and isn't already focused, the
library is opened (focus changes), so the next lib_* call
operates on it without an explicit open. Saves are deferred,
opening doesn't write anything to disk.
DATASHEET DISCIPLINE: This response is the highest-density
device-fact surface in the library API (pins, parameters,
Manufacturer/MPN). Treat every value as a hint to find the
manufacturer datasheet, not as ground truth. The response
carries _datasheet_guidance and _datasheet_parts, fetch
the PDF and cite a section/page before stating any pin or
rating.
Args:
component_name: Component LibRef as it appears in the .SchLib.
library_path: Optional .SchLib full path. When omitted the
currently focused library is used.
component_index: Alternative to component_name. The integer
index from lib_get_components. Use this to reach a
component whose LibReference carries bytes you cannot
reproduce (an embedded double-quote, or a control char
left by a broken import) -- the name never has to round
trip through the caller. Provide exactly one of
component_name / component_index.
Returns:
Dict with:
- name, library_path, description, alias_name,
part_count, pin_count
- designator: {text, font_id, color, is_hidden, x, y,
orientation, justification} - the on-canvas designator
label (NOT just the prefix string).
- comment: {text, font_id, color, is_hidden, x, y,
orientation, justification} - the on-canvas comment /
value label.
- pins: list of {designator, name, electrical_type, x, y,
orientation, hidden, label_hidden}. Pin font / color
are not exposed by the Altium SDK on ISch_Pin and
therefore not surfaced here.
- parameters: flat dict of name -> value (cheap lookups).
- parameter_styles: list of {name, value, style:{font_id,
color, is_hidden, x, y, orientation, justification}}
in the same order parameters appear on the symbol.
- models: list of the component's implementations (footprint
/ SPICE / 3D links), each {model_name, model_type,
is_current, datafile_links:[{entity_name, file_kind,
location}]}. datafile_links is the model's source (the
library it resolves from); empty when the footprint binds
by name only. Empty list when the part carries no models.
- _datasheet_guidance + _datasheet_parts.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| library_path | No | ||
| component_name | No | ||
| component_index | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||