Skip to main content
Glama

get_configuration

Read-only

Read a configuration by id. Configurations are large JSON objects rendered as a file tree in the dashboard — nested objects are 'folders', arrays and primitives are 'files'. Use mode 'structure' (default) to get a depth-limited file-tree outline (cheap, always safe at root). Use mode 'values' to read actual values within a 20 KB budget; truncatedPaths in the response lists subpaths that were elided — call again with 'path' set to one of those to drill in. Private keys (hidden from SDK clients, not from the dashboard) are annotated with _hidden: true. contentHash identifies the version you read — pass it as baseContentHash when changing it with update_configuration. The deepLinkPath in the response is a ?path= URL fragment you can share with the user to open that node in the dashboard. description and keyDescriptions are the documentation people wrote for the configuration and its keys (what a key controls, units, valid ranges) — use them to interpret values, and set them with update_configuration_descriptions.

Input Schema

NameRequiredDescriptionDefault
modeNostructure (default): file-tree outline showing keys, types, and child counts. values: actual values within a 20 KB byte budget.
pathNoNavigate to a specific nested object (folder) by its key path, e.g. ["settings", "ranked"]. Omit to start at the root.
depthNoMax nesting depth for structure mode. Default 3.
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.
configurationIdYesThe numeric id of the configuration to read.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only cover readOnlyHint and openWorldHint, but the description adds substantial behavior: a 20 KB byte budget with truncatedPaths reporting elision, _hidden: true marking of private keys that are hidden from SDK clients but not the dashboard, contentHash as a version token for optimistic concurrency, and deepLinkPath as a shareable ?path= fragment. These are exactly the operational facts an agent needs and none are inferable from annotations.

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?

Purpose is front-loaded in the first sentence and subsequent sentences cover modes, truncation recovery, hidden keys, versioning, and documentation fields in a logical order. It is dense and mostly earns its length, though the deepLinkPath and description/keyDescriptions sentences could be tightened slightly.

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?

With no output schema and six parameters, the description proactively explains the response payload surface (truncatedPaths, _hidden, contentHash, deepLinkPath, description/keyDescriptions) so the agent can act on the result without a return-type spec. Nothing material for a correct call is missing.

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 coverage is 100%, so the baseline is 3; the description nevertheless adds cross-parameter meaning the schema lacks — that 'path' is a key array used specifically to drill into truncatedPaths, and that 'structure' is the default mode while 'values' is budget-bound. It does not restate depth semantics in more detail than the schema, so a 4 rather than 5.

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 ('Read a configuration by id') and immediately distinguishes the operation from sibling reads (list_configurations, search_configuration) and writes (update_configuration) by describing the two read modes and their cost/safety tradeoff.

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?

Explicitly routes the agent: mode 'structure' is default and cheap/safe at root, mode 'values' is for actual values, and when output is truncated the agent should re-call with 'path' set to a truncatedPaths entry. It also names the follow-up tool (update_configuration_descriptions) for editing docs, leaving nothing to 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