metric

MCP tool from Opensearch MCP Server Py by opensearch-project

(optional): Limit the information returned to the specified metrics. Options include: \all, blocks, metadata, nodes, routingtable, routingnodes, masternode, version

How to use it

metric is exposed by the Opensearch MCP Server Py MCP server. Add the server to your MCP client (Claude Desktop, Cursor, Windsurf and others), and the metric tool becomes available to the model automatically. See the full listing for setup details and every tool this server provides.

Install Opensearch MCP Server Py

$pip install opensearch-mcp-server-py

FULL OPENSEARCH MCP SERVER PY LISTING

Other tools in Opensearch MCP Server Py (39)

aws_iam_arn

string

aws_opensearch_serverless

boolean

aws_profile

string

aws_region

string

body

(optional): Query in JSON format to filter documents

Removes outdated or incorrect memories by document ID.

ExplainTool

format

(optional): The format of SearchIndexTool response. options are csv and json

GetNodesHotThreadsTool

(required): The document ID to explain

index

(optional): The name of the index to get detailed information for. If provided, returns detailed information about this specific index instead of listing all indices.

IndexMappingTool

ListIndexTool

MetricChangeAnalysisTool

Compares percentile distributions (P50, P90) of all numeric fields between a baseline and a selection time range, then returns the top fields ranked by change score. Useful for identifying which numeric metrics shifted most during an anomaly window.

metrics

(optional): A comma-separated list of metrics to display. Available metrics include: id, name, ip, port, role, master, heap.percent, ram.percent, cpu, load1m, load5m, load15m, disk.total, disk.used, disk.avail, disk.usedpercent

MsearchTool

node_id

(optional): A comma-separated list of node IDs or names to limit the returned information. Supports node filters like \local, \master, master:true, data:false, etc. Defaults to \all.

opensearch_no_auth

boolean

opensearch_password

string

opensearch_ssl_verify

boolean

integer

string

string

(required): The search query in OpenSearch Query DSL format

SaveMemoryTool

Saves facts, decisions, and preferences to persistent storage with automatic semantic enrichment.

SearchIndexTool

SearchMemoryTool

Searches memories using natural language with recency-aware ranking.

size

(optional): The size of SearchIndexTool response. Default is 10, maximum is 100 (configurable). To change the maximum limit, set maxsizelimit via CLI arguments or config file. See Tool Customization for details.