Skip to main content
Glama

health_check

Monitor server status and verify operational health to ensure reliable document processing functionality.

Instructions

Check server health and status.

Returns: Dictionary with health status

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The health_check tool implementation in src/docx_mcp/server.py which provides basic service status and version information.
    @app.tool()
    def health_check() -> dict[str, Any]:
        """
        Check server health and status.
    
        Returns:
            Dictionary with health status
        """
        return {
            "status": "healthy",
            "service": "docx-mcp",
            "version": "0.1.0",
        }
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool checks health and returns a dictionary, but lacks details on permissions, rate limits, error handling, or what 'health' entails (e.g., uptime, resources). This is a significant gap for a tool with no annotation coverage.

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?

The description is two short sentences, but the second ('Returns: Dictionary with health status') is redundant given the output schema exists. This wastes space without adding value. The first sentence is clear, but overall structure could be more efficient by omitting the return statement.

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 (0 parameters, output schema provided), the description is minimally adequate. However, with no annotations and an output schema, it should ideally explain what 'health' means or typical use cases. It's complete enough for basic understanding but lacks depth for optimal agent use.

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 0 parameters, and schema description coverage is 100% (though empty). The description doesn't need to add parameter semantics, so it meets the baseline of 4 for zero-parameter tools. No extra parameter information is required or provided.

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 'Check server health and status' with a specific verb ('Check') and resource ('server health and status'). It distinguishes itself from all sibling tools, which are document processing operations, making its purpose unambiguous. However, it doesn't specify what aspects of 'health and status' are checked, keeping it from a perfect score.

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. There are no explicit when/when-not instructions, prerequisites, or comparisons to other tools. The context is implied (server monitoring), but no actionable usage rules are stated.

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/Andrew82106/LLM_Docx_Agent_MCP'

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