Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| VIEWONLY | No | Enable read-only mode for production safety | false |
| SLIM_MODE | No | Reduce tool count from 57+ to ~9 essential tools for better performance | false |
| VIEWONLY_1 | No | Read-only mode for the first registry | |
| VIEWONLY_2 | No | Read-only mode for the second registry | |
| ENABLE_AUTH | No | Enable OAuth 2.1 authentication | |
| AUTH_AUDIENCE | No | OAuth audience/client ID | |
| AUTH_ISSUER_URL | No | OAuth provider issuer URL | |
| SCHEMA_REGISTRY_URL | No | The URL of the schema registry server | |
| SCHEMA_REGISTRY_USER | No | Optional authentication username for schema registry | |
| SCHEMA_REGISTRY_URL_1 | No | URL for the first registry in multi-registry mode | |
| SCHEMA_REGISTRY_URL_2 | No | URL for the second registry in multi-registry mode | |
| SCHEMA_REGISTRY_NAME_1 | No | Name for the first registry in multi-registry mode | |
| SCHEMA_REGISTRY_NAME_2 | No | Name for the second registry in multi-registry mode | |
| SCHEMA_REGISTRY_PASSWORD | No | Optional authentication password for schema registry |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| registry_names_resource | Get list of all configured registry names. |
| registry_info_resource | Get detailed server configuration and capabilities. |
| registry_status_resource | Get connection status for all registries. |
| registry_mode_resource | Get operational mode for all registries. |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| start_workflow | Start a multi-step workflow for complex Schema Registry operations |
| list_workflows | List available multi-step workflows |
| workflow_status | Get the status of active workflows |
| abort_workflow | Abort an active workflow |
| describe_workflow | Get detailed information about a workflow definition |
| guided_schema_evolution | Start the Schema Evolution Assistant workflow. This guided workflow helps you safely evolve schemas by analyzing changes, suggesting strategies, and coordinating consumer updates. |
| guided_schema_migration | Start the Schema Migration Wizard workflow for guided schema migration |
| guided_context_reorganization | Start the Context Reorganization workflow for reorganizing schemas across contexts |
| guided_disaster_recovery | Start the Disaster Recovery Setup workflow for configuring DR strategies |
| ping | Respond to MCP ping requests with pong. This tool implements the standard MCP ping/pong protocol for server health checking. MCP proxies and clients use this to verify that the server is alive and responding. |
| compare_registries | Compare two Schema Registry instances and show differences. |
| compare_contexts_across_registries | Compare contexts across two registries. |
| find_missing_schemas | Find schemas that exist in source registry but not in target registry. |
| list_available_resources | List all available MCP resources and their usage patterns. |
| suggest_resource_for_tool | Suggest the appropriate resource to use instead of a removed tool. |
| generate_resource_templates | Generate resource URI templates for your specific configuration. |
| list_registries | List all configured Schema Registry instances. NOTE: This tool is maintained for backward compatibility. Consider using the 'registry://names' resource instead for better performance. |
| get_registry_info | Get detailed information about a specific registry. NOTE: This tool is maintained for backward compatibility. Consider using the 'registry://info/{name}' resource instead for better performance. |
| test_registry_connection | Test connection to a specific registry. NOTE: This tool is maintained for backward compatibility. Consider using the 'registry://status/{name}' resource instead for better performance. |
| test_all_registries | Test connections to all configured registries. NOTE: This tool is maintained for backward compatibility. Consider using the 'registry://status' resource instead for better performance. |
| list_subjects | List all subjects, optionally filtered by context. NOTE: This tool is maintained for backward compatibility. Consider using the 'registry://{name}/subjects' resource instead for better performance. |
| get_schema | Get a specific version of a schema. NOTE: This tool is maintained for backward compatibility. Consider using the 'schema://{name}/{context}/{subject}' resource instead for better performance. |
| get_schema_versions | Get all versions of a schema for a subject. NOTE: This tool is maintained for backward compatibility. Consider using the 'schema://{name}/{context}/{subject}/versions' resource instead for better performance. |
| get_schema_by_id | Get a schema by its globally unique ID. Args: schema_id: The globally unique schema ID registry: Optional registry name (ignored in single-registry mode) Returns: Schema information including content, type, and metadata |
| get_subjects_by_schema_id | Get subjects and versions associated with a schema ID. Args: schema_id: The globally unique schema ID registry: Optional registry name (ignored in single-registry mode) Returns: List of subject-version pairs that use this schema ID |
| get_global_config | Get global configuration settings. NOTE: This tool is maintained for backward compatibility. Consider using the 'registry://{name}/config' resource instead for better performance. |
| get_mode | Get the current mode of the Schema Registry. NOTE: This tool is maintained for backward compatibility. Consider using the 'registry://mode' resource instead for better performance. |
| list_contexts | List all available schema contexts. NOTE: This tool is maintained for backward compatibility. Consider using the 'registry://{name}/contexts' resource instead for better performance. |
| get_subject_config | Get configuration settings for a specific subject. NOTE: This tool is maintained for backward compatibility. Consider using the 'subject://{name}/{context}/{subject}/config' resource instead for better performance. |
| get_subject_mode | Get the operational mode for a specific subject. NOTE: This tool is maintained for backward compatibility. Consider using the 'subject://{name}/{context}/{subject}/mode' resource instead for better performance. |
| register_schema | Register a new schema version. |
| register_schema_interactive | Interactive schema registration with elicitation for missing field definitions. When schema_definition is incomplete or missing fields, this tool will elicit the required information from the user interactively. |
| check_compatibility | Check if a schema is compatible with the latest version. |
| check_compatibility_interactive | Interactive compatibility checking with elicitation for resolution options. When compatibility issues are found, this tool will elicit resolution preferences from the user. |
| update_global_config | Update global configuration settings. |
| update_subject_config | Update configuration settings for a specific subject. |
| update_mode | Update the mode of the Schema Registry. |
| update_subject_mode | Update the mode for a specific subject. |
| create_context | Create a new schema context. |
| create_context_interactive | Interactive context creation with elicitation for metadata. When context metadata is not provided, this tool will elicit organizational information from the user. |
| delete_context | Delete a schema context. |
| delete_subject | Delete a subject and all its versions. Args: subject: The subject name to delete context: Optional schema context registry: Optional registry name permanent: If True, perform a hard delete (removes all metadata including schema ID) |
| export_schema | Export a single schema in the specified format. |
| export_subject | Export all versions of a subject. |
| export_context | Export all subjects within a context. |
| export_global | Export all contexts and schemas from a registry. |
| export_global_interactive | Interactive global export with elicitation for export preferences. When export preferences are not specified, this tool will elicit the required configuration from the user. |
| migrate_schema | Migrate a schema from one registry to another. |
| list_migrations | List all migration tasks and their status. |
| get_migration_status | Get detailed status of a specific migration. |
| migrate_context | Guide for migrating an entire context using Docker-based tools. |
| migrate_context_interactive | Interactive context migration with elicitation for missing preferences. When migration preferences are not specified, this tool will elicit the required configuration from the user. |
| clear_context_batch | Clear all subjects in a context using application-level batch operations. ⚠️ APPLICATION-LEVEL BATCHING: Uses individual requests per MCP 2025-06-18 compliance. |
| clear_multiple_contexts_batch | Clear multiple contexts in a registry using application-level batch operations. ⚠️ APPLICATION-LEVEL BATCHING: Uses individual requests per MCP 2025-06-18 compliance. |
| bulk_operations_wizard | Start the interactive Bulk Operations Wizard for admin tasks. Guides through safe execution of operations across multiple schemas. Supports schema updates, migrations, cleanup, and configuration changes. |
| bulk_schema_update | Update schemas in bulk with interactive guidance. Supports compatibility settings, naming conventions, and metadata updates. Pattern matching supported (e.g., test-, deprecated-). |
| bulk_schema_cleanup | Clean up schemas in bulk with safety checks. Detects active consumers and provides options for handling them. Supports test schema cleanup, deprecated schema removal, and version purging. |
| bulk_schema_migration | Migrate schemas between contexts or registries. Supports pattern-based selection and maintains schema IDs. Includes preview and rollback capabilities. |
| bulk_configuration_update | Update configuration settings across multiple schemas or contexts. Supports security policies, retention settings, and access controls. |
| count_contexts | Count the number of contexts in a registry. |
| count_schemas | Count the number of schemas in a context or registry. |
| count_schema_versions | Count the number of versions for a specific schema. |
| get_registry_statistics | Get comprehensive statistics about a registry. |
| list_elicitation_requests | List all pending elicitation requests. |
| get_elicitation_request | Get details of a specific elicitation request. |
| cancel_elicitation_request | Cancel a pending elicitation request. |
| get_elicitation_status | Get the status of the elicitation system. |
| submit_elicitation_response | Submit a response to an elicitation request. This tool handles both regular elicitation responses and multi-step workflow responses. When a workflow is in progress, it will automatically advance to the next step. |
| list_available_workflows | List all available multi-step workflows for complex operations. |
| get_workflow_status | Get the status of active workflows. |
| get_task_status | Get the status and progress of an async task. |
| get_task_progress | Get the progress of an async task (alias for get_task_status). |
| list_active_tasks | List all active tasks in the system. |
| cancel_task | Cancel a running task. |
| list_statistics_tasks | List all statistics-related tasks. |
| get_statistics_task_progress | Get detailed progress for a statistics task. |
| get_mcp_compliance_status_tool | Get MCP 2025-06-18 specification compliance status and configuration details. Returns information about JSON-RPC batching status, protocol version, header validation, and migration guidance. |
| set_default_registry | Set the default registry. |
| get_default_registry | Get the current default registry. |
| get_oauth_scopes_info_tool | Get information about OAuth scopes and permissions. |
| test_oauth_discovery_endpoints | Test OAuth discovery endpoints to ensure proper MCP client compatibility. Validates:
Args: server_url: Base URL of the MCP server (default: http://localhost:8000) Returns: Dictionary with test results for each discovery endpoint |
| get_operation_info_tool | Get detailed information about MCP operations and their metadata. |