Skip to main content
Glama

altium_script_template

Returns ready-made DelphiScript templates for Altium Designer to export a BOM to CSV or generate PCB statistics as a text file.

Instructions

[Altium Designer: schematic capture, PCB layout/routing, stackups, fabrication outputs] Return ready-made DelphiScript: template 'export_bom' (project_path, output_file .csv) or 'pcb_stats' (output_file .txt).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
templateYes
output_fileNo
project_pathNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It says it 'Returns' a script, yet a parameter is named 'output_file' and there is no indication whether the tool writes a file to disk, mutates anything, or merely returns text with the path substituted in. Permissions and side effects are undisclosed.

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?

A single efficient sentence front-loads the purpose, followed by the template branch details. The bracketed domain tag adds context without bloat, though the information is densely packed.

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

Completeness3/5

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

An output schema exists, so return format need not be explained, and the template options are covered. However the behavioral gap around whether output_file triggers file writing leaves the agent under-informed for a no-annotation tool.

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

Parameters4/5

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

Schema description coverage is 0%, so the description must compensate, and it does well: it maps 'export_bom' to (project_path, output_file .csv) and 'pcb_stats' to (output_file .txt), revealing the valid template values, which parameters apply to each, and expected file extensions. It still leaves the exact string values and the output_file file-vs-name semantics unstated.

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 and resource: 'Return ready-made DelphiScript' templates, and enumerates the two available templates ('export_bom', 'pcb_stats'). The bracketed domain tag clarifies it is the Altium Designer tool, distinguishing it from the analogous feko_lua_template sibling.

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

Usage Guidelines3/5

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

The description presents the two template choices and their parameters, implying when each is used, but gives no explicit when-to-use/when-not guidance and never names a sibling. Usage is inferable from the template list rather than stated.

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