Skip to main content
Glama
opensearch-project

opensearch-mcp-server-py

Official

ClusterHealthTool

Checks the health status of an OpenSearch cluster to confirm its operational state.

Instructions

Returns basic information about the health of the cluster.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
opensearch_urlYesOpenSearch endpoint URL.
opensearch_usernameNoUsername for basic authentication.
opensearch_passwordNoPassword for basic authentication.
opensearch_no_authNoIf true, connect without authentication.
aws_regionNoAWS region for IAM/Serverless authentication.
aws_iam_arnNoIAM role ARN for role-based authentication.
aws_profileNoAWS profile name for authentication.
aws_opensearch_serverlessNoIf true, use OpenSearch Serverless service.
opensearch_ssl_verifyNoIf false, disable SSL certificate verification.
opensearch_timeoutNoConnection timeout in seconds.
indexNo
Behavior2/5

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

With no annotations provided, the description alone must disclose behavioral traits. It only says 'Returns basic information', which gives no insight into safety (e.g., read-only), idempotency, required permissions, or what specific data is returned. This is insufficient for an agent to anticipate side effects or authorization needs.

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

Conciseness4/5

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

The description is a single, concise sentence that is easy to parse. While it could include more detail without becoming verbose, the current length is efficient and front-loaded.

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 tool has 11 parameters covering complex authentication scenarios and no output schema, the description is too brief. It does not explain the nature of the 'basic information' returned, how to select among authentication methods, or any context about cluster health checks, leaving significant gaps for the agent.

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

Parameters3/5

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

The input schema has high coverage (91%) with descriptions for most parameters. The description adds no additional information beyond what the schema already provides, so it meets the baseline but does not surpass it.

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 states the tool returns 'basic information about the health of the cluster', which clearly indicates the purpose. However, it does not specify that it is an OpenSearch cluster, and 'basic information' is somewhat vague, leaving room for ambiguity compared to a more detailed purpose statement.

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 sibling tools such as ListIndexTool or SearchIndexTool. There is no mention of prerequisites, recommended context, or alternatives, leaving the agent without strategic selection cues.

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

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