Skip to main content
Glama
opensearch-project

opensearch-mcp-server-py

Official

CountTool

Count documents matching a query in an OpenSearch index. Returns the total number of hits for efficient data analysis.

Instructions

Returns number of documents matching 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.
bodyNoRequest body
indexNo
Behavior2/5

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

No annotations are provided, and the description fails to disclose behavioral traits beyond returning a count. It does not mention that the operation is read-only or describe the impact of the 'body' parameter on the query. Critical details about authentication, timeouts, or error handling are omitted.

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 very concise at one sentence, but it could be improved by adding a brief note on usage or linking to the schema for parameter details. It is front-loaded with 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 12 parameters, no output schema, and no annotations, the description is insufficient. It does not explain the 'body' parameter's role in the query, limitations like max count, or how to handle authentication parameters. The tool's complexity demands more context.

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 high (92%), so the schema already documents most parameters. The description adds no additional context about parameter usage or how they relate to the count operation, such as the role of 'body' in defining the query.

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 clearly states the tool returns a count of documents matching a query, which matches the tool name and distinguishes it from sibling document retrieval tools like SearchIndexTool. However, it does not explicitly differentiate from other sibling tools.

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 is provided on when to use this tool versus alternatives such as SearchIndexTool or MsearchTool. The description lacks explicit when-to-use or when-not-to-use instructions.

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