Skip to main content
Glama

lib_get_vault_component

Verify whether a managed Workspace component can be placed without placing it by probing its Design Item ID and reporting library path, lifecycle state, revisions, and placement parameters.

Instructions

Check one managed (Workspace) component can be placed, without placing it.

Loads the item the way sch_place_vault_components would, reads its identity, and throws it away again; nothing reaches a sheet. The kind asked for is tried first, then the others. The library manager's lookups (library path, lifecycle state, revisions, placement parameters) are reported alongside, as they come back. A part number is not looked up here, so bring the Design Item ID.

Args: design_item_id: The component's Design Item ID. vault: The Workspace name. Usually left out; see lib_get_vault_name. lib_identifier_kind: Altium's TLibIdentifierKind, tried first: 0 Any, 1 NameNoType, 2 NameWithType, 3 FullPath, 4 VaultName (the default). A managed part Altium placed shows the kind and identifier that work, through obj_query on eSchComponent.

Returns: placeable, loader_callable, lib_identifier_kind (the kind that loaded, -1 if none), load_probe (kind:result for each try), the loaded loaded_design_item_id, vault_guid, item_guid and revision_guid, then library_path, display_path, lifecycle_state, has_revisions, revisions, placement_parameters, note and diag (library manager calls that raised).

Input Schema

NameRequiredDescriptionDefault
vaultNo
design_item_idYes
lib_identifier_kindNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations, so the description carries the full burden and does well: it discloses the load-then-discard behavior ('nothing reaches a sheet'), the multi-kind retry order with the default kind, and that library-manager failures are surfaced in diag rather than swallowed. It does not mention permissions, latency of repeated load attempts, or what placeable=false means concretely.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core behavior, then Args and Returns in a clean structure. The prose is a little discursive ('Loads the item ... and throws it away again') and the Returns block largely restates the output schema, but nothing is filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, yet the description still lists the return keys, which is slightly redundant but helps an agent know that placeable/load_probe/diag are the decision-relevant fields. Combined with full parameter coverage and side-effect disclosure, an agent has what it needs to invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description must compensate and does: design_item_id is identified as the required Design Item ID, vault is explained as usually omitted with a pointer to lib_get_vault_name, and lib_identifier_kind is fully enumerated (0 Any through 4 VaultName default) with a tip on discovering the right kind via obj_query.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource: probe whether one managed Workspace component can be placed, explicitly without placing it. It names the sibling it mimics (sch_place_vault_components) and the one it is not (lib_find_vault_components / lib_get_component_details), so an agent can distinguish it immediately.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Clear context: use it to verify placeability without a sheet mutation, and the note 'A part number is not looked up here, so bring the Design Item ID' steers agents away from a wrong input. It also points to lib_get_vault_name and obj_query for supporting lookups. No explicit when-not-to-use against lib_get_component_details, so not a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools