Skip to main content
Glama
sjk4425

ncloud-mcp-server

by sjk4425

ncloud_datastream_check_schema_compatibility

Read-only

Check if a new schema is compatible with the latest existing schema for a Data Stream topic, using the topic ID and schema type to validate the schema definition.

Instructions

Check if a new schema is compatible with the latest existing schema for a Data Stream topic

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
schemaYesNew schema definition as JSON string to validate
topicIdYesTopic ID
schemaTypeYesSchema type
Behavior3/5

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

Annotations provide readOnlyHint: true, which the description aligns with. The description does not disclose additional behavioral traits such as what happens on compatibility failure, or any side effects. It adds minimal transparency beyond the annotation.

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?

The description is a single concise sentence of 16 words. It is front-loaded and contains no unnecessary information. Every word earns its place.

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?

The description is fairly complete given the tool's complexity (3 parameters, readOnly). It states inputs and the comparison target. However, it does not clarify what 'compatible' means (e.g., breaking changes), which is a minor gap for a compatibility check tool.

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%, so the input schema already documents all parameters. The description does not add extra meaning beyond what is in the schema, such as clarifying the format of the 'schema' parameter or the allowed 'schemaType' values.

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 clearly states the verb 'Check' and the resource 'a new schema is compatible with the latest existing schema for a Data Stream topic'. It is specific and distinguishable from sibling tools like ncloud_datastream_create_schema and ncloud_datastream_get_schema.

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?

The description implies usage before creating or updating a schema, but it does not explicitly provide guidance on when to use this tool versus alternatives like ncloud_datastream_create_schema or ncloud_datastream_get_schema. No exclusions or alternatives are mentioned.

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/sjk4425/ncloud-mcp-server'

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