KIP MCP Server

kip-mcp-server

AI アシスタント（Claude、Codex、Gemini など）が、あなたのボートの Signal K データを確認し、海図プロッターやタブレットで見る計器やパネルである KIP ダッシュボードの設計とインストールを支援する MCP サーバーです。

操作の主導権はあなたにあります。アシスタントはまず各ダッシュボードの画像を表示し、あなたが承認してからボートに保存します。

できること

• ボートのデータを確認します。 Signal K を通じてボートが報告する速度、風、深度、バッテリー、エンジンなどの値を探します。
• ダッシュボードを提案します。 汎用ダッシュボードに加えて、セーリング、エンジン走行、電源、停泊、航法、天候など、用途別のダッシュボードを提案します。
• プレビューを表示します。 保存する前に、各ダッシュボードの簡単な画像を確認できます。
• 承認を得てインストールします。 ダッシュボードを KIP の設定に書き込むか、自分でインポートできるファイルを渡します。

表示例

ボートに接続した後の、AI アシスタントとの短いやり取りです。

You:  Look at my boat's data and suggest some KIP dashboards.

  → analyze_signalk_data            142 paths · speed, wind, depth, battery, engine
  → recommend_dashboard_set         6 dashboards the data supports

Assistant: Your boat reports navigation, wind, depth, electrical and engine data,
so I can build these. Here's the "Sailing" one — a preview, nothing saved yet:

  ┌─────────────┬─────────────┬───────────────────────────┐
  │ SOG  6.2 kn │ AWS 14 kn   │                           │
  ├─────────────┼─────────────┤        wind steering       │
  │ DPT  8.4 m  │ AWA  42°    │                           │
  └─────────────┴─────────────┴───────────────────────────┘

You:  Looks good — install the sailing and anchor ones.

  → apply_kip_config (dry run)      2 dashboards → KipConfig (global)
Assistant: This will add "Sailing" and "Anchor" to KIP. Go ahead?
You:  Yes.
  → apply_kip_config                written ✓  — open KIP to see them.

アシスタントは必ず最初にプレビューを表示し、ボートに書き込む前に確認を求めます。

クイックスタート（ボートの所有者向け）

ボート上（またはネットワーク上）で稼働している Signal K サーバーと、インストール済みの KIP が必要です。

1. Signal K のアドレスを確認します。 通常は http://your-boat:3000 のような形式です。ホスト名（または IP アドレス）とポートを控えてください。
2. このサーバーを取得します。 手動でインストールする必要はありません。AI アシスタントが npx を使って必要に応じて実行できます（npx は Node.js 24 以降に付属しています）。

   npx -y kip-mcp-server
   

   次の手順で、このコマンドをアシスタントに登録します。（ソースからビルドする場合は、下記の開発をご覧ください。）
3. AI アシスタントに接続します。 docs/clients からアシスタントを選び、そこで簡単な設定手順に従ってください。アシスタントにボートのホスト名とポートを伝えます。
4. 支援を依頼します。 「ボートのデータを確認して、KIP ダッシュボードをいくつか提案して」といった内容を伝えます。表示されたプレビューを確認してください。
5. 承認します。 内容に問題がなければ、続行するよう伝えてください。書き込み前に確認を求められます。Signal K サーバーが古い場合は、代わりに KipConfig.json ファイルが渡されます。その場合は KIP の設定からインポートしてください。

接続方法

サーバーは、環境からいくつかの設定を読み取ります。

設定	内容	デフォルト
SIGNALK_HOST	Signal K のホスト名または IP アドレス	localhost
SIGNALK_PORT	Signal K のポート	3000
SIGNALK_TLS	サーバーが https を使用する場合は true に設定します	false
SIGNALK_TOKEN	Signal K のログイントークン。ダッシュボードの書き込みに必要です	（なし）
SIGNALK_USER	Signal K のユーザー名。トークンの代わりに SIGNALK_PASSWORD と組み合わせて使用します	（なし）
SIGNALK_PASSWORD	対応する Signal K のパスワード	（なし）
KIP_URL	KIP がデフォルト以外の場所で提供されている場合に、URL を上書きします	（自動設定）

データの読み取りにログインは不要です。サーバーへのダッシュボードの書き込みには、トークン、またはユーザー名とパスワードが必要です。代わりにファイルへエクスポートする方法もあり、その場合は追加の情報は必要ありません。トークンの取得方法（またはユーザー名とパスワードを使う方が簡単な理由）については、Signal K の認証をご覧ください。

HTTP 経由のリモートアクセス（任意・上級者向け）

デフォルトでは、サーバーは stdio 経由で通信します。アシスタントがローカルのサブプロセスとして実行します。 サーバーをホストし、リモートのアシスタント（Claude.ai など）がネットワーク経由でアクセスできるようにする、任意の HTTP モード（kip-mcp-http）もあります。これはオプトイン方式で、TLS を追加するリバースプロキシの背後で単一の運用者が使用することを想定しています。

# Behind a TLS-terminating reverse proxy that forwards to 127.0.0.1:3017
MCP_BEARER_TOKEN=a-long-random-secret \
MCP_PUBLIC_URL=https://boat.example.com/mcp \
  npx kip-mcp-http

設定	内容	デフォルト
HTTP_HOST	バインドするアドレス	127.0.0.1（ループバック）
HTTP_PORT	リッスンするポート	3017
HTTP_PATH	MCP エンドポイントの URL パス	/mcp
MCP_BEARER_TOKEN	呼び出し元が提示する必要のある 1 つ以上のベアラートークン（カンマ区切り）	（なし）
MCP_PUBLIC_URL	クライアントがアクセスする公開 URL。Host 許可リストとメタデータに使用	（自動取得）
MCP_ALLOWED_ORIGINS	許可するブラウザーのオリジン（カンマ区切り。デフォルトでは無効）	（なし）
MCP_ALLOWED_HOSTS	Host 許可リストを上書き	（自動取得）
MCP_ALLOW_INSECURE	安全でない構成でも起動する場合は true に設定	（未設定）

すべてのリクエストは、有効な Authorization: Bearer <token> を提示し、MCP レイヤーに到達する前に Host／Origin 許可リストを通過する必要があります。ループバック以外のアドレスにバインドする場合、またはベアラートークンなしで実行する場合、MCP_ALLOW_INSECURE=true を設定しない限り、サーバーは起動を拒否します。すべてのセッションで 1 つの Signal K ログインを使用するため、シングルテナントのデプロイとして扱ってください。上記と同じ SIGNALK_* 設定が適用されます。

アシスタントにできること

サーバーは、用途別にグループ化されたツールをアシスタントに提供します。

• ボートの情報を確認する — データパス、その単位、インストール済みのプラグインを一覧表示します。
• KIP のパーツを把握する — すべての KIP ウィジェットとその設定に加え、KIP が理解できる色、アイコン、単位を一覧表示します。
• ダッシュボードを設計する — ダッシュボードのセットを提案し、選択した用途向けに作成して、プレビューを描画します。
• UX をレビューする — 海上での使いやすさ（階層、グループ化、一貫性、ラベル）の観点からダッシュボードを評価し、重大度付きの指摘を提示します。review_dashboard プロンプトが、決定論的な check_dashboard_ux リントを用いてレビューを実行します。
• 確認して保存する — ダッシュボードの形式が正しいか確認し、ファイルにエクスポートするか、ボートに書き込みます（事前に確認します）。

詳細情報

• レシピ — アシスタントにダッシュボードの設計を依頼する例を紹介します。
• トラブルシューティング — よくある問題の解決方法を説明します。組み込みの --doctor チェックから始めてください。
• ツールリファレンス — アシスタントが使用できるすべてのツールとプロンプトを紹介します。

用語集

いくつかの用語をわかりやすく説明します。

• Signal K — 速度、風、深度などのデータをネットワーク経由で共有するために、多くのボートで使われているオープンなシステムです。
• path — navigation.speedOverGround（対地速度）のような、個々のデータの名前です。
• KIP — ボートのデータをゲージやパネルのダッシュボードとして表示するアプリです。
• widget — ダッシュボード上のゲージやパネル 1 つ分です（数値、ダイヤル、風の表示など）。
• dashboard — グリッド上にウィジェットを配置した画面です。
• token — ソフトウェア用のパスワードのようなもので、サーバーがボートへの変更を保存できるようにします。
• dry run — 実際には実行せず、アシスタントが実行する内容を示すことです。保存はデフォルトでドライランになります。

開発

このプロジェクトでは Node.js 24（LTS）を使用します。主なコマンドは次のとおりです。

npm install        # install dependencies
npm run typecheck  # check types
npm run lint       # check code style
npm test           # run the tests
npm run build      # compile to dist/
npm run smoke      # start the built server and check it answers
npm run ci         # run the full set of checks

開発中にサーバーをローカルで実行・テストする方法（AI クライアントや MCP Inspector をローカルビルドに接続する方法、HTTP トランスポートを実行する方法、Signal K に接続して、またはオフラインでテストする方法）の詳細については、docs/development.md を参照してください。

コミットには Conventional Commits を使用します。リリースとバージョン番号は、コミットメッセージから自動的に生成されます。

ライセンス

MIT — LICENSE を参照してください。