Skip to main content
Glama

search_configuration

Read-only

Search for keys or values inside one or all configurations for this project. Useful for questions like 'where is maxPlayers set?' or 'which configs have a ranked sub-object?'. Omit configurationId to search across all configurations in the current environment. Set isRegex to true to use a regular expression. target controls what to match: 'keys' (key names only), 'values' (primitive values only), 'both' (default), or 'descriptions' (the documentation written for keys — e.g. find which key controls "respawn time" when you don't know its name). Use path to scope the search to a specific sub-object (folder) in the config tree.

Input Schema

NameRequiredDescriptionDefault
pathNoScope search to a specific sub-object by segment path, e.g. ["settings"]. Omit to search the entire configuration.
queryYesThe search term. Case-insensitive substring match by default; set isRegex for a regex.
targetNo'keys': match key names only. 'values': match primitive values only. 'both' (default): match either. 'descriptions': match the text of key descriptions; matches include the description.
isRegexNoTreat query as a JavaScript regex (case-insensitive). Default false.
projectIdYesThe project (application) id to scope this call to. Use list_projects to discover valid ids.
environmentYesThe environment name to scope this call to (e.g. 'production'). Use list_projects to discover the names available to this token.
configurationIdNoSearch only this configuration. Omit to search all configurations in the current environment.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered structurally. The description adds useful behavior beyond that — default case-insensitive substring matching, JS regex semantics, and what a 'descriptions' match returns — but says nothing about result limits, pagination, or ordering, which matter for a potentially broad cross-configuration search.

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 definition is front-loaded with purpose and question examples, then moves through parameters in a logical order with no filler sentences. It is on the longer side for seven parameters, but nearly every clause carries actionable information.

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-parameter read-only search with no output schema, the description covers scoping, matching mode, and regex behavior well. The remaining gap is that the shape and volume of results are never described, so an agent cannot anticipate truncation or pagination on broad searches across all configurations.

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 100%, so the baseline is 3; the description earns an extra point by explaining the intent behind parameters rather than restating them, particularly the 'descriptions' target (matching documentation text and returning the description) and the rationale for omitting configurationId. It adds meaning about matching semantics that the schema only briefly touches.

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 first sentence gives a specific verb and resource ('Search for keys or values inside one or all configurations') and immediately narrows the scope to the current project. The concrete question examples ('where is maxPlayers set?') make it unambiguous that this is a search tool rather than the get/list siblings such as get_configuration or list_configurations.

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?

Explicit routing rules are given for every mode: omit configurationId to fan out across all configurations, set isRegex for regex queries, and use target to switch between keys, values, both, or descriptions. The 'descriptions' guidance even names the scenario (finding a key when you don't know its name), so an agent can pick the right invocation without inference.

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