Skip to main content
Glama
sjk4425

ncloud-mcp-server

by sjk4425

ncloud_query_widget_preview

Read-only

Query Cloud Insight widget preview chart data by specifying metrics, time range, and aggregation details. Use it to preview charts before adding them to a dashboard.

Instructions

Query widget preview chart data from Cloud Insight by specifying metrics directly.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
periodEndYesEnd time in Unix epoch milliseconds
metricsInfoYesMetric definitions to preview (WidgetMetricInfoDto[])
periodStartYesStart time in Unix epoch milliseconds

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed11 schema fields changedv2.0.1
    • removedInput schema / properties / aggregation
      Removed value: -{
      -  "description": "Aggregation type",
      -  "enum": [
      -    "AVG",
      -    "MIN",
      -    "MAX",
      -    "SUM",
      -    "COUNT"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / dimensions
      Removed value: -{
      -  "additionalProperties": {
      -    "type": "string"
      -  },
      -  "description": "Dimension filters as key-value pairs",
      -  "type": "object"
      -}
    • removedInput schema / properties / interval
      Removed value: -{
      -  "description": "Aggregation interval",
      -  "enum": [
      -    "Min1",
      -    "Min5",
      -    "Min30",
      -    "Hour2",
      -    "Day1"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / metric
      Removed value: -{
      -  "description": "Metric name to query",
      -  "type": "string"
      -}
    • addedInput schema / properties / metricsInfo
      Added value: +{
      +  "description": "Metric definitions to preview (WidgetMetricInfoDto[])",
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "color": {
      +        "description": "Chart color (e.g., #1f77b4)",
      +        "type": "string"
      +      },
      +      "dimensions": {
      +        "additionalProperties": {
      +          "type": "string"
      +        },
      +        "description": "Dimension filters as key-value pairs",
      +        "type": "object"
      +      },
      +      "displayName": {
      +        "description": "Metric display name on the widget",
      +        "type": "string"
      +      },
      +      "metric": {
      +        "description": "Metric name to query",
      +        "type": "string"
      +      },
      +      "period": {
      +        "description": "Aggregation interval",
      +        "enum": [
      +          "Min1",
      +          "Min5",
      +          "Min30",
      +          "Hour2",
      +          "Day1"
      +        ],
      +        "type": "string"
      +      },
      +      "prodKey": {
      +        "description": "Product key (cw_key)",
      +        "type": "string"
      +      },
      +      "productName": {
      +        "description": "Product name (e.g., \"System/Server(VPC)\")",
      +        "type": "string"
      +      },
      +      "resourceId": {
      +        "description": "Resource ID",
      +        "type": "string"
      +      },
      +      "resourceName": {
      +        "description": "Resource name",
      +        "type": "string"
      +      },
      +      "statistic": {
      +        "description": "Aggregation function",
      +        "enum": [
      +          "COUNT",
      +          "SUM",
      +          "MAX",
      +          "MIN",
      +          "AVG"
      +        ],
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "prodKey",
      +      "metric",
      +      "statistic",
      +      "period"
      +    ],
      +    "type": "object"
      +  },
      +  "minItems": 1,
      +  "type": "array"
      +}
    • addedInput schema / properties / periodEnd
      Added value: +{
      +  "description": "End time in Unix epoch milliseconds",
      +  "type": "number"
      +}
    • addedInput schema / properties / periodStart
      Added value: +{
      +  "description": "Start time in Unix epoch milliseconds",
      +  "type": "number"
      +}
    • removedInput schema / properties / prodKey
      Removed value: -{
      -  "description": "Product key (cw_key)",
      -  "type": "string"
      -}
    • removedInput schema / properties / timeEnd
      Removed value: -{
      -  "description": "End time in Unix epoch milliseconds",
      -  "type": "number"
      -}
    • removedInput schema / properties / timeStart
      Removed value: -{
      -  "description": "Start time in Unix epoch milliseconds",
      -  "type": "number"
      -}
    • changedInput schema / required
      Previous value: -[
      -  "prodKey",
      -  "metric",
      -  "timeStart",
      -  "timeEnd"
      -]New value: +[
      +  "periodStart",
      +  "periodEnd",
      +  "metricsInfo"
      +]
  2. First observedv1.10.1

TDQS

B3.2/5.0
Behavior3/5

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

Annotations declare readOnlyHint=true, so the safety profile is already covered. The description adds that data comes from Cloud Insight and that metrics are supplied directly, which is useful framing, but it says nothing about auth requirements, result size, or aggregation behavior beyond what the schema's enums already convey.

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?

A single front-loaded sentence with no filler; the purpose and the metric-driven approach come first. It is efficient, though perhaps too sparse for a tool with a complex nested metricsInfo array.

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?

With annotations covering safety and a fully documented schema, the core need is met. But for a query tool with no output schema and a nested metric-definition array, the description gives no sense of what the preview returns or how multiple metrics are combined, leaving a gap.

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% with richly documented nested fields (metric, prodKey, statistic, period, dimensions), so the schema does the heavy lifting. The description's only parameter-relevant contribution is 'specifying metrics directly,' which does not add meaning beyond the schema.

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?

States a specific verb (Query) and resource (widget preview chart data from Cloud Insight) with the key distinguishing detail that metrics are specified directly. However, it doesn't name or contrast with the many nearby monitoring siblings (ncloud_query_monitoring_data, ncloud_get_dashboard_widgets, ncloud_get_dashboard_widget_image), so an agent gets the purpose but no sibling differentiation.

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?

There is no explicit when-to-use or when-not-to-use guidance. 'By specifying metrics directly' implies a contrast with a widget-ID-based fetch, but no alternative tool is named and no prerequisites or context are given. This leaves routing entirely to inference.

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