Skip to main content
Glama
aywengo

MCP Kafka Schema Reg

guided_schema_migration

Initiate a structured workflow for migrating schemas using the Schema Migration Wizard on the MCP Kafka Schema Registry server.

Instructions

Start the Schema Migration Wizard workflow for guided schema migration

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The main handler function for the guided_schema_migration MCP tool. It registers the tool using @self.mcp.tool and starts the schema_migration_wizard workflow via MultiStepElicitationManager.
    @self.mcp.tool(description="Start the Schema Migration Wizard workflow for guided schema migration")
    async def guided_schema_migration() -> str:
        """Convenience method to start Schema Migration workflow."""
        workflow_id = "schema_migration_wizard"
    
        try:
            request = await self.multi_step_manager.start_workflow(workflow_id=workflow_id, initial_context={})
    
            if request:
                return json.dumps(
                    {
                        "status": "started",
                        "workflow_id": workflow_id,
                        "workflow_name": "Schema Migration Wizard",
                        "request_id": request.id,
                        "first_step": request.title,
                        "description": request.description,
                        "message": (
                            "Schema Migration Wizard started. This workflow will guide you through:\n"
                            "1. Source and target registry selection\n"
                            "2. Schema selection and validation\n"
                            "3. Migration planning and execution\n"
                            "4. Verification and rollback procedures"
                        ),
                    }
                )
            else:
                return json.dumps({"error": "Failed to start Schema Migration workflow"})
        except Exception as e:
            logger.error(f"Error starting Schema Migration workflow: {str(e)}")
            return json.dumps({"error": f"Failed to start workflow: {str(e)}"})
  • Helper function that processes the workflow responses from the schema migration wizard to generate an execution plan for the actual migration operations.
    def execute_schema_migration(responses: Dict[str, Any]) -> Dict[str, Any]:
        """Execute schema migration based on workflow responses."""
        migration_type = responses.get("migration_type")
        source_registry = responses.get("source_registry")
        target_registry = responses.get("target_registry")
    
        result = {
            "operation": "schema_migration",
            "migration_type": migration_type,
            "source": source_registry,
            "target": target_registry,
            "status": "pending",
        }
    
        # Add specific migration parameters
        if migration_type == "single_schema":
            result["schema_name"] = responses.get("schema_name")
            result["version"] = responses.get("version", "latest")
        elif migration_type == "bulk_migration":
            result["pattern"] = responses.get("schema_pattern")
            result["include_all_versions"] = responses.get("include_all_versions")
            result["context_filter"] = responses.get("context_filter")
        elif migration_type == "context_migration":
            result["source_context"] = responses.get("source_context")
            result["include_dependencies"] = responses.get("include_dependencies")
    
        # Add migration options
        result["options"] = {
            "preserve_ids": responses.get("preserve_ids") == "true",
            "conflict_resolution": responses.get("conflict_resolution"),
            "create_backup": responses.get("create_backup") == "true",
            "dry_run": responses.get("dry_run") == "true",
        }
    
        return result
Behavior2/5

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

No annotations are provided, so the description carries full burden. It mentions starting a 'workflow' and 'wizard', implying an interactive or step-by-step process, but doesn't disclose behavioral traits like whether it's read-only or destructive, what permissions are needed, if it's asynchronous, or what the expected output entails. This is inadequate for a tool that likely initiates significant operations.

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?

The description is a single, efficient sentence that front-loads the core action ('Start the Schema Migration Wizard workflow'). It avoids unnecessary words, though it could be slightly more informative without sacrificing brevity.

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?

Given the tool likely initiates a complex migration workflow with no annotations, the description is minimal. It mentions a 'wizard' and 'workflow', hinting at interactivity, but lacks details on behavior, output, or error handling. The presence of an output schema helps, but the description doesn't leverage this to provide context, making it incomplete for safe agent use.

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

Parameters4/5

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

The tool has 0 parameters with 100% schema description coverage, so the schema fully documents the lack of inputs. The description doesn't need to add parameter details, and it correctly implies no required inputs by not mentioning any. A baseline of 4 is appropriate as it avoids redundancy.

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 states the tool 'Start[s] the Schema Migration Wizard workflow for guided schema migration', which provides a clear verb ('Start') and resource ('Schema Migration Wizard workflow'). However, it doesn't distinguish this from sibling tools like 'bulk_schema_migration' or 'guided_schema_evolution', leaving the specific scope of 'guided' versus other migration approaches unclear.

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?

The description offers no guidance on when to use this tool versus alternatives. With siblings like 'bulk_schema_migration' and 'guided_schema_evolution', there's no indication of prerequisites, target scenarios, or exclusions, leaving the agent to guess based on tool names alone.

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

Related 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/aywengo/kafka-schema-reg-mcp'

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