hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
Integrations
NodeMCU MCP(モデルコンテキストプロトコル)サービス
NodeMCUデバイスを管理するためのモデルコンテキストプロトコル(MCP)サービス。このサービスは、標準のRESTful API/WebSocketインターフェースを提供し、Claude DesktopなどのAIツールとの統合のためのモデルコンテキストプロトコルを実装しています。
概要
NodeMCU MCP は、次の主要機能を備えた ESP8266/NodeMCU IoT デバイス向けの管理ソリューションを提供します。
- デバイスの状態とテレメトリを監視する
- デバイスにリモートでコマンドを送信する
- デバイス構成を更新する
- MCPプロトコルによるAIアシスタントとの統合
視覚化
特徴
- 🔌デバイス管理:NodeMCUデバイスの登録、監視、制御
- 📊リアルタイム通信:リアルタイム更新のためのWebSocketインターフェース
- ⚙️構成管理: デバイス設定をリモートで更新
- 🔄コマンド実行: 再起動、更新、ステータスコマンドをリモートで送信
- 📡テレメトリ収集:センサーデータとデバイスメトリクスを収集する
- 🔐認証: JWT認証による安全なAPIアクセス
- 🧠 AI統合:Claude Desktopやその他のMCP互換AIツールと連携
クイックスタート
前提条件
- Node.js 16.x 以上
- npmまたはyarn
- NodeMCUクライアントの場合: ESP8266をサポートするArduino IDE
インストール
Smithery経由でインストール
Smithery経由で Claude Desktop 用の NodeMCU Manager を自動的にインストールするには:
npmから(公開後)
出典
構成
- 例に基づいて
.env
ファイルを作成します。Copy - 設定に合わせて
.env
ファイルを更新します。Copy
使用法
APIサーバーとして実行
自動再起動付き開発モード:
生産モード:
MCPサーバーとして実行中
Claude Desktop またはその他の MCP クライアントとの統合の場合:
グローバルにインストールされている場合:
コマンドラインオプション
MCP統合
このプロジェクトでは、公式の Model Context Protocol (MCP) TypeScript SDK を使用して、Claude for Desktop およびその他の MCP クライアントとの統合を提供します。
MCPツール
MCP インターフェイスを通じて次のツールを利用できます。
- list-devices : 登録されているすべてのNodeMCUデバイスとそのステータスを一覧表示します。
- get-device : 特定のNodeMCUデバイスに関する詳細情報を取得する
- send-command : NodeMCUデバイスにコマンドを送信する
- update-config : NodeMCUデバイスの設定を更新する
Claude for Desktop と併用
このサーバーをClaude for Desktopで使用するには:
- https://claude.ai/desktopから Claude for Desktop をインストールします。
~/Library/Application Support/Claude/claude_desktop_config.json
を編集して、Claude for Desktop を構成します。
- デスクトップ版のClaudeを再起動
- Claude for DesktopインターフェースにNodeMCUツールが表示されるはずです。
MCP サーバーをスタンドアロンで実行する
MCP サーバーを直接実行するには:
または CLI を使用します:
APIドキュメント
認証
- POST /api/auth/login - ログインしてJWTトークンを取得する応答:CopyCopy
- POST /api/auth/validate - JWTトークンを検証するCopy
デバイスAPI
すべてのデバイス エンドポイントには JWT トークンによる認証が必要です。
デバイスの一覧
応答:
デバイスの詳細を取得する
応答:
デバイスにコマンドを送信する
リクエスト:
応答:
WebSocketプロトコル
WebSocket サーバーはルート パスで利用できます: ws://your-server:3000/
WebSocket プロトコル メッセージの詳細については、コードまたは例のディレクトリを参照してください。
NodeMCUクライアントのセットアップ
完全なクライアント実装については、 examples
ディレクトリの Arduino スケッチを参照してください。
重要なステップ
- Arduino IDE に必要なライブラリをインストールします。
- ESP8266WiFi
- WebSocketクライアント
- ArduinoJson
- WiFi とサーバーの設定でスケッチを構成します。Copy
- スケッチをNodeMCUデバイスにアップロードします
発達
プロジェクト構造
貢献
貢献を歓迎します!お気軽にプルリクエストを送信してください。
- リポジトリをフォークする
- 機能ブランチを作成します(
git checkout -b feature/amazing-feature
) - 変更をコミットします (
git commit -m 'Add some amazing feature'
) - ブランチにプッシュする (
git push origin feature/amazing-feature
) - プルリクエストを開く
ライセンス
このプロジェクトは MIT ライセンスに基づいてライセンスされています - 詳細についてはLICENSEファイルを参照してください。
MIT ライセンスは、次のことを許可する許容ライセンスです。
- ソフトウェアを商用利用する
- ソフトウェアを変更する
- ソフトウェアを配布する
- ソフトウェアを個人的に使用および変更する
唯一の要件は、ライセンスと著作権表示がソフトウェアに含まれている必要があることです。
謝辞
- 統合仕様のためのモデルコンテキストプロトコル
- 驚異的なIoTプラットフォームのためのNodeMCU
- クロード・デスクトップのAnthropic
You must be authenticated.
REST/WebSocket API の両方を提供し、AI アシスタント統合用のモデル コンテキスト プロトコルを実装する ESP8266/NodeMCU IoT デバイスを管理するためのサービスです。