Skip to main content
Glama
opensearch-project

opensearch-mcp-server-py

Official

ExplainTool

Explains why a document matches or doesn't match a query, helping understand search relevance.

Instructions

Returns information about why a specific document matches (or doesn't match) a query.

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.
indexYes
idYes
bodyYesRequest body containing the query to explain.
Behavior2/5

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

No annotations exist, so the description carries full burden. It does not disclose if the operation is read-only, any side effects, or authentication implications beyond what the schema already provides.

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 a single, front-loaded sentence with no wasted words, effectively conveying the core purpose.

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 13 parameters (many optional) and no output schema, the description is too brief. It omits the output format, usage examples, and any processing details needed for complete understanding.

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 high (85%), so baseline is 3. The description adds no additional meaning beyond the schema—it does not explain how to structure the 'body' parameter or any other parameter details.

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 tool returns information about why a document matches or doesn't match a query, using a specific verb and resource, and implicitly distinguishes from sibling tools like SearchIndexTool.

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 or when not to use this tool versus siblings like SearchIndexTool or CountTool. The description implies a use case but does not provide explicit context 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