@open-qr/mcp 1.0.0

package/README.md

@@ -0,0 +1,54 @@
+# @open-qr/mcp
+
+MCP server for [OpenQR](https://openqr.uk): generate QR codes and create, edit
+and track dynamic (editable) QR codes with scan analytics.
+
+A thin stdio-to-HTTP bridge: it forwards MCP traffic between your client and the
+hosted endpoint at `https://openqr.uk/mcp`. No tools are implemented here, so
+the tool list always matches what the server exposes (currently 17 tools, 4
+prompts, 5 resources).
+
+## Setup
+
+1. Get a free API key at [openqr.uk/api](https://openqr.uk/api).
+2. Point your MCP client at the command below with the key in the environment.
+
+```json
+{
+  "mcpServers": {
+    "openqr": {
+      "command": "npx",
+      "args": ["-y", "@open-qr/mcp"],
+      "env": { "OPENQR_API_KEY": "oqr_..." }
+    }
+  }
+}
+```
+
+Prefer the hosted endpoint directly? Most remote-capable clients (Claude Web,
+Claude Desktop, Cursor, Cline) can connect to `https://openqr.uk/mcp` over
+streamable HTTP with a `Bearer` Authorization header, no bridge needed.
+
+## Environment
+
+| Variable | Required | Purpose |
+| --- | --- | --- |
+| `OPENQR_API_KEY` | yes | Bearer key from [openqr.uk/api](https://openqr.uk/api) |
+| `OPENQR_MCP_URL` | no | Override the endpoint (default `https://openqr.uk/mcp`) |
+
+## Verify
+
+With a real key in the environment:
+
+```bash
+npm install
+OPENQR_API_KEY=oqr_... node verify.mjs
+```
+
+That runs the full round-trip a client would: initialize, list tools, list
+prompts and resources, generate a QR, and make an authenticated dynamic-code
+call.
+
+## Licence
+
+AGPL-3.0-only, same as the repository.

package/index.js

@@ -0,0 +1,63 @@
+#!/usr/bin/env node
+// Bridge a local stdio MCP client to the hosted OpenQR MCP endpoint
+// (https://openqr.uk/mcp, streamable HTTP, Bearer API key).
+//
+// The bridge is transparent: every JSON-RPC message the client writes to
+// stdio is forwarded to the remote session verbatim, and every message the
+// remote sends back is written to stdio. Nothing is buffered, filtered or
+// re-implemented, so the tool list stays exactly what the server exposes.
+//
+// Usage: OPENQR_API_KEY=oqr_... npx -y @open-qr/mcp
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
+
+const url = process.env.OPENQR_MCP_URL ?? "https://openqr.uk/mcp";
+const key = process.env.OPENQR_API_KEY;
+
+if (!key) {
+  console.error(
+    "OPENQR_API_KEY is required. Get a free key at https://openqr.uk/api"
+  );
+  process.exit(1);
+}
+
+const remote = new StreamableHTTPClientTransport(new URL(url), {
+  requestInit: { headers: { Authorization: `Bearer ${key}` } },
+});
+const stdio = new StdioServerTransport();
+
+let warned = false;
+remote.onerror = (error) => {
+  // A 401 from the remote surfaces here as a generic stream error; say the
+  // useful thing once instead of the SDK's raw message.
+  if (!warned && /401|unauthorized|forbidden/i.test(String(error))) {
+    warned = true;
+    console.error(
+      "OpenQR rejected the API key. Check OPENQR_API_KEY (free key: https://openqr.uk/api)."
+    );
+  }
+  console.error(String(error));
+};
+stdio.onerror = (error) => console.error(String(error));
+
+remote.onmessage = (message) => stdio.send(message);
+stdio.onmessage = (message) => remote.send(message);
+
+let closing = false;
+const close = async () => {
+  if (closing) return;
+  closing = true;
+  for (const transport of [stdio, remote]) {
+    try {
+      await transport.close();
+    } catch {
+      // already closed or never opened; nothing to do
+    }
+  }
+  process.exit(0);
+};
+process.on("SIGINT", close);
+process.on("SIGTERM", close);
+
+await remote.start();
+await stdio.start();

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@open-qr/mcp",
+  "version": "1.0.0",
+  "description": "MCP server for OpenQR (https://openqr.uk): generate QR codes and create, edit and track dynamic (editable) QR codes with scan analytics. Bridges stdio MCP clients to the hosted endpoint.",
+  "license": "AGPL-3.0-only",
+  "type": "module",
+  "bin": {
+    "openqr-mcp": "index.js"
+  },
+  "files": [
+    "index.js",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/open-qr/openqr.git",
+    "directory": "mcp"
+  },
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "qr-code",
+    "qr",
+    "dynamic-qr",
+    "openqr"
+  ],
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.30.0"
+  }
+}