Skip to main content
Glama

health_check

Verify connectivity to GitLab servers by checking connection status and API availability for self-hosted instances.

Instructions

健康檢查,確認與 GitLab 伺服器的連線狀態

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The health_check tool implementation which uses a GitLab client to test connection and report status.
    @mcp.tool()
    def health_check() -> str:
        """健康檢查,確認與 GitLab 伺服器的連線狀態"""
        try:
            client = get_client()
            config = get_config()
            if client.test_connection():
                version_info = client.get_server_version()
                return f"✓ 連線正常 — {config.gitlab_url}(GitLab {version_info.get('version', '?')})"
            else:
                return f"✗ 無法連接到 {config.gitlab_url}"
        except Exception as e:
            return f"✗ 連線異常: {str(e)}"
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It mentions checking connection status but doesn't describe what constitutes a successful check, what response format to expect, whether it requires authentication, or any rate limits. The description is minimal and lacks operational details.

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?

The description is extremely concise—a single sentence that directly states the tool's function without any fluff or redundant information. Every word contributes to understanding the purpose, making it efficiently front-loaded.

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?

Given the tool's simplicity (no parameters, has output schema), the description is minimally adequate but lacks depth. It doesn't explain what the health check entails or what the output might indicate, though the presence of an output schema reduces the need to detail return values. For a diagnostic tool, more context about failure modes or interpretation would be helpful.

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

Parameters4/5

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

The tool has zero parameters with 100% schema description coverage, so the schema fully documents the absence of inputs. The description appropriately doesn't discuss parameters since none exist, maintaining focus on the tool's purpose without unnecessary detail.

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?

The description clearly states the tool's purpose as checking connection status to a GitLab server, using specific verbs ('健康檢查', '確認') and identifying the target resource. It doesn't explicitly differentiate from siblings like 'server_info', but the focus on connectivity rather than general server information provides some implicit distinction.

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?

The description provides no guidance on when to use this tool versus alternatives like 'server_info' or other diagnostic tools. It states what the tool does but offers no context about appropriate use cases, prerequisites, or exclusions.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/snowild/gitlab-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server