Skip to main content
Glama

Read plugin settings

AccountPluginSettingsReadTool
Read-onlyIdempotent

The account's plugin instances (plugin settings): list and inspect them, and read their data, logs, merge variables, a private plugin's files and the timeline of when each device shows them.

  • listPluginSettings: List my plugin settings — params: plugin_id (query)

  • getPluginSettingDetails: Get plugin setting details — params: id (path)

  • getPluginSettingData: Get the data of a native plugin setting; a private plugin reads through getMergeVariables — params: id (path)

  • getPluginSettingLogs: Read plugin instance health and recent logs — params: plugin_setting_id (path), level (query), limit (query)

  • getPluginSettingTimeline: Read a plugin setting timeline — params: plugin_setting_id (path), date (query)

  • getMergeVariables: Read the merge variables a plugin instance renders from — params: plugin_setting_id (path)

  • getPluginSettingFiles: Read the files of a private plugin — params: plugin_setting_id (path)

Input Schema

NameRequiredDescriptionDefault
actionYesThe API operation to run
paramsNoThe operation's path, query and body parameters by name

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds one genuine behavioral nuance — getPluginSettingData serves native plugins while private plugins must use getMergeVariables — but says nothing about authorization scope, pagination, or result shape.

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?

The leading sentence frames the tool before a tightly formatted bullet list, one line per action, with zero filler. The opening phrase 'list and inspect them' is slightly redundant with the listPluginSettings bullet, a minor blemish rather than bloat.

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?

For a seven-action dispatcher with no output schema and a generic params container, the description covers every action and its inputs, which is the critical information. It leaves auth requirements and response shape unstated, but the absence of an output schema lowers that burden.

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 outer schema only defines a generic 'params' object, so the description meaningfully compensates by naming each action's actual parameters (plugin_id, id, plugin_setting_id, level, limit, date) and marking each as path or query. It omits types, required flags, and default values, so it is not fully self-sufficient.

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

Purpose4/5

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

The description opens with a specific verb and resource ('list and inspect the account's plugin instances') and enumerates seven concrete read operations, so an agent knows exactly what the tool surfaces. It does not explicitly differentiate itself from AccountPluginSettingsWriteTool or AccountPluginsTool beyond the implied 'Read' naming, so it stops short of a 5.

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?

Each sub-action is paired with a one-line statement of what it retrieves, which effectively routes the agent to the right action ('a private plugin reads through getMergeVariables', 'Read plugin instance health and recent logs'). There are no explicit exclusions or a stated rule for choosing between this tool and its write/plugin siblings, keeping it out of the top band.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources