Skip to main content
Glama
opensearch-project

opensearch-mcp-server-py

Official

GetShardsTool

Get shard-level information for an OpenSearch index to monitor allocation, size, and health.

Instructions

Gets information about shards in OpenSearch

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.
indexYesThe name of the index to get shard information for
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. However, it only says 'Gets information', implying a read operation, but does not state side effects, authentication requirements, or any other behavioral traits. The description fails to add value beyond the basic action.

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 with no wasted words, and the main action is front-loaded. However, the brevity sacrifices completeness and context, preventing a perfect score.

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?

The tool has 11 parameters including complex authentication options and no output schema. The description does not explain what 'information about shards' includes, the return format, or how the parameters relate to the operation. This is insufficient for a tool of this complexity.

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?

Schema coverage is 100% with all parameters described. The description adds no additional meaning beyond what the schema already provides, so a baseline score of 3 is appropriate.

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

Purpose5/5

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

The description clearly states the verb 'Gets' and the resource 'information about shards in OpenSearch', which is specific and distinct from sibling tools like ClusterHealthTool or SearchIndexTool. The purpose is unambiguous.

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 on when to use this tool versus alternatives or when not to use it. The description lacks any contextual hints 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/opensearch-project/opensearch-mcp-server-py'

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