Metadata-Version: 2.4
Name: amzqr-mcp
Version: 0.1.0
Summary: MCP Server for amazing-qr
Author-email: "x.hw" <xhw.xu@outlook.com>
Project-URL: Homepage, https://github.com/x-hw/amzqr-mcp
Project-URL: Source, https://github.com/x-hw/amzqr-mcp
Project-URL: Issues, https://github.com/x-hw/amzqr-mcp/issues
Project-URL: CI, https://github.com/x-hw/amzqr-mcp/actions
Keywords: qr,qrcode,amazing-qr,amzqr,mcp,fastmcp
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: amzqr>=0.1.0
Requires-Dist: fastmcp>=3.4.7

# amzqr-mcp

MCP server that wraps [amazing-qr](https://github.com/x-hw/amazing-qr) and exposes
QR-code generation as a Model Context Protocol (MCP) tool for any MCP client.

[![CI](https://github.com/x-hw/amzqr-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/x-hw/amzqr-mcp/actions/workflows/ci.yml)
[![PyPI version](https://img.shields.io/pypi/v/amzqr-mcp.svg)](https://pypi.org/project/amzqr-mcp/)
[![Python versions](https://img.shields.io/pypi/pyversions/amzqr-mcp.svg)](https://pypi.org/project/amzqr-mcp/)

## Capabilities

- `generate` — Generates a QR-code image file from text (a URL or sentence),
  with the full amazing-qr feature set: QR version, error-correction level,
  embedded picture, colorized output, contrast/brightness tuning, and custom
  output file name and directory. Returns the QR version, level, and output
  filepath. For the parameter reference and usage examples, see the
  [amazing-qr project](https://github.com/x-hw/amazing-qr).
- `data://info` — Read-only resource returning the server and amzqr versions
  as JSON.

## Quick start

Configure or register the server in your MCP client. Here are examples for
common agents.

### Desktop agents

**Claude Desktop** — add the server to `claude_desktop_config.json`:

```json
{
  "mcpServers": {
    "amazing-qr": {
      "command": "uvx",
      "args": ["amzqr-mcp"]
    }
  }
}
```

**Cursor** — create `.cursor/mcp.json` in your project (or
`~/.cursor/mcp.json` for all projects) and add config above.

### CLI agents

Prefer the agent's own command over editing config files by hand.

**Codex**:

```bash
codex mcp add amazing-qr -- uvx amzqr-mcp
```

**Claude Code**:

```bash
claude mcp add amazing-qr -- uvx amzqr-mcp
```

Run
`codex mcp list` or `claude mcp list` to verify the server is connected.

Then ask your MCP client to generate a QR code. The `generate` tool writes an
image file (default `qrcode.png`) and reports its path.
