Skip to main content
Glama
sjk4425

ncloud-mcp-server

by sjk4425

ncloud_cdss_list_config_groups

Read-only

Retrieve Kafka configuration template groups (CDSS Config Groups) for a specified Kafka version code. Use this to manage or select configuration templates by version.

Instructions

List Config Groups for CDSS (Kafka configuration templates) for a given Kafka version

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoNoPage number (default: 1)
pageSizeNoPage size (default: 10)
kafkaVersionCodeYesKafka version code (from ncloud_cdss_get_kafka_versions)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv1.15.0
    • changedInput schema / properties / kafkaVersionCode / description
      Previous value: -"Filter by Kafka version code"New value: +"Kafka version code (from ncloud_cdss_get_kafka_versions)"
    • changedInput schema / properties / kafkaVersionCode / type
      Previous value: -"string"New value: +"number"
    • addedInput schema / properties / pageNo
      Added value: +{
      +  "description": "Page number (default: 1)",
      +  "type": "number"
      +}
    • addedInput schema / properties / pageSize
      Added value: +{
      +  "description": "Page size (default: 10)",
      +  "type": "number"
      +}
    • addedInput schema / required
      Added value: +[
      +  "kafkaVersionCode"
      +]
  2. First observedv1.10.1

TDQS

A4/5.0
Behavior3/5

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

readOnlyHint=true already declares this is a safe read operation, and 'List' is consistent with that annotation. The description adds useful context that these are Kafka configuration templates scoped by Kafka version, but it doesn't disclose additional behavioral details like default pagination or response shape. With annotations covering the safety profile, this is adequate but not exceptional.

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?

A single compact sentence with no filler. The parenthetical 'Kafka configuration templates' immediately disambiguates the resource type without bloating the description.

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?

This is a simple read-only list tool with one required parameter and two standard pagination parameters, all already documented in the schema. The description plus annotations provide enough for an agent to select and invoke it correctly; an output schema would be a nice addition but isn't necessary for a basic list operation.

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 coverage is 100%, with all three parameters documented, including the helpful note that kafkaVersionCode comes from ncloud_cdss_get_kafka_versions. The description itself adds no parameter-level detail, so the baseline of 3 applies since the schema already does the heavy lifting.

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?

The description names a specific verb and resource: it lists CDSS config groups, clarifies them as Kafka configuration templates, and scopes them to a Kafka version. This meaningfully differentiates it from nearby tools like ncloud_cdss_get_config_group_detail and ncloud_list_cache_config_groups.

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

Usage Guidelines4/5

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

The description clearly states the core usage condition: config groups are listed for a given Kafka version, so the agent knows a version context is required. It does not explicitly name alternatives or say when not to use this tool, but the CDSS/version framing gives enough context for a straightforward list operation.

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