Skip to main content

🔌 WKafka Model Context Protocol (MCP) Server

PyPI Version Python Version License: MIT

An advanced Model Context Protocol (MCP) server designed to enable AI coding assistants (like Gemini, Claude, Cursor, OpenCode, and Antigravity) to design, build, test, and adapt high-performance event-driven microservices based on WKafka (the standard Kafka orchestrator suite).


🎯 Why This MCP Server Exists

Building streaming pipelines and microservices with Kafka often requires complex configuration, custom serialization patterns, error-handling logic, and safety contexts (like SASL and SSL).

This MCP server acts as an expert assistant interface for AI agents. It equips them with the tools and domain-specific knowledge to:

  1. Instantly Scaffold production-ready Kafka services adhering to strict architectural structures.
  2. Generate clean code for JSON, raw images, and video stream consumers and producers.
  3. Adapt existing scripts automatically to run under Kafka message triggers.
  4. Validate Kafka connection configs to prevent hardcoded credentials or missing settings.

🛠️ Technologies and Ecosytem Libraries Used

This component is built using the following core technologies:

  • Python (>=3.10): Core programming language.
  • FastMCP: High-productivity framework for building Model Context Protocol servers in Python.
  • MCP CLI/SDK: Protocol implementations supporting integration with AI environments.
  • Pydantic (v2): Advanced data validation and settings schema definitions.
  • Pytest & Pytest-Cov: Testing framework and coverage reports.
  • Docker: For sandboxed unit test execution.

🚀 Installation & Setup

1. Install the Package

Install wkafka-mcp via PyPI:

pip install wkafka-mcp

2. Configure in your AI Agent Config

OpenCode Configuration

Add to your ~/.config/opencode/opencode.jsonc inside the "mcp" block:

    "wkafka-mcp": {
      "type": "local",
      "command": [
        "python",
        "-m",
        "wkafka_mcp.server",
        "run"
      ],
      "enabled": true
    }

Antigravity (agy) / Gemini CLI Configuration

Add to your global ~/.gemini/antigravity/mcp_config.json:

{
  "mcpServers": {
    "wkafka-mcp": {
      "command": "python",
      "args": [
        "-m",
        "wkafka_mcp.server",
        "run"
      ]
    }
  }
}

⚙️ Detailed MCP Tools List

The server exposes the following MCP tools to your agent:

Tool Name Arguments Description
get_wkafka_architect_blueprints None Returns production-ready consumer and producer patterns (JSON, images, video streaming, and SASL configuration).
get_wkafka_architect_manual None Returns the master manual covering project structure rules, module map, and monolith refactoring steps.
search_wkafka_pattern query: str Searches the catalog database for specific streaming patterns.
deploy_wkafka_scaffolding target_dir: str, project_name: str, scaffold_type: str Deploys a complete directory structure matching the requested scaffold (standard, vision_pipeline, or full_service).
generate_from_pattern pattern_name: str, target_dir: str Generates a project tailored from a specific catalog pattern name.
validate_kafka_config config_code: str Scans a configuration snippet for missing credentials or unsafe defaults.
generate_wkafka_consumer topic: str, format: str, key_filter: str, target_file: str Generates a custom worker trigger template.
generate_wkafka_producer topic: str, format: str, target_file: str Generates a custom producer message dispatcher template.
adapt_code_to_wkafka source_code: str, topic: str, value_type: str, group_id: str Automatically wraps any Python script (with or without main()) inside a WKafka consumer trigger.

🧪 Running the Tests

To ensure code stability and API contracts are preserved, a comprehensive unit test suite is included.

Run Locally (pytest)

# Install development dependencies
make install

# Execute the test suite
make test

Coverage Reports

To run the tests and calculate code coverage, execute the provided script:

./run_coverage.sh

Sandboxed Testing with Docker

To run the test suite in an isolated Python 3.13 environment container (independent of local packages):

./run_tests_docker.sh

Generated by WKafka MCP by wisrovi

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wkafka_mcp-0.2.0.tar.gz (23.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wkafka_mcp-0.2.0-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

Details for the file wkafka_mcp-0.2.0.tar.gz.

File metadata

  • Download URL: wkafka_mcp-0.2.0.tar.gz
  • Upload date:
  • Size: 23.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for wkafka_mcp-0.2.0.tar.gz
Algorithm Hash digest
SHA256 fc71fd403ff53d726de5cf7497c1e8112e72202c7c72a352a8129f803aab9ef8
MD5 12776425e2db1b8a7fa08084dfce3a2e
BLAKE2b-256 0244a1a0f89e3ba36aed4c4cd189fcbc1934b51a7cae75d9374c5216a21cc4ba

See more details on using hashes here.

File details

Details for the file wkafka_mcp-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: wkafka_mcp-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 18.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for wkafka_mcp-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b65cddeb94d9edacdf5b750b24080c16e979852f81fb76da9438296ade4aa90c
MD5 002a0f5ccfa6e74a1ea746c086a49589
BLAKE2b-256 69f79299206d99b3da31a9177e08918c98d49975588a7c20a44549764e9fca07

See more details on using hashes here.

Release history Release notifications | RSS feed

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.0

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

This release

0.2.0 This release

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page