mcpField
I
InkRelay

InkRelay

ローカル
docs.inkrelay.app生産性02 週間前に更新

InkRelay について

InkRelay は、InkRelay API を介してプリンターを操作する MCP サーバーです。PDF やプリンター言語ファイルの印刷、プリンターとジョブの状態確認、プリンターや Webhook の管理に対応します。

主な機能

  1. 01プリンターの一覧と詳細確認
  2. 02PDF と生の印刷データの印刷
  3. 03ジョブの追跡・待機・キャンセル
  4. 04保存済みジョブの再印刷
  5. 05Webhook と使用状況の管理

活用シーン

  1. 01指定した設定で請求書 PDF を印刷
  2. 02ZPL ラベルや ESC/POS レシートを送信
  3. 03失敗した印刷ジョブの原因を調査
  4. 04以前のジョブを再印刷

MCP 対応

InkRelay API の操作を MCP ツールとして公開し、プリンターの一覧表示と設定、印刷ジョブの送信、状態追跡、Webhook 管理に利用できます。

設定

ローカルサーバーの設定はどのクライアントでも共通です。コピーしてクライアントの MCP 設定ファイルに貼り付けてください。

mcp.json · 共通設定
{
"mcpServers": {
"gauravbr-inkrelay": {
"command": "npx",
"args": [
"-y",
"@inkrelay/mcp"
],
"env": {
"INKRELAY_API_KEY": "<INKRELAY_API_KEY>",
"INKRELAY_FILE_ROOT": "<INKRELAY_FILE_ROOT>"
}
}
}
}
起動コマンドnpx -y @inkrelay/mcp
設定が必要な環境変数
INKRELAY_API_KEYシークレットInkRelay API key from app.inkrelay.app/api-keys. ir_test_ keys print only to free virtual printers.
INKRELAY_FILE_ROOTFolder that filePath arguments must stay inside. Defaults to the working directory.

ローカルサーバーにはマシン上の実行環境(Node.js 18 以上など)が必要です。設定ファイルの場所はクライアントごとに異なります。

パッケージ
npm@inkrelay/mcp0.1.1

ツール

17

掲載時のツール一覧 · 2 週間前に更新

このツールにパラメーターはありません。

詳細

@inkrelay/mcp

InkRelay 印刷 API 用の MCP サーバーです。AI アシスタントから、プリンターの一覧を取得したり、Windows、macOS、Linux のコンピューターに接続されたプリンターで PDF、ZPL ラベル、ESC/POS レシートを印刷したりできます。

Claude Code、Claude Desktop、Cursor、VS Code(GitHub Copilot)、OpenAI Codex、Windsurf、および stdio 経由で Model Context Protocol に対応するすべてのクライアントで動作します。

キーを取得する

app.inkrelay.app にサインインし、API キーを開いて作成します。まずはテストキー(ir_test_...)をお試しください。このキーで利用できるのは 4 台の仮想プリンター(Test A4 Laser、Test Letter Color、Test Receipt 80mm、Test Label 4x6)のみです。ジョブは約 3 秒で完了し、料金はかかりません。ライブキー(ir_live_...)を使うと、実際に用紙へ印刷されます。

クライアントに追加する

Claude Code

claude mcp add-json inkrelay '{"command":"npx","args":["-y","@inkrelay/mcp"],"env":{"INKRELAY_API_KEY":"ir_test_your_key"}}'

Claude Desktop(claude_desktop_config.json)、Cursor(.cursor/mcp.json)、Windsurf(~/.codeium/windsurf/mcp_config.json)

{
  "mcpServers": {
    "inkrelay": {
      "command": "npx",
      "args": ["-y", "@inkrelay/mcp"],
      "env": { "INKRELAY_API_KEY": "ir_test_your_key" }
    }
  }
}

VS Code(.vscode/mcp.json)

{
  "inputs": [{ "type": "promptString", "id": "inkrelay-key", "description": "InkRelay API key", "password": true }],
  "servers": {
    "inkrelay": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@inkrelay/mcp"],
      "env": { "INKRELAY_API_KEY": "${input:inkrelay-key}" }
    }
  }
}

OpenAI Codex(~/.codex/config.toml)

[mcp_servers.inkrelay]
command = "npx"
args = ["-y", "@inkrelay/mcp"]
env = { INKRELAY_API_KEY = "ir_test_your_key" }

ドキュメント検索は、https://docs.inkrelay.app/mcp にある別のホスト型サーバーです(ストリーミング可能な HTTP)。設定例:

claude mcp add-json inkrelay-docs '{"type":"http","url":"https://docs.inkrelay.app/mcp"}'

ツール

ツール機能
whoamiキーの組織、プラン、モード(テストまたはライブ)、使用状況
list_computersエージェントを実行しているコンピューターとその状態
list_printersID、コンピューター、オンライン状態、ライブ切り替え、既定値を含むプリンター一覧
get_printer用紙、トレイ、dpi、両面印刷、カラー、集約印刷などの機能
update_printer表示名、ライブ切り替え、既定のオプション、カスタム用紙サイズ(管理者スコープ)
print_pdfURL、Base64、またはローカルファイルから PDF を印刷します。既定では最終状態まで待機します
print_rawテキスト、Base64、URL、またはローカルファイルから ZPL、ESC/POS、その他のプリンター言語のバイトデータを印刷します
get_print_job状態、メッセージ、完全なイベント履歴を含むジョブ
wait_for_print_jobジョブが完了、エラー、キャンセル、または期限切れになるまで待機します
list_print_jobsプリンター、コンピューター、または状態で絞り込んだ最近のジョブ
cancel_print_jobキューに入っている、または送信済みのジョブをキャンセルします
reprint_print_job以前のジョブに保存されたファイルを再印刷します
get_usage今回の請求期間に使用したライブ印刷回数と、プランに含まれる印刷回数
list_eventsイベントフィード(Webhook で配信されるものと同じイベント)
list_webhooks、create_webhook、ping_webhook署名付き Webhook エンドポイントを管理します(管理者スコープ)

試してみましょう:「使えるプリンターを教えて」、「この請求書 PDF を A4 レーザープリンターで両面、2 部印刷して」、「Order 1042 と書かれた 4x6 の ZPL テストラベルを印刷して」、「最後のジョブが失敗した理由は?」。

設定

変数既定値説明
INKRELAY_API_KEYなしir_test_ または ir_live_ キーを指定します。キーがなくてもサーバーは起動し、モデルに取得方法を案内します
INKRELAY_BASE_URLhttps://api.inkrelay.appプロキシを使う場合の上書き先
INKRELAY_FILE_ROOT作業ディレクトリfilePath 引数で指定できる範囲を制限するフォルダーです。/、ドライブのルート、またはホームフォルダーとして解決される場合(デスクトップクライアントではよくあります)、ファイルの読み取りは無効になるため、ここに設定してください。隠しファイルと隠しフォルダーは読み取られません。また、print_raw で読み取るのはプリンターファイル(.zpl、.epl、.prn、.pcl、.ps、.escpos、.raw、.bin、.txt)のみです

print_pdf、print_raw、reprint_print_job は、すべてのジョブで Idempotency-Key を送信します(idempotencyKey で独自のキーを渡せます)。そのため、呼び出しを再試行しても二重に印刷されません。ジョブには source: "inkrelay-mcp" が設定されます。ライブキーを使うと実際に用紙へ印刷され、プランの使用量に算入されるため、クライアントでツールの承認を有効にしておいてください。

独自のコードに印刷機能を組み込む

MCP サーバーは、アシスタントからプリンターを操作するためのものです。アプリケーションに印刷機能を追加するには、SDK の @inkrelay/sdk と inkrelay を使用し、コーディングエージェントに inkrelay-printing skill を提供してください。

ドキュメント:https://docs.inkrelay.app/ai

開発

pnpm install
pnpm lint && pnpm typecheck && pnpm test && pnpm build

ライセンス

MIT

コメント

MCP は初めてですか?

プロトコルの概要から最初のサーバーの導入まで、よくある疑問にまとめて答えます。

AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。