Skip to main content
Glama

Replace instance configuration

put_instance_config
Destructive

Replace an instance's entire configuration (like clerk config put); the change applies to the live instance immediately. config must include every top-level key, so start from get_instance_config; a config missing any key is rejected. Returns the before and after values and the new config_version. Run with dry_run first.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "application_id": "<application_id>",
      "instance": "<instance>",
      "config": "<config>"
    },
    "name": "put_instance_config"
  }
}

Input Schema

NameRequiredDescriptionDefault
configYesConfiguration keyed by top-level config key, in the shape get_instance_config returns. get_instance_config_schema lists the valid keys and fields.
dry_runNoPreview the change without applying it.
instanceYesInstance to target: "development", "production", or a full instance ID (ins_…).
destructiveNoAllow changes that delete resources instead of resetting them: session templates, custom OAuth providers, and minimum app versions (a null entry or platform in native_app_minimum_versions).
application_idYesClerk application ID (app_…).

Output Schema

NameRequiredDescriptionDefault
afterNo
beforeNo
dry_runNo
config_versionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / config / description
      Previous value: -"Config JSON, keyed by top-level section."New value: +"Configuration keyed by top-level config key, in the shape get_instance_config returns. get_instance_config_schema lists the valid keys and fields."
    • changedInput schema / properties / destructive / description
      Previous value: -"Allow changes that delete resources (session templates, custom OAuth providers) instead of resetting them."New value: +"Allow changes that delete resources instead of resetting them: session templates, custom OAuth providers, and minimum app versions (a null entry or platform in native_app_minimum_versions)."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": {},
      +  "properties": {
      +    "after": {
      +      "anyOf": [
      +        {
      +          "additionalProperties": {},
      +          "propertyNames": {
      +            "type": "string"
      +          },
      +          "type": "object"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "before": {
      +      "anyOf": [
      +        {
      +          "additionalProperties": {},
      +          "propertyNames": {
      +            "type": "string"
      +          },
      +          "type": "object"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "config_version": {
      +      "type": "string"
      +    },
      +    "dry_run": {
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Added

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false, and the description still adds real context: the change hits the live instance immediately, incomplete configs are rejected, and the response includes before/after values plus config_version. That is precisely the behavior an agent needs before a destructive write.

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 tight sentences, front-loaded with the core mutation semantics before the prerequisites and the dry_run advice. Nothing is redundant with the title or schema, and each clause carries distinct information.

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 destructive, nested-object write tool with an output schema, this covers the replacement contract, key completeness requirement, immediate live effect, and return shape. No gap remains that would cause an agent to invoke it incorrectly.

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 schema carries most parameter meaning; the description still adds that config must contain every top-level key and points to get_instance_config as the source shape. The dry_run recommendation also adds operational meaning beyond the schema's 'preview' wording, though it does not elaborate on the destructive flag's specifics.

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 ('Replace an instance's entire configuration') and emphasizes 'entire', which distinguishes a full replacement from the sibling patch_instance_config without depending on the sibling's name. An agent can identify the operation from the first clause alone.

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?

Gives concrete workflow conditions: start from get_instance_config, every top-level key is mandatory, and run dry_run first. It implies partial edits belong elsewhere via the all-keys requirement but never names the alternative explicitly, so the routing is strong but not fully spelled out.

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