Skip to main content
Glama
MCP Kafka Schema Reg

MCP Kafka Schema Reg

Check Compatibility

check_compatibility
Read-onlyIdempotent

Verify whether a schema is compatible with the latest registered version for a Kafka Schema Registry subject, helping prevent incompatible schema changes.

Instructions

Check if a schema is compatible with the latest version.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "subject": "<subject>",
      "schema_definition": "<schema_definition>"
    },
    "name": "check_compatibility"
  }
}

Input Schema

NameRequiredDescriptionDefault
contextNo
subjectYes
registryNo
schema_typeNoAVRO
schema_definitionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv2.2.2
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / context / title
      Removed value: -"Context"
    • removedInput schema / properties / registry / title
      Removed value: -"Registry"
    • removedInput schema / properties / schema_definition / title
      Removed value: -"Schema Definition"
    • removedInput schema / properties / schema_type / title
      Removed value: -"Schema Type"
    • removedInput schema / properties / subject / title
      Removed value: -"Subject"
  2. First observedv1.0.0

TDQS

C2.4/5.0
Behavior2/5

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

The readOnlyHint and idempotentHint annotations already establish that this is a safe, repeatable read, so the description's main obligation is to explain what the check actually does. It does not: it never says which compatibility mode is evaluated, whether it is transitive or level-by-level, or what a failed check yields (an error vs. a list of incompatibilities). With annotations covering safety, the remaining behavioral surface is left entirely unexplained.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The single sentence is front-loaded and contains no filler, so it is efficient in construction. The problem is under-specification rather than verbosity, which keeps it at the minimum-viable level rather than earning a high score.

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

Completeness2/5

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

This is a five-parameter tool with a nested free-form object and no output schema, so the description carries a heavy burden and does not meet it. An agent cannot determine from this definition which compatibility semantics will be applied, what a positive or negative result looks like, or how registries/contexts scope the check.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% across five parameters, and the description compensates for essentially none of it. `context`, `registry`, `schema_type` (with its AVRO default), and the free-form nested `schema_definition` object are all left undefined; the description only vaguely gestures at 'schema' and 'latest version', which hints at `schema_definition` and `subject` but adds no syntax or format detail.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb ('Check') and resource ('a schema'), so the general intent is legible, but 'compatible with the latest version' is ambiguous — it never says the latest version of the subject identified by the `subject` parameter, nor what the check is against (a registry's configured compatibility mode). It also does not distinguish this tool from the sibling `check_compatibility_interactive`, which an agent could easily confuse it with.

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 when-to-use guidance at all: no statement of prerequisites (must the subject already exist? must the registry be reachable?), no indication of when the interactive sibling should be preferred, and no note that this is a dry-run check rather than an update. The agent must infer all of this.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.