Skip to main content
Glama

altium_delete_parameter

DestructiveIdempotent

Deletes a named parameter from specified Altium components, or from all components that have it when designators are omitted. Preview changes by default; set apply=true to write them.

Instructions

Delete a parameter from the given components, or from every component that has it when designators is omitted (at most 500). Old values are shown in the preview. apply=false (default) only previews and never touches Altium; apply=true writes. Edits stay in memory: the document is left modified but NOT saved, and Ctrl+Z in Altium undoes them. Requires the server to be in read_write mode.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>"
    },
    "name": "altium_delete_parameter"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
applyNo
designatorsNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.7/5.0
Behavior5/5

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

Goes well beyond the annotations (destructive/idempotent/not-readOnly) by disclosing that edits stay in memory, the document is left modified but not saved, Ctrl+Z in Altium undoes them, the old values appear in the preview, and read_write server mode is required. These are exactly the non-obvious side effects an agent needs before invoking a destructive write.

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

Conciseness5/5

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

Four tight sentences, each carrying distinct information (scope, preview contents, apply semantics, memory/save/undo behavior, environment prerequisite), with the most important destructive caveat front-loaded alongside the scope statement.

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

Completeness5/5

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

Covers scope, defaults, destructive side effects, persistence (not saved), undo path, and the read_write mode prerequisite; return-value detail is delegated appropriately to the existing output schema, which the description references via the preview's old values.

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?

With 0% schema description coverage the description must carry the load, and it does: apply's preview-vs-write semantics and default, designators' scope-widening behavior and 500 cap, and the role of name as the parameter to remove are all conveyed. Only 'name' itself is left implicit rather than explicitly defined.

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 ('Delete a parameter') plus the exact scope of the operation (given components, or all components containing it when designators is omitted). This clearly separates it from siblings like altium_set_parameter and altium_rename_parameter without requiring the schema to be opened.

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?

Gives clear operational guidance: apply=false (default) previews and never touches Altium, apply=true writes, and designators omission widens the scope to all matching components. It does not explicitly contrast against sibling tools (e.g., when to prefer rename vs. delete-and-set), so it falls short of a 5.

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