English Français العربية

InkRelay

السجل الرسمي الإنتاجية

Print PDFs, ZPL labels and ESC/POS receipts on your printers and follow print jobs via InkRelay

الشيفرة المصدرية الموقع التوثيق

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

NPM package @inkrelay/mcp
Claude Code 
claude mcp add inkrelay -e 'INKRELAY_API_KEY=<your inkrelay_api_key>' -e 'INKRELAY_FILE_ROOT=<INKRELAY_FILE_ROOT>' -- npx -y @inkrelay/mcp@0.1.1
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "inkrelay": {
            "command": "npx",
            "args": [
                "-y",
                "@inkrelay/mcp@0.1.1"
            ],
            "env": {
                "INKRELAY_API_KEY": "<your inkrelay_api_key>",
                "INKRELAY_FILE_ROOT": "<INKRELAY_FILE_ROOT>"
            }
        }
    }
}

متغيرات البيئة

  • INKRELAY_API_KEY إلزامي سري InkRelay API key from app.inkrelay.app/api-keys. ir_test_ keys print only to free virtual printers.
  • INKRELAY_FILE_ROOT Folder that filePath arguments must stay inside. Defaults to the working directory.

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. InkRelay AI kit
  2. Quick start
  3. What InkRelay does
  4. Links
  5. License

InkRelay AI kit

MCP server, Agent Skill and Claude Code plugin for InkRelay, a cloud printing API. Use them to let an AI assistant print on your printers, or to have a coding agent add printing to your app.

PieceUse it toInstall
@inkrelay/mcpList printers, print PDFs, ZPL labels and ESC/POS receipts, follow jobs, manage webhooks from an MCP clientnpx -y @inkrelay/mcp
inkrelay-printing skillGive a coding agent the API rules, SDK usage, webhook verification and raw printing detailsClaude Code plugin, or copy the folder
inkrelay-integrator agentAdd printing to a project: SDK, config, print module, webhook route, tests, one test printClaude Code plugin
Docs MCP serverSearch the InkRelay docs from an MCP clienthttps://docs.inkrelay.app/mcp
AGENTS.md snippetGive agents without skills the same rulesPaste into AGENTS.md, CLAUDE.md or Cursor rules

Quick start

  1. Sign in at app.inkrelay.app and create a key under API keys. A test key (ir_test_...) prints only to four virtual printers (A4 laser, Letter color, 80 mm receipt, 4x6 label) and costs nothing.
  2. Add the MCP server to Claude Code (other clients are in mcp/README.md):
     claude mcp add-json inkrelay '{"command":"npx","args":["-y","@inkrelay/mcp"],"env":{"INKRELAY_API_KEY":"ir_test_your_key"}}'
  3. Ask: "Print https://inkrelay.app/sample.pdf on Test A4 Laser and tell me when it is done."
Claude Code plugin

Installs the MCP server, the docs MCP server, the skill and the agent together. Set INKRELAY_API_KEY in your shell, start Claude Code and run:

/plugin marketplace add GauravBR/inkrelay-ai
/plugin install inkrelay@inkrelay

Then ask, for example: "Add label printing to this app with InkRelay."

Skill only

Copy plugins/inkrelay/skills/inkrelay-printing into your agent's skills folder (for Claude Code, .claude/skills/ in the project or ~/.claude/skills/). It uses the Agent Skills format (SKILL.md with name and description), so other agents that read that format can load it too.

What InkRelay does

  • An agent runs as a system service on Windows, macOS or Linux (including Raspberry Pi) next to the printers. It connects out on port 443 and keeps a WebSocket to api.inkrelay.app, so nothing needs to be opened on the network.
  • Your code sends POST /v1/printjobs with a printer id and a PDF (URL or base64) or raw bytes (ZPL, ESC/POS). The job is sent to the agent as soon as it is stored. Test jobs reach done in about 3 seconds.
  • Each job reports queued, sent, received, printing, then done or error with the operating system's message, and keeps its event history.
  • Webhooks are signed in the Standard Webhooks format (HMAC), cover 15 event types, retry for about 27 hours and can be replayed.
  • Idempotency-Key on job creation makes retries safe. The limit is 20 requests per second per key.
  • SDKs: @inkrelay/sdk (npm) and inkrelay (PyPI). OpenAPI 3.1 spec and a Postman collection.
  • Request fields match PrintNode's, so PrintNode integrations move with a base URL and id change (migration guide).
  • Test mode is free. The Lite plan includes 50 live prints a month on one computer (pricing).

License

MIT

الأسئلة الشائعة

ما هو InkRelay؟

Print PDFs, ZPL labels and ESC/POS receipts on your printers and follow print jobs via InkRelay

كيف أثبّت InkRelay؟

يعمل على جهازك. في Claude Code: claude mcp add inkrelay -e 'INKRELAY_API_KEY=<your inkrelay_api_key>' -e 'INKRELAY_FILE_ROOT=<INKRELAY_FILE_ROOT>' -- npx -y @inkrelay/mcp@0.1.1. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج InkRelay إلى مفتاح API؟

نعم. يتطلب INKRELAY_API_KEY، وتضبطها في إعداداته.

هل InkRelay مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون InkRelay؟

ينشره GauravBR. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.