Kafka Schema Registry MCP Server

by aywengo

32 385 downloads Not rated yet MIT
GitHub

About

A comprehensive Message Control Protocol (MCP) server for Kafka Schema Registry.

Details

License
MIT

Explore

docker run -e SCHEMA_REGISTRY_URL=http://localhost:8081 aywengo/kafka-schema-reg-mcp:stable
``

- 🤖 Claude Desktop Integration - Direct MCP integration with natural language interface
- 🏢 Multi-Registry Support - Manage up to 8 Schema Registry instances simultaneously
- 📋 Schema Contexts - Logical grouping for production/staging environment isolation
- 🔄 Schema Migration - Cross-registry migration with backup and verification
- 📊 Comprehensive Export - JSON, Avro IDL formats for backup and documentation
- 🔒 Production Safety - VIEWONLY mode and per-registry access control
- 🔐 OAuth 2.1 Authentication - Enterprise-grade security with scope-based permissions
- 📈 Real-time Progress - Async operations with progress tracking and cancellation
- 🔗 Resource Linking - HATEOAS navigation with enhanced tool responses
- 🧪 Full MCP Compliance - 50+ tools following MCP 2025-06-18 specification
- 🚀 SLIM_MODE - Reduce tool overhead from 50+ to ~9 essential tools for better LLM performance

> 📖 See detailed feature descriptions: docs/api-reference.md

- ✅ Natural language schema generation with templates
- ✅ Automatic compatibility checking (BACKWARD, FORWARD, FULL)
- ✅ Migration planning with rollback procedures
- ✅ Pre-commit and pre-push quality automation
- ✅ Integration with Black, Ruff, isort, Flake8
- ✅ Docker-based test execution
- ✅ Comprehensive error handling and auto-fix

Try it now: /schema-generate event TestEvent "test with id and timestamp"`

- VIEWONLY Mode - Prevent accidental changes in production
- URL Validation - SSRF protection with configurable localhost access
- Scope-based Authorization - Fine-grained tool-level permissions
- Per-Registry Controls - Independent safety settings

> 📖 Security guide: docs/deployment.md#security

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Kafka Schema Registry MCP Server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Copy a ready-to-use configuration from config-examples/:


Quick Start: Read .claude-code/SKILLS_GUIDE.md - 5-minute tutorial

Complete Reference: .claude-code/skills/README.md - Full documentation


Setup Summary: .claude-code/skills/README.md - Configuration details


To reduce LLM overhead, run with SLIM_MODE enabled:
bash

Pre-configured examples available in config-examples/:

| Configuration | Use Case | File |
|---------------|----------|------|
| Production | Stable Docker deployment | claude_desktop_stable_config.json |
| Multi-Environment | DEV/STAGING/PROD registries | claude_desktop_multi_registry_docker.json |
| Local Development | Python local execution | claude_desktop_config.json |
| View-Only Safety | Production with safety | claude_desktop_viewonly_config.json |

> 📖 Complete configuration guide: config-examples/README.md

SLIM_MODE reduces the number of exposed MCP tools to an essential subset, significantly reducing LLM overhead and improving response times.

> 💡 Recommendation: SLIM_MODE is recommended for most use cases as it provides all essential schema management capabilities with optimal performance.

export ENABLE_AUTH=true
export AUTH_ISSUER_URL="https://your-oauth-provider.com"
export AUTH_AUDIENCE="your-client-id"



Supported Providers: Azure AD, Google OAuth, Keycloak, Okta, GitHub


Permission Scopes:

- read - View schemas, configurations

- write - Register schemas, update configs (includes read)

- admin - Delete subjects, full control (includes write + read)
bash
cd tests/
./run_all_tests.sh --quick # Essential tests
./run_all_tests.sh # Complete test suite
bash
git clone https://github.com/aywengo/kafka-schema-reg-mcp
cd kafka-schema-reg-mcp
python -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt
python kafka_schema_registry_unified_mcp.py
```

ping

Server health check

set_default_registry

, `get_default_registry` - Registry management

count_contexts

, `count_schemas`, `count_schema_versions` - Statistics

register_schema

Register new schemas

check_compatibility

Schema compatibility checking

create_context

Create new contexts

export_schema

Export single schema

export_subject

Export all subject versions

list_registries

✅

get_registry_info

✅

test_registry_connection

✅

test_all_registries

✅

list_subjects

✅

get_schema

✅

get_schema_versions

✅

get_global_config

✅

get_mode

✅

list_contexts

✅

get_subject_config

✅

get_subject_mode

✅

docker run -e SCHEMA_REGISTRY_URL=http://localhost:8081 -e SLIM_MODE=true aywengo/kafka-schema-reg-mcp:stable

docker run -e SCHEMA_REGISTRY_URL=http://localhost:8081 -e SLIM_MODE=true aywengo/kafka-schema-reg-mcp:stable
``

> 💡 SLIM_MODE Benefits:
> - Reduces tool count to an essential subset
> - Significantly faster LLM response times
> - Lower token usage and reduced costs
> - Ideal for production read-only operations
> - Maintains full remote deployment support

Essential Read-Only Tools:
- ping - Server health check
- set_default_registry, get_default_registry - Registry management
- count_contexts, count_schemas, count_schema_versions - Statistics

Basic Write Operations:
- register_schema - Register new schemas
- check_compatibility - Schema compatibility checking
- create_context - Create new contexts

Essential Export Operations:
- export_schema - Export single schema
- export_subject - Export all subject versions

Resources Available (All Modes):
- All 19 resources remain available in SLIM_MODE
- registry://, schema://, subject:// resource URIs
- Full read access through resource-first approach

Tools Hidden in SLIM_MODE:
- All migration tools (migrate_schema, migrate_context)
- All batch operations (clear_context_batch)
- Advanced export/import tools (export_context, export_global)
- All interactive/elicitation tools (*_interactive variants)
- Heavy statistics tools with async operations
- Workflow tools
- Configuration update tools
- Delete operations

> Note: Task status tracking is now handled by FastMCP's built-in Docket system. Custom task management tools have been removed in favor of FastMCP's native task tracking.

> Note: You can switch between modes by restarting with SLIM_MODE=false to access the full tool set.

This section provides a comprehensive analysis of all MCP tools and resources exposed by the Kafka Schema Registry MCP Server.

These tools are maintained for backward compatibility with existing clients. They internally use efficient implementations but are exposed as tools to prevent "Tool not listed" errors. Consider migrating to the corresponding resources for better performance.

| Tool Name | SLIM_MODE | Scope | Recommended Resource | Description |
|---------------|---------------|-----------|--------------------------|-----------------|
| list_registries | ✅ | read | registry://names | List all configured registries |
| get_registry_info | ✅ | read | registry://info/{name} | Get registry information |
| test_registry_connection | ✅ | read | registry://status/{name} | Test registry connection |
| test_all_registries | ✅ | read | registry://status | Test all registry connections |
| list_subjects | ✅ | read | registry://{name}/subjects | List all subjects |
| get_schema | ✅ | read | schema://{name}/{context}/{subject} | Get schema content |
| get_schema_versions | ✅ | read | schema://{name}/{context}/{subject}/versions | Get schema versions |
| get_global_config | ✅ | read | registry://{name}/config | Get global configuration |
| get_mode | ✅ | read | registry://mode | Get registry mode |
| list_contexts | ✅ | read | registry://{name}/contexts | List all contexts |
| get_subject_config | ✅ | read | subject://{name}/{context}/{subject}/config | Get subject configuration |
| get_subject_mode | ✅ | read | subject://{name}/{context}/{subject}/mode | Get subject mode |

| Category | Name | Type | SLIM_MODE | Scope | Description |
|--------------|----------|----------|---------------|-----------|-----------------|
| Core | ping | Tool | ✅ | read | MCP ping/pong health check |
| Registry Management | set_default_registry | Tool | ✅ | admin | Set default registry |
| Registry Management | get_default_registry | Tool | ✅ | read | Get current default registry |
| Schema Operations | register_schema | Tool | ✅ | write | Register new schema version |
| Schema Operations | check_compatibility | Tool | ✅ | read | Check schema compatibility |
| Context Management | create_context | Tool | ✅ | write | Create new context |
| Context Management | delete_context | Tool | ❌ | admin | Delete context |
| Subject Management | delete_subject | Tool | ❌ | admin | Delete subject and versions |
| Configuration | update_global_config | Tool | ❌ | admin | Update global configuration |
| Configuration | update_subject_config | Tool | ❌ | admin | Update subject configuration |
| Configuration | add_subject_alias | Tool | ❌ | write | Create alias subject pointing to an existing subject |
| Configuration | delete_subject_alias | Tool | ❌ | write | Remove an alias subject |
| Mode Management | update_mode | Tool | ❌ | admin | Update registry mode |
| Mode Management | update_subject_mode | Tool | ❌ | admin | Update subject mode |
| Statistics | count_contexts | Tool | ✅ | read | Count contexts |
| Statistics | count_schemas | Tool | ✅ | read | Count schemas |
| Statistics | count_schema_versions | Tool | ✅ | read | Count schema versions |
| Statistics | get_registry_statistics | Tool | ❌ | read | Get comprehensive registry stats |
| Export | export_schema | Tool | ✅ | read | Export single schema |
| Export | export_subject | Tool | ✅ | read | Export all subject versions |
| Export | export_context | Tool | ❌ | read | Export all context subjects |
| Export | export_global | Tool | ❌ | read | Export all contexts/schemas |
| Export | export_global_interactive | Tool | ❌ | read | Interactive global export |
| Migration | migrate_schema | Tool | ❌ | admin | Migrate schema between registries |
| Migration | migrate_context | Tool | ❌ | admin | Migrate context between registries |
| Migration | migrate_context_interactive | Tool | ❌ | admin | Interactive context migration |
| Comparison | compare_registries | Tool | ❌ | read | Compare two registries |
| Comparison | compare_contexts_across_registries | Tool | ❌ | read | Compare contexts across registries |
| Comparison | find_missing_schemas | Tool | ❌ | read | Find missing schemas |
| Batch Operations | clear_context_batch | Tool | ❌ | admin | Clear context with batch operations |
| Batch Operations | clear_multiple_contexts_batch | Tool | ❌ | admin | Clear multiple contexts |
| Interactive | register_schema_interactive | Tool | ❌ | write | Interactive schema registration |
| Interactive | check_compatibility_interactive | Tool | ❌ | read | Interactive compatibility check |
| Interactive | create_context_interactive | Tool | ❌ | write | Interactive context creation |
| Resource Discovery | list_available_resources | Tool | ✅ | read | List all available resources |
| Resource Discovery | suggest_resource_for_tool | Tool | ✅ | read | Get resource migration suggestions |
| Resource Discovery | generate_resource_templates | Tool | ✅ | read | Generate resource URI templates |
| Elicitation | submit_elicitation_response | Tool | ❌ | write | Submit elicitation response |
| Elicitation | list_elicitation_requests | Tool | ❌ | read | List elicitation requests |
| Elicitation | get_elicitation_request | Tool | ❌ | read | Get elicitation request details |
| Elicitation | cancel_elicitation_request | Tool | ❌ | admin | Cancel elicitation request |
| Elicitation | get_elicitation_status | Tool | ❌ | read | Get elicitation system status |
| Workflows | list_available_workflows | Tool | ❌ | read | List available workflows |
| Workflows | get_workflow_status | Tool | ❌ | read | Get workflow status |
| Workflows | guided_schema_migration | Tool | ❌ | admin | Start schema migration wizard |
| Workflows | guided_context_reorganization | Tool | ❌ | admin | Start context reorganization wizard |
| Workflows | guided_disaster_recovery | Tool | ❌ | admin | Start disaster recovery wizard |
| Utility | get_mcp_compliance_status_tool | Tool | ❌ | read | Get MCP compliance status |
| Utility | get_oauth_scopes_info_tool | Tool | ❌ | read | Get OAuth scopes information |
| Utility | test_oauth_discovery_endpoints | Tool | ❌ | read | Test OAuth discovery endpoints |
| Utility | get_operation_info_tool | Tool | ❌ | read | Get operation metadata |
| Utility | check_viewonly_mode | Tool | ❌ | read | Check if registry is in viewonly mode |
| RESOURCES | registry://status | Resource | ✅ | read | Overall registry connection status |
| RESOURCES | registry://info | Resource | ✅ | read | Detailed server configuration |
| RESOURCES | registry://mode | Resource | ✅ | read | Registry mode detection |
| RESOURCES | registry://names | Resource | ✅ | read | List of configured registry names |
| RESOURCES | registry://status/{name} | Resource | ✅ | read | Specific registry connection status |
| RESOURCES | registry://info/{name} | Resource | ✅ | read | Specific registry configuration |
| RESOURCES | registry://mode/{name} | Resource | ✅ | read | Specific registry mode |
| RESOURCES | registry://{name}/subjects | Resource | ✅ | read | List subjects for registry |
| RESOURCES | registry://{name}/contexts | Resource | ✅ | read | List contexts for registry |
| RESOURCES | registry://{name}/config | Resource | ✅ | read | Global config for registry |
| RESOURCES | schema://{name}/{context}/{subject} | Resource | ✅ | read | Schema content with context |
| RESOURCES | schema://{name}/{subject} | Resource | ✅ | read | Schema content default context |
| RESOURCES | schema://{name}/{context}/{subject}/versions | Resource | ✅ | read | Schema versions with context |
| RESOURCES | schema://{name}/{subject}/versions | Resource | ✅ | read | Schema versions default context |
| RESOURCES | subject://{name}/{context}/{subject}/config | Resource | ✅ | read | Subject config with context |
| RESOURCES | subject://{name}/{subject}/config | Resource | ✅ | read | Subject config default context |
| RESOURCES | subject://{name}/{context}/{subject}/mode | Resource | ✅ | read | Subject mode with context |
| RESOURCES | subject://{name}/{subject}/mode | Resource | ✅ | read | Subject mode default context |
| RESOURCES | elicitation://response/{request_id}` | Resource | ❌ | write | Elicitation response handling |

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "kafka schema registry mcp server": {
            "kafka-schema-registry-multi": {
                "command": "docker",
                "args": [
                    "run",
                    "--rm",
                    "-i",
                    "--network",
                    "host",
                    "-e",
                    "SCHEMA_REGISTRY_NAME_1",
                    "-e",
                    "SCHEMA_REGISTRY_URL_1",
                    "-e",
                    "SCHEMA_REGISTRY_USER_1",
                    "-e",
                    "SCHEMA_REGISTRY_PASSWORD_1",
                    "-e",
                    "READONLY_1",
                    "-e",
                    "SCHEMA_REGISTRY_NAME_2",
                    "-e",
                    "SCHEMA_REGISTRY_URL_2",
                    "-e",
                    "SCHEMA_REGISTRY_USER_2",
                    "-e",
                    "SCHEMA_REGISTRY_PASSWORD_2",
                    "-e",
                    "READONLY_2",
                    "aywengo/kafka-schema-reg-mcp:stable",
                    "python",
                    "kafka_schema_registry_unified_mcp.py"
                ],
                "env": {
                    "SCHEMA_REGISTRY_NAME_1": "<NAME of SR 1>",
                    "SCHEMA_REGISTRY_URL_1": "<URL of SR  1>",
                    "SCHEMA_REGISTRY_USER_1": "",
                    "SCHEMA_REGISTRY_PASSWORD_1": "",
                    "READONLY_1": "false",
                    "SCHEMA_REGISTRY_NAME_2": "<NAME of SR 2>",
                    "SCHEMA_REGISTRY_URL_2": "<URL of SR 2>",
                    "SCHEMA_REGISTRY_USER_2": "",
                    "SCHEMA_REGISTRY_PASSWORD_2": "",
                    "READONLY_2": "false"
                }
            }
        }
    }
}

McpServers

{
    "kafka-schema-registry-multi": {
        "command": "docker",
        "args": [
            "run",
            "--rm",
            "-i",
            "--network",
            "host",
            "-e",
            "SCHEMA_REGISTRY_NAME_1",
            "-e",
            "SCHEMA_REGISTRY_URL_1",
            "-e",
            "SCHEMA_REGISTRY_USER_1",
            "-e",
            "SCHEMA_REGISTRY_PASSWORD_1",
            "-e",
            "READONLY_1",
            "-e",
            "SCHEMA_REGISTRY_NAME_2",
            "-e",
            "SCHEMA_REGISTRY_URL_2",
            "-e",
            "SCHEMA_REGISTRY_USER_2",
            "-e",
            "SCHEMA_REGISTRY_PASSWORD_2",
            "-e",
            "READONLY_2",
            "aywengo/kafka-schema-reg-mcp:stable",
            "python",
            "kafka_schema_registry_unified_mcp.py"
        ],
        "env": {
            "SCHEMA_REGISTRY_NAME_1": "<NAME of SR 1>",
            "SCHEMA_REGISTRY_URL_1": "<URL of SR  1>",
            "SCHEMA_REGISTRY_USER_1": "",
            "SCHEMA_REGISTRY_PASSWORD_1": "",
            "READONLY_1": "false",
            "SCHEMA_REGISTRY_NAME_2": "<NAME of SR 2>",
            "SCHEMA_REGISTRY_URL_2": "<URL of SR 2>",
            "SCHEMA_REGISTRY_USER_2": "",
            "SCHEMA_REGISTRY_PASSWORD_2": "",
            "READONLY_2": "false"
        }
    }
}

A comprehensive Model Context Protocol (MCP) server that provides Claude Desktop and other MCP clients with tools for Kafka Schema Registry operations. Features advanced schema context support, multi-registry management, and comprehensive schema export capabilities.

<table width="100%">
<tr>
<td width="33%" style="vertical-align: top;">
<div style="background-color: white; padding: 20px; border-radius: 10px;">
Kafka Schema Registry MCP Logo
</div>
</td>
<td width="67%" style="vertical-align: top; padding-left: 20px;">

> 🎯 True MCP Implementation: Uses modern FastMCP 2.8.0+ framework with full MCP 2025-06-18 specification compliance. Fully compatible with Claude Desktop and other MCP clients using JSON-RPC over stdio.

Latest Version: v2.1.5 | Docker: aywengo/kafka-schema-reg-mcp:stable
</td>
</tr>
</table>

📋 Table of Contents

- 🚀 Quick Start
- ✨ Key Features
- 🛠️ Claude Code Skills
- 📦 Installation
- ⚙️ Configuration
- 💬 Usage Examples
- 🔒 Authentication & Security
- 📚 Documentation
- 🧪 Testing
- 🚀 Deployment
- 🤝 Contributing
- 🆕 What's New

🚀 Quick Start

1. Run with Docker (Recommended)

```bash
No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

More like this

Similar MCP servers you might find useful

Browse category

Sequential Thinking

Sequential Thinking is an MCP server that provides a tool for dynamic and reflective problem-solving through a structured, step-by-step thinking process. It is…

— 88.2k 508.3k dl
Other

Sentry

Sentry MCP Server connects compatible AI clients with Sentry error monitoring, allowing models and agents to inspect issues and event data through Model…

— 88.1k 4.3k dl
Developer Tools

Github

GitHub MCP Server connects compatible AI clients with GitHub repositories, issues, and pull requests, allowing models and agents to read and act on project…

— 88.1k 9.9k dl
Developer Tools

Filesystem

Filesystem is a Node.js server that implements the Model Context Protocol (MCP) for filesystem operations. It enables AI assistants to read, write, and manage…

— 88.1k 6.7k dl
Other