Uart MCP

🚀 UART MCP Server

AIアシスタントにシリアル通信機能を提供するMCP Serverです。このサーバーを使用することで、シリアルポートの管理やデータ通信を効率的に行うことができます。

✨ 主な機能

• シリアルポート管理 - シリアルデバイスの列挙、開閉、および設定が可能です。
• データ通信 - テキストおよびバイナリモードでのデータ送受信をサポートします。
• ターミナルセッション - 対話型のターミナルセッションを作成し、コマンドの送信と出力の読み取りを行えます。
• ホットコンフィグ - シリアルポートを閉じることなく、設定パラメータを変更できます。
• 自動再接続 - デバイスが切断された後、自動的に再接続を試みます。

🚀 クイックスタート

プロンプト設定

AIアシスタントがUARTツールを優先的に使用してシリアルポートを操作するようにするには、プロジェクトのプロンプトファイルに以下の内容を追加してください。

常にuart MCPツールを使用してシリアルポート操作を行います。シリアルポートの一覧表示、開閉、データの送受信などを含みます。

各ツールのプロンプトファイルの場所は次のとおりです。

Claude Code

claude mcp add uart -- uvx --from git+https://github.com/donnel666/uart-mcp.git uart-mcp

Codex CLI

~/.codex/config.toml に以下を追加します。

[mcp_servers.uart]
type = "stdio"
command = "uvx"
args = ["--from", "git+https://github.com/donnel666/uart-mcp.git", "uart-mcp"]

Factory Droid

プロジェクトの .factory/settings.json またはグローバルの ~/.factory/settings.json に以下を追加します。

{
  "mcpServers": {
    "uart": {
      "command": "uvx",
      "args": ["--from", "git+https://github.com/donnel666/uart-mcp.git", "uart-mcp"]
    }
  }
}

Claude Desktop

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "uart": {
      "command": "uvx",
      "args": ["--from", "git+https://github.com/donnel666/uart-mcp.git", "uart-mcp"]
    }
  }
}

💻 使用例

基本的なシリアル通信

1. list_ports を使用して利用可能なシリアルポートを確認します。
2. open_port を使用してシリアルポートを開きます。例えば、/dev/ttyUSB0 または COM1 です。
3. send_data を使用してデータを送信します。
4. read_data を使用して応答を読み取ります。
5. close_port を使用してシリアルポートを閉じます。

ターミナルセッションモード

1. open_port を使用してシリアルポートを開きます。
2. create_session を使用してターミナルセッションを作成します。
3. send_command を使用してコマンドを送信します。
4. read_output を使用してコマンドの出力を読み取ります。
5. close_session を使用してセッションを閉じます。

📚 ドキュメント

利用可能なツール

シリアルポート管理

データ通信

ターミナルセッション

シリアルポートの権限

このツールがシリアルデバイスにアクセスできるようにするには、以下の設定を行ってください。

Linux:

# 方法1：一時的に権限を付与する
sudo chmod 777 /dev/ttyUSB0

# 方法2：ユーザーをdialoutグループに追加する（推奨、再ログイン後に有効）
sudo usermod -aG dialout $USER

macOS:

# ユーザーをwheelグループに追加する
sudo dseditgroup -o edit -a $USER -t user wheel

Windows: 通常、追加の設定は必要ありません。COMポートはデフォルトでアクセス可能です。

シリアルポートの設定パラメータ

設定ファイル

UART MCPの設定ファイルは以下の場所にあります。

• Linux/macOS: ~/.uart-mcp/
• Windows: %APPDATA%\.uart-mcp\

設定ファイルの説明

config.tomlの例

[serial]
baudrate = 115200
bytesize = 8
parity = "N"
stopbits = 1.0

[timeout]
read_timeout = 1000
write_timeout = 1000

[flow_control]
xonxoff = false
rtscts = false
dsrdtr = false

[reconnect]
auto_reconnect = true
reconnect_interval = 5000

[logging]
log_level = "INFO"

blacklist.confの例

# ブラックリスト設定（1行に1つのルール）
# 完全一致と正規表現をサポート

# 完全一致
/dev/ttyS0

# 正規表現ですべてのCOMポートをマッチさせる
COM[0-9]+

注意: 設定ファイルの権限は600（所有者のみが読み書き可能）にする必要があります。そうしないと、権限エラーが発生します。

ローカル開発

# リポジトリをクローンする
git clone https://github.com/donnel666/uart-mcp.git
cd uart-mcp

# 依存関係をインストールする
uv sync --dev

# サーバーを起動する
uv run uart-mcp

# テストを実行する
uv run pytest

# コードチェックを実行する
uv run ruff check src/
uv run mypy src/

システム要件

• Python 3.13+
• サポートされるオペレーティングシステム: Linux, macOS, Windows

📄 ライセンス

MIT License