Skip to main content
Glama

Get instance configuration

get_instance_config
Read-onlyIdempotent

Read an instance's configuration (like clerk config pull): an object keyed by top-level config key, such as session or auth_email, plus config_version. Sensitive values are redacted.

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"
  }
}

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
config_versionNo

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": {
      +    "config_version": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Added

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, so the safety bar is low; the description still adds real context by disclosing that sensitive values are redacted (agents cannot rely on secret values) and that config_version is included in the response. It leaves out any auth/permission requirements or error behavior, keeping it from a 5.

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?

One front-loaded sentence with no filler: verb, scope, return shape, CLI analogy, and the redaction caveat all in a single pass. Every clause carries information an agent would otherwise have to infer.

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 small read-only tool with three fully documented parameters and an output schema, this is nearly complete — return shape and redaction are covered and the output schema handles the rest. Only auth scoping and behavior on invalid keys or unknown instances are unaddressed.

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 coverage is 100%, so the baseline is 3 — the schema already explains application_id, instance, and the keys filter in detail. The description echoes the same "top-level config key" phrasing and the session/auth_email examples without adding syntax, defaults, or edge-case meaning beyond the schema.

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 an instance's configuration") and even sketches the return shape — an object keyed by top-level config key plus config_version. It implicitly separates itself from patch_instance_config/put_instance_config via "read" and from get_instance_config_schema via the config object, but never names or contrasts with those siblings, so it stops short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied: this is the tool you call to inspect current config. There is no explicit when-to-use, no statement about when to prefer get_instance_config_schema to discover valid keys, and no guidance on whether keys should be narrowed for large configs beyond the schema's own note.

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