Skip to main content
Glama
opensearch-project

opensearch-mcp-server-py

Official
by opensearch-project
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

ListIndexTool

List OpenSearch cluster indices, optionally filtered by name or pattern, with full metadata or names only.

Instructions

Lists indices in the OpenSearch cluster. If an index name or pattern is specified, return only information about the provided index or index pattern. The include_detail flag controls output: if False, returns only index name(s); if True (default), returns full metadata.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
indexNoThe name of the index or index pattern to get information for.
aws_regionNoAWS region for IAM/Serverless authentication.
aws_iam_arnNoIAM role ARN for role-based authentication.
aws_profileNoAWS profile name for authentication.
include_detailNoWhether to include detailed information. If False, returns only index name(s). If True, returns full metadata.
opensearch_urlYesOpenSearch endpoint URL.
opensearch_no_authNoIf true, connect without authentication.
opensearch_timeoutNoConnection timeout in seconds.
opensearch_passwordNoPassword for basic authentication.
opensearch_usernameNoUsername for basic authentication.
opensearch_ssl_verifyNoSet true to require SSL certificate verification. A false value is ignored, since only the operator may disable verification.
aws_opensearch_serverlessNoIf true, use OpenSearch Serverless service.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.12.0
    • changedInput schema / properties / opensearch_ssl_verify / description
      Previous value: -"If false, disable SSL certificate verification."New value: +"Set true to require SSL certificate verification. A false value is ignored, since only the operator may disable verification."
  2. First observedv0.9.0

TDQS

A3.5/5.0
Behavior3/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It does explain the output difference between include_detail True/False and filtering behavior, which is helpful. However, it omits any mention of read-only nature, potential errors, or behavior when no indices exist. For a simple list operation, this is adequate but not thorough.

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?

Two sentences, front-loaded with the primary action and key behavior. No redundant wording. The description efficiently conveys the tool's function and output control without fluff.

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

Completeness3/5

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

For a tool with 12 parameters (mostly authentication-related), the description focuses on the functional behavior and does not attempt to document each auth parameter, which is acceptable since the schema covers them. However, it lacks details on return format specifics (e.g., what 'full metadata' includes) and does not address potential edge cases. Given no output schema, slightly more detail on the output structure would improve completeness.

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 description coverage is 100%, so all parameters are already documented. The description adds minimal extra meaning beyond the schema—it reiterates the include_detail behavior and adds the context of index/pattern filtering, but this is mostly redundant with the schema. Baseline 3 is appropriate since the schema carries the parameter semantics.

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?

Description clearly states the verb 'Lists' and the resource 'indices in the OpenSearch cluster', and explicitly explains filtering by index/pattern and the include_detail flag behavior. This distinguishes it from sibling tools like SearchIndexTool or GetShardsTool by its specific function of listing index metadata.

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 alternatives. It does not mention any sibling tool or condition for selection. The purpose is implied but there is no explicit 'use this when...' or 'instead of...' guidance, leaving the agent to infer usage.

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

Deploy Server

Other Tools