Skip to main content
Glama

aws_opensearch_describe_domain

Retrieve comprehensive configuration details for an AWS OpenSearch domain, including cluster settings, VPC setup, storage options, endpoints, and current operational status.

Instructions

Get detailed configuration for an OpenSearch domain: cluster config, EBS, VPC, endpoints, engine version, and status.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
profileNoAWS profile name from ~/.aws/config (e.g., 'default', 'production')
regionNoAWS region override (e.g., 'us-east-1', 'sa-east-1')
domain_nameYesOpenSearch domain name
Behavior3/5

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

No annotations provided, so description carries full disclosure burden. Lists return content categories (transparency about output) but omits safety classification (read-only vs destructive), IAM permission requirements, or rate limits. 'Get' implies read-only but should be explicit.

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?

Single efficient sentence with colon-separated list of return categories. Front-loaded purpose ('Get detailed configuration') with zero redundancy or filler.

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

Completeness4/5

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

Without output schema, the description adequately compensates by listing major configuration categories returned (cluster, EBS, VPC, endpoints, version, status). Missing only explicit safety/read-only classification and potential error conditions.

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% (all three parameters well-documented in schema). Description focuses on return values rather than parameter semantics, which is acceptable when schema carries the load. No additional parameter guidance (e.g., format constraints) added by description.

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?

Excellent specificity: uses verb 'Get' with resource 'OpenSearch domain configuration' and distinguishes scope via detailed return value list (cluster config, EBS, VPC, etc.). Clearly differentiates from sibling 'aws_opensearch_describe_domain_health' (health vs configuration) and 'aws_opensearch_list_domain_names' (names only).

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

Usage Guidelines3/5

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

Provides implied usage guidance by enumerating specific configuration categories returned, signalling when to use this over health checks. However, lacks explicit comparison to siblings (e.g., 'use this when you need configuration, use health tool for status').

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/marcelobrake/aws-mcp'

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