QR Service

A Model Context Protocol (MCP) service implementation that can be used by AI models to generate QR codes.

Features

• QR code generation tool for AI models
• MCP protocol compliant server
• RESTful API endpoint
• Easy deployment

Getting Started

Prerequisites

• Node.js (version 14 or higher)
• npm

Installation

npm install

Running Locally

npm start

The service will be available at http://localhost:7997

Development Mode

npm run dev

Running with npx (if installed globally or linked locally)

npx qr-service

Or if linked locally:

qr-service

MCP Endpoint

• POST /mcp - Main MCP endpoint for AI model communication

API Endpoints

• GET / - Service information
• GET /health - Health check endpoint

MCP Tools

generate_qr_code

Generates a QR code for a given URL.

Parameters:

• url (string, required): The URL to encode in the QR code
• size (integer, optional): Size of the QR code image (default: 200)

Example usage:

{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "generate_qr_code",
    "arguments": {
      "url": "https://www.baidu.com",
      "size": 300
    }
  }
}

Deployment

To deploy this service publicly:

1. Choose a hosting platform (cloud server, Heroku, etc.)
2. Install Node.js on the server
3. Copy the project files to the server
4. Run npm install to install dependencies
5. Configure firewall to allow traffic on port 7997 (or your chosen port)
6. Start the service with npm start
7. (Optional) Set up a reverse proxy like Nginx for production use
8. (Optional) Configure a domain name pointing to your server