Skip to main content
Glama
seohyunjun

OpenSearch MCP Server

by seohyunjun

get_cluster_health

Check the health status of an OpenSearch cluster to monitor its operational state and identify potential issues.

Instructions

Get cluster health status

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The handler function for the 'get_cluster_health' tool. It retrieves the OpenSearch cluster health status using the es_client and returns it as a list of TextContent.
    @mcp.tool(description="Get cluster health status")
    async def get_cluster_health() -> list[TextContent]:
        """
        Get health status of the Opensearch cluster.
        Returns information about the number of nodes, shards, etc.
        """
        self.logger.info("Getting cluster health")
        try:
            response = self.es_client.cluster.health()
            return [TextContent(type="text", text=str(response))]
        except Exception as e:
            self.logger.error(f"Error getting cluster health: {e}")
            return [TextContent(type="text", text=f"Error: {str(e)}")]
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 only states the action ('Get') without detailing aspects like whether it's a read-only operation, potential side effects, authentication needs, rate limits, or response format. This is insufficient for a tool with zero annotation coverage, as it omits critical behavioral context.

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 phrase—with no wasted words. It is front-loaded and directly states the tool's purpose, making it efficient and easy to parse. This is an example of optimal brevity for a simple tool.

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

Completeness2/5

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

Given the lack of annotations and output schema, the description is incomplete. It does not explain what 'health status' includes (e.g., metrics, state details) or the return format, leaving gaps in understanding the tool's behavior and output. For a tool with no structured data support, more descriptive context is needed.

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 input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description does not add parameter details, which is appropriate given the schema's completeness. A baseline score of 4 is assigned as it aligns with the schema without redundancy or gaps.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Get cluster health status' clearly states the action (get) and target resource (cluster health status), which is adequate for understanding the basic purpose. However, it lacks specificity about what 'health status' entails (e.g., metrics, state) and does not differentiate from sibling tools like 'get_cluster_stats' or 'get_recovery_status', making it somewhat vague.

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 guidance is provided on when to use this tool versus alternatives. The description does not mention any context, prerequisites, or exclusions, and it fails to reference sibling tools that might overlap in functionality (e.g., 'get_cluster_stats'). This leaves the agent without direction on appropriate usage scenarios.

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/seohyunjun/opensearch-mcp-server'

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