Skip to main content
Glama

get_fx_preset

Read-only

Retrieve which REAPER host preset is currently loaded on a specified FX, returning its name and validity for the selected track.

Instructions

Read-only: report which REAPER host preset is loaded on one FX. Pick the track with one track selector and the FX with one FX selector (fx_guid, else fx_index + fx_scope, else fx_name_contains). Returns {name, valid, index, count, scope}; valid is false when the plugin reports no named preset. Only sees REAPER host presets, not a plugin's own preset browser. Errors: NO_FX / AMBIGUOUS_FX / AMBIGUOUS_SCOPE / NO_FX_SELECTOR, NO_TARGET_TRACK / AMBIGUOUS_TARGET_TRACK. Use set_fx_preset to change it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
trackNoExact track name (case-insensitive); "master" targets the master track. Used when no GUID is given; errors if two tracks share the name.
fx_guidNoStable FX GUID; wins over fx_index and fx_name_contains.
fx_indexNo0-based position in the chain; requires fx_scope "track" or "input". Used when no fx_guid is given.
fx_scopeNoWhich chain to search: "track" (normal FX), "input" (record-input FX) or "all" (default for GUID and name searches).
track_containsNoCase-insensitive substring; used only when no GUID or exact name is given. Errors if it matches more than one track.
fx_name_containsNoCase-insensitive FX name substring; used only when neither fx_guid nor fx_index is given. Errors if it matches more than one FX.
target_track_guidNoStable REAPER track GUID; preferred when available. Wins over every other track selector.
use_selected_trackNoTarget the first selected track; ignored when any other track selector is given. Errors if nothing is selected.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv3.21.0
    • removedInput schema / properties / dry_run
      Removed value: -{
      -  "description": "Preview: return what would run without changing the project.",
      -  "type": "boolean"
      -}
    • addedInput schema / properties / fx_guid / description
      Added value: +"Stable FX GUID; wins over fx_index and fx_name_contains."
    • addedInput schema / properties / fx_index / description
      Added value: +"0-based position in the chain; requires fx_scope \"track\" or \"input\". Used when no fx_guid is given."
    • addedInput schema / properties / fx_name_contains / description
      Added value: +"Case-insensitive FX name substring; used only when neither fx_guid nor fx_index is given. Errors if it matches more than one FX."
    • addedInput schema / properties / fx_scope / description
      Added value: +"Which chain to search: \"track\" (normal FX), \"input\" (record-input FX) or \"all\" (default for GUID and name searches)."
    • addedInput schema / properties / fx_scope / enum
      Added value: +[
      +  "all",
      +  "track",
      +  "input"
      +]
    • changedInput schema / properties / target_track_guid / description
      Previous value: -"Stable REAPER track GUID; preferred when available."New value: +"Stable REAPER track GUID; preferred when available. Wins over every other track selector."
    • changedInput schema / properties / track / description
      Previous value: -"Exact track name (case-insensitive)."New value: +"Exact track name (case-insensitive); \"master\" targets the master track. Used when no GUID is given; errors if two tracks share the name."
    • changedInput schema / properties / track_contains / description
      Previous value: -"Case-insensitive substring; errors if it matches more than one track."New value: +"Case-insensitive substring; used only when no GUID or exact name is given. Errors if it matches more than one track."
    • changedInput schema / properties / use_selected_track / description
      Previous value: -"Target the currently selected track instead of naming one."New value: +"Target the first selected track; ignored when any other track selector is given. Errors if nothing is selected."
  2. First observedv0.1.0

TDQS

A4.9/5.0
Behavior5/5

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

The description goes far beyond the readOnlyHint annotation: it discloses the exact return shape ({name, valid, index, count, scope}), the semantics of `valid` when no named preset exists, the selector fallback order, and the complete list of error codes. This level of behavioral detail is exemplary and removes guesswork for the agent.

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?

Every sentence carries essential information: the operation, selector rules, return contract, domain boundary, errors, and the sibling write tool. There is no filler or repetition; the description is dense yet immediately scannable with a front-loaded purpose 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?

Given 8 parameters, 0 required, and no output schema, the description covers all essential context: how to disambiguate track/FX selection, what the response contains, when `valid` is false, which error conditions to expect, and the limitation to host presets. An agent can invoke this tool correctly and interpret its result without needing additional help.

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?

The input schema already documents all parameters at 100% coverage, so the baseline is 3. The description adds value by consolidating the selector precedence ('fx_guid, else fx_index + fx_scope, else fx_name_contains') and by tying parameters to the returned `scope` field, which gives a working model of how the parameters interact rather than just enumerating them.

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?

The description opens with a specific verb-resource pair ('Read-only: report which REAPER host preset is loaded on one FX') and clearly scopes the tool to a single FX. It even distinguishes itself from plugin-preset browsers and names the sibling set_fx_preset for the write counterpart, making the purpose unmistakable.

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?

It says when to use it (read-only reporting), gives explicit selector precedence for both track and FX, and names the alternative tool for mutation ('Use set_fx_preset to change it'). It also states a boundary condition ('Only sees REAPER host presets, not a plugin's own preset browser'), which helps an agent decide whether this tool is appropriate.

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