Skip to main content
Glama

Test Key Auth

tm_remote_test_key_auth
Read-onlyIdempotent

Test SSH key authentication for a remote host to verify passwordless access before running single-host SSH operations.

Instructions

Test key auth (tm_remote). Single-host SSH operations with shared connection params.

Input Schema

NameRequiredDescriptionDefault
cfgNoSSH config path; unset uses ~/.ssh/config.
cmdNoShell command (run_command).
keyNoKey path (test_key_auth/setup_passwordless).
hostNoInventory alias, or a raw hostname with an explicit user.
lcfgNoLocal SSH config (copy_ssh_config).
portNoPort; unset uses the inventory alias, else 22.
rcfgNoRemote SSH config (copy_ssh_config)./root/.ssh/config
userNoUsername; unset uses the inventory alias.
lpathNoLocal file path (send_file/receive_file).
proxyNoTeleport proxy; unset uses the alias.
rpathNoRemote file path (send_file/receive_file).
confirmNoConfirm a destructive action (remove_host_key) without elicitation.
id_fileNoPrivate key path; unset uses the alias.
new_keyNoNew private key path (rotate_key).
timeoutNoCommand timeout in seconds.
key_typeNoKey type: rsa or ed25519 (setup_passwordless/rotate_key).ed25519
certificateNoTeleport certificate; unset uses the alias.
known_hostsNoKnown hosts path (remove_host_key)./root/.ssh/known_hosts
password_refNoRuntime secret reference for the SSH password; unset uses the alias.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed20 schema fields changedv3.4.6
    • changedInput schema / properties / certificate / default
      Previous value: -""New value: +null
    • changedInput schema / properties / certificate / description
      Previous value: -"Teleport certificate."New value: +"Teleport certificate; unset uses the alias."
    • addedInput schema / properties / cfg / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / cfg / default
      Previous value: -"/root/.ssh/config"New value: +null
    • changedInput schema / properties / cfg / description
      Previous value: -"SSH config path."New value: +"SSH config path; unset uses ~/.ssh/config."
    • removedInput schema / properties / cfg / type
      Removed value: -"string"
    • addedInput schema / properties / confirm
      Added value: +{
      +  "default": false,
      +  "description": "Confirm a destructive action (remove_host_key) without elicitation.",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / host / description
      Previous value: -"Remote host."New value: +"Inventory alias, or a raw hostname with an explicit user."
    • changedInput schema / properties / id_file / default
      Previous value: -"/app/.ssh/id_ed25519"New value: +null
    • changedInput schema / properties / id_file / description
      Previous value: -"Private key path."New value: +"Private key path; unset uses the alias."
    • changedInput schema / properties / password_ref / default
      Previous value: -""New value: +null
    • changedInput schema / properties / password_ref / description
      Previous value: -"Runtime secret reference for the SSH password."New value: +"Runtime secret reference for the SSH password; unset uses the alias."
    • addedInput schema / properties / port / anyOf
      Added value: +[
      +  {
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / port / default
      Previous value: -22New value: +null
    • changedInput schema / properties / port / description
      Previous value: -"Port."New value: +"Port; unset uses the inventory alias, else 22."
    • removedInput schema / properties / port / type
      Removed value: -"integer"
    • changedInput schema / properties / proxy / default
      Previous value: -""New value: +null
    • changedInput schema / properties / proxy / description
      Previous value: -"Teleport proxy."New value: +"Teleport proxy; unset uses the alias."
    • changedInput schema / properties / user / default
      Previous value: -""New value: +null
    • changedInput schema / properties / user / description
      Previous value: -"Username."New value: +"Username; unset uses the inventory alias."
  2. Addedv3.3.1

TDQS

C2.3/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so safety is covered. The description adds nothing beyond that: it doesn't say what a failing auth result looks like, whether any remote state is touched, whether credentials are read from disk, or how long the probe may take. "Shared connection params" hints at the schema but conveys no behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is short, but the second sentence does not earn its place: it describes the input schema generically instead of telling the agent what the tool does or when to call it. Brevity without front-loaded substance.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

This is a 19-parameter tool with a large sibling family, and the description leaves the agent unable to tell which parameters are relevant or how this differs from adjacent SSH tools. The output schema exists, so return values needn't be explained, but purpose and usage gaps remain large for a tool of this complexity.

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% and each parameter's description tags which operation it belongs to (e.g. "Key path (test_key_auth/setup_passwordless)", "New private key path (rotate_key)"), so the schema does the disambiguating work. The description contributes only the vague phrase "shared connection params" and does not clarify which of the 19 parameters actually matter here.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Test key auth" restates the tool name and title almost verbatim, adding essentially no verb/resource specificity. "Single-host SSH operations with shared connection params" describes the schema shape rather than the action, and gives no way to distinguish this from siblings like tm_remote_check_ssh or tm_inventory_configure_key_auth.

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

Usage Guidelines2/5

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

There is no when-to-use or when-not guidance. The agent is not told whether this is a pre-flight probe before setup_passwordless, a post-change verification, or how it differs from check_ssh. Nothing is stated or even implied beyond the name.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.