Skip to main content
Glama

params

Read-onlyIdempotent

Retrieves a plugin's automatable parameter indexes, names, and normalized value meanings, enabling correct knob selection before writing automation.

Instructions

A plugin's automatable parameters, for writing automation: each one's index (the param of an automation target {channel: id, param: index} or {mixer: t, slot: s, param: index}), its name, and what its normalised value means where measured (FL's display at 0, .25, .5, .75 and 1, so a value can be picked for a wanted Hz, dB or %). Call it before automating a plugin or effect knob. It answers only for plugins with a parameter map (plugins shows which); for any other, read names live with fl_call('plugins.getParamName', ...). Not for choosing a sound: plugins lists what is installed, presets a plugin's presets. Reads files only; FL need not run.

Input Schema

NameRequiredDescriptionDefault
kindNo'instrument' or 'effect', for a name that is both; without it the instrument is taken
queryNowords that must all appear in the parameter name, case-insensitive, e.g. 'filter cutoff'
pluginYesthe plugin's name as plugins lists it; a unique part of it works

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.4.5
    • changedInput schema / properties / query / anyOf
      Previous value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
  2. Changed1 schema field changedv0.4.0
    • addedInput schema / properties / kind
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "'instrument' or 'effect', for a name that is both; without it the instrument is taken",
      +  "title": "Kind"
      +}
  3. Changed2 schema fields changedv0.2.1
    • addedInput schema / properties / plugin / description
      Added value: +"the plugin's name as plugins lists it; a unique part of it works"
    • addedInput schema / properties / query / description
      Added value: +"words that must all appear in the parameter name, case-insensitive, e.g. 'filter cutoff'"
  4. First observedv0.2.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already cover safety (readOnly, idempotent, non-destructive), and the description adds beyond them: it only answers for plugins with a parameter map (a real coverage limitation) and that it 'reads files only; FL need not run', telling the agent it works without a live session.

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 purpose and output meaning, then routing and caveats. Dense but every sentence carries information; the long nested automation-target parenthetical is the only heavy patch.

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?

No output schema exists, so the description must explain returns — and it does: index usable as an automation target, name, and the normalised-value display at 0/.25/.5/.75/1 so a value can be chosen for a target Hz, dB or %. Nothing needed to call it correctly is missing.

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

Parameters3/5

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

Schema coverage is 100% and the schema already documents 'kind' (instrument/effect disambiguation), 'query' (case-insensitive all-words match), and 'plugin' (name from plugins). The description adds little parameter-level detail beyond implying that names are matched against the plugin's list; baseline 3 is appropriate.

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: it returns a plugin's automatable parameters, each with its index, name, and what its normalised value means. It explicitly distinguishes itself from 'plugins' (lists what's installed), 'presets' (a plugin's presets), and fl_call('plugins.getParamName', ...) for plugins without a parameter map.

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

Usage Guidelines5/5

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

Gives an explicit trigger ('Call it before automating a plugin or effect knob') and explicit non-uses ('Not for choosing a sound: plugins lists what is installed, presets a plugin's presets'), plus the fallback route for plugins lacking a parameter map.

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