Skip to main content
Glama

Get instance configuration schema

get_instance_config_schema
Read-onlyIdempotent

Read the JSON Schema for an instance's configuration (like clerk config schema): each top-level key's fields with their types, descriptions, and allowed values. Use it to find valid keys before patch_instance_config or put_instance_config.

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>"
    },
    "name": "get_instance_config_schema"
  }
}

Input Schema

NameRequiredDescriptionDefault
keysNoTop-level config keys to return, such as "session" or "auth_email". Omit to return every key.
instanceYesInstance to target: "development", "production", or a full instance ID (ins_…).
application_idYesClerk application ID (app_…).

Output Schema

NameRequiredDescriptionDefault
propertiesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / keys / description
      Previous value: -"Top-level config keys to include."New value: +"Top-level config keys to return, such as \"session\" or \"auth_email\". Omit to return every key."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": {},
      +  "properties": {
      +    "properties": {
      +      "additionalProperties": {},
      +      "propertyNames": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Added

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds that the result is schema metadata per top-level key and anchors it to the `clerk config schema` CLI equivalent, but says nothing about output size, truncation, or behavior for unknown keys.

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?

Two sentences, zero waste, with the core definition front-loaded and the usage pointer second. The CLI analogy is compact and helps orient a reader without padding.

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?

An output schema exists, so return values need no explanation, and the description covers purpose plus position in the read/patch/put workflow. The only shortfall is not contrasting with get_instance_config, which matters given near-identical names and scope.

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 all three parameters (including the optional `keys` filter and instance/application_id formats) are already documented in the schema. The description adds no syntax or format detail beyond noting that each top-level key's fields are returned, so the baseline of 3 applies.

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?

States a specific verb and resource ('Read the JSON Schema for an instance's configuration') and clarifies the payload is field types, descriptions, and allowed values. It does not explicitly distinguish itself from the sibling get_instance_config (actual values vs. schema), which is the one confusion an agent could have here.

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 a concrete trigger: 'Use it to find valid keys before patch_instance_config or put_instance_config,' naming two siblings. It stops short of an explicit when-not (e.g., use get_instance_config to read current values), so the guidance is clear but not complete.

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