qrkit

command module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 19, 2025 License: MIT Imports: 1 Imported by: 0

README

qrkit

Release CI Docker Image

QR code generation tools for MCP-enabled LLM clients.

A Model Context Protocol (MCP) server for generating QR codes. Built with Go, the MCP Go SDK, and go-qrcode, qrkit enables AI assistants to generate QR codes from any data.

Features

  • QR Code Generation: Generate QR codes from URLs, WiFi credentials, text, or any data for easy sharing
  • Dual Transport Modes:
    • STDIO Mode: For local MCP client integration (default)
    • HTTP Streamable Mode: For remote access and web-based clients
  • Multiple Deployment Options:
    • Pre-built executables for Linux, macOS, and Windows
    • Docker container support
  • Lightweight: Built with Go for minimal resource usage
  • Cross-platform: Supports Linux, macOS, and Windows

Planned features:

  • Generate QR codes in batch mode
  • Generate custom QR codes

Example Prompts for Usage within MCP-enabled LLM clients:

Generate a QR code for https://github.com/aidanuno/qrkit
Create a QR code for my WiFi, "MyNetwork" with password "password123"

Installation

Option 1: Install with Go
go install github.com/aidanuno/qrkit@latest
Option 2: Docker

Usage

STDIO Transport Mode (Default)

STDIO mode is designed for local MCP clients like Claude Desktop, VSCode, or other MCP-compatible applications. Simply copy the configuration below into your MCP client's configuration file.

After Go installation
{
  "mcpServers": {
    "qrkit": {
      "command": "qrkit"
    }
  }
}
With docker image
{
  "mcpServers": {
    "qrkit": {
      "command": "docker",
      "args": ["run", "-i", "ghcr.io/aidanuno/qrkit:latest"]
    }
  }
}
HTTP Streamable Transport Mode

HTTP mode enables remote access and integration with web-based MCP clients.

After Go installation
qrkit --port 3000
With docker image
docker run -p 3000:3000 ghcr.io/aidanuno/qrkit:latest --port 3000

The server will be accessible at http://localhost:3000.

HTTP Mode Configuration

For MCP clients that support HTTP Streamable transport, configure the endpoint:

{
  "mcpServers": {
    "qrkit": {
      "url": "http://localhost:3000"
    }
  }
}

License

MIT License - see LICENSE.md for details

Contributing

Contributions are welcome!

Acknowledgments

Built with:

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
qr

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL