Skip to main content
Glama
sql-mcp
by ohankay

test_connection

Read-onlyIdempotent

Connects to Microsoft SQL Server to verify connectivity and return server version, login details, authentication scheme, and SQL Agent status for troubleshooting.

Instructions

Connect and return server/version/login info (SQL 2017/2019/2022 ...), auth scheme and Agent status.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "test_connection"
  }
}

Input Schema

NameRequiredDescriptionDefault
connectionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description usefully adds the shape of the response (server/version, auth scheme, Agent status), but says nothing about failure behavior — whether a bad connection raises an error or returns a status field — which is the main thing an agent needs to know for a connectivity probe.

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

Conciseness4/5

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

One compact sentence, front-loaded with the action and the returned information. The parenthetical '(SQL 2017/2019/2022 ...)' is slightly noisy but conveys supported server versions in minimal space.

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

Completeness3/5

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

With no output schema, the description carries the burden of describing return values, and it does so only at a high level (server/version/login, auth scheme, Agent status) without naming fields or the failure path. For a one-parameter diagnostic tool this is adequate but leaves real gaps around the null connection argument and error reporting.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The single parameter 'connection' (nullable, default null, 0% schema description coverage) is never mentioned in the description. It does not explain what omitting it means (presumably the default connection) or what format a named connection takes, so the description fails to compensate for the schema gap.

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 action (connect) and enumerates what comes back: server/version/login info, auth scheme, and Agent status. That is concrete enough to separate it from list_connections or execute_sql, though it never explicitly contrasts itself with them.

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 explicit 'use this when...' guidance and no mention of when to prefer list_connections or add_connection instead. An agent must infer from the name and the word 'connect' that this validates connectivity/auth rather than listing or creating connections.

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