Skip to main content
Glama
MCP Dokploy Online
by igoruam

ai-testConnection

Idempotent

Tests an AI model connection using the supplied API URL, API key, and model name to verify credentials and endpoint configuration before use.

Instructions

POST /ai.testConnection

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": {
      "apiUrl": "<apiUrl>",
      "apiKey": "<apiKey>",
      "model": "<model>"
    },
    "name": "ai-testConnection"
  }
}

Input Schema

NameRequiredDescriptionDefault
modelYes
apiKeyYes
apiUrlYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

D1.8/5.0
Behavior2/5

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

Annotations already declare openWorldHint=true and idempotentHint=true, so the agent knows this reaches an external system and is safe to retry. The description adds nothing further: it does not disclose that credentials are transmitted to a third-party endpoint, what a failure looks like, or whether anything is persisted.

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

Conciseness2/5

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

It is short, but only because it carries no information beyond the endpoint path. There is no front-loaded purpose statement or structure for the reader to use; the single token string fails to earn its place as the entire description.

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

Completeness1/5

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

A three-required-parameter credential-verification tool with no output schema and no parameter documentation needs a real explanation, and this provides none. The agent has no idea what a successful or failed response means or how to construct valid inputs.

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

Parameters1/5

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

Schema description coverage is 0% for all three required parameters (apiUrl, apiKey, model), and the description supplies none of the missing meaning. The agent cannot tell the expected URL format, whether apiKey needs a prefix, or what model identifiers are accepted.

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?

The description is only the raw route string "POST /ai.testConnection", which restates the tool name rather than explaining what the tool does. It does not say the tool verifies AI provider credentials/connectivity against an apiUrl and model, so the agent must infer purpose from the name alone.

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?

No when-to-use, when-not-to-use, or prerequisite guidance is given. Nothing distinguishes this from siblings like ai-getModels or ai-getEnabledProviders, nor is it stated that this should be called before deploying or saving an AI provider config.

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

Deploy Server

Other Tools