Skip to main content
Glama

update_configuration_descriptions

Idempotent

Write descriptions that document a configuration and its keys: what a key controls, its units, and valid ranges. Set the configuration's own description and/or describe individual keys by path (object keys only, not array items); an empty description removes it. Descriptions are metadata only: this does not change any value, does not change the contentHash, and does not deploy anything to game servers. Read the configuration first (get_configuration) so the paths exist and the descriptions are accurate. Always explain why in reason; it is recorded with the write.

Input Schema

NameRequiredDescriptionDefault
reasonYesWhy these descriptions are being written, in one sentence.
projectIdYesThe project (application) id to scope this call to. Use list_projects to discover valid ids.
descriptionNoNew description of the configuration as a whole. An empty string clears it. Omit to leave it unchanged.
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.
keyDescriptionsNoUp to 50 key descriptions to set or remove.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Beyond the annotations it discloses that an empty description deletes it, that contentHash is unaffected, that nothing is deployed, and that the reason is recorded with the write. These are exactly the side-effect details an agent needs before mutating metadata that it could not infer from readOnlyHint=false / idempotentHint=true alone.

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?

Four sentences, front-loaded with the purpose, then constraint, then side-effect profile, then prerequisite. No filler and no repetition of the tool name or title.

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?

For a 6-parameter mutation tool with no output schema, the description covers purpose, structural constraint (no array paths), destructive-vs-clearing semantics, side effects on contentHash and deployment, and the discovery prerequisite. Nothing an agent needs 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 description coverage is 100%, so the schema already documents path, description, reason, projectId, environment, and configurationId. The description reinforces the object-keys-not-array-items constraint and the empty-string-clears behavior, but adds essentially no new semantics beyond what the schema states — the baseline of 3 applies.

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?

"Write descriptions that document a configuration and its keys" gives a specific verb and resource, and the metadata-only clause ("does not change any value, does not change the contentHash, and does not deploy anything") cleanly separates it from update_configuration and preview_configuration_change. An agent can identify the tool's scope without opening the schema.

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?

It states a concrete prerequisite workflow ("Read the configuration first (get_configuration) so the paths exist") and mandates a reason for every call. It stops short of explicitly saying when to prefer update_configuration over this tool, but the metadata-only framing makes the boundary inferable.

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