Skip to main content
Glama
MCP Dokploy Online
by igoruam

github-testConnection

Idempotent

Tests a GitHub connection with the provided GitHub ID to verify authentication and reachability before using it in deployment workflows.

Instructions

POST /github.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": {
      "githubId": "<githubId>"
    },
    "name": "github-testConnection"
  }
}

Input Schema

NameRequiredDescriptionDefault
githubIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

D1.6/5.0
Behavior2/5

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

Annotations supply openWorldHint=true and idempotentHint=true, so the bar for the description is lower, but the description adds nothing beyond the HTTP verb. It does not say whether the call reaches out to GitHub, what a failed test implies, whether it consumes rate limits, or what side effects (if any) occur when the provider is misconfigured.

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?

The definition is a single route string, so it is short but under-specified rather than concise. There is no front-loaded statement of intent an agent could act on.

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?

For a required-parameter tool with no output schema and only hints in annotations, the description should at minimum say what is tested and what a result means. None of that is present.

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% and there is one required parameter, githubId, whose meaning the description does not clarify — is it an internal provider row ID, an owner name, or an app ID? Neither the schema nor the description explains the format or how to obtain the value.

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 just "POST /github.testConnection", which restates the tool name and HTTP method without saying what a 'test connection' does — whether it validates credentials, pings the API, or checks permissions. It does not distinguish this from siblings like gitlab-testConnection or bitbucket-testConnection beyond the provider name already in the tool name.

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

Usage Guidelines1/5

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

There is no when-to-use guidance, no prerequisites (e.g., a configured GitHub provider), and no exclusions or alternative tools named. The agent must infer everything from the name.

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