Skip to main content
Glama
dmayan-ss

mcp-opensearch

by dmayan-ss

ping

Check OpenSearch cluster connectivity by returning the cluster name and version, confirming the server is ready for queries.

Instructions

Check connectivity to the OpenSearch cluster. Returns cluster name and version.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior3/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. It discloses the operation and return value but does not explicitly state that it is read-only or describe any error/timeout behavior. For a simple ping this is adequate but not highly transparent.

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?

A single sentence with no wasted words. It front-loads the action and includes the key return information, making it easy for an agent to parse quickly.

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

Completeness5/5

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

With zero parameters, no annotations, and an output schema present, the description only needs to convey the tool's purpose and what it returns. It does so completely, leaving no critical gaps for invocation.

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, so there is no parameter behavior to explain. Per the zero-parameter baseline, the description need not add parameter detail, and it appropriately includes return information instead.

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 uses a specific verb ('Check connectivity') and a clear resource ('OpenSearch cluster'), and it states what the tool returns. It is clearly distinct from siblings like search or get_document, though it does not explicitly differentiate itself from cluster_health.

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

Usage Guidelines4/5

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

The intended usage is clear: use this tool to verify connectivity to the OpenSearch cluster. No alternatives or exclusions are mentioned, but with zero parameters and a self-evident purpose, the context is sufficient for an agent to know when to call it.

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