As Help MCP

🚀 AS Help MCP Server

B&R Automation Studioのヘルプドキュメント検索用のMCPサーバーです。SQLite FTS5とBM25ランキングを使用して、すべてのヘルプページに対する全文検索を提供します。

✨ 主な機能

• BM25ランキングによる全文検索
• カテゴリーフィルタリングと階層的な閲覧
• B&Rオンラインヘルプ（AS4/AS6）への自動生成リンク
• コンテキスト依存ヘルプ統合のためのHelpID検索
• MD5ハッシュを使用したヘルプディレクトリの変更時の自動再インデックス作成
• 複数スレッドによる並列インデックス作成

📋 前提条件

• B&R Automation Studioがインストールされている（ヘルプドキュメント付き）
• Docker Desktopがインストールされ、実行中である
• GitHub Copilot拡張機能付きのVS Code

🎥 デモ

https://github.com/user-attachments/assets/b4df6bc7-ed7c-471f-93b8-db84b0110ac3

🚀 クイックスタート (VS Code)

ワークスペースの .vscode/mcp.json に以下を追加します。

オプション1: Docker (推奨)

{
  "servers": {
    "as-help": {
      "command": "docker",
      "args": [
        "run", "--rm", "-i",
        "-v", "C:\\Program Files (x86)\\BRAutomation\\AS6\\Help-en\\Data:/data/help:ro",
        "-v", "ashelp-data:/data/db",
        "-e", "AS_HELP_VERSION=6",
        "-e", "AS_HELP_FORCE_REBUILD=false",
        "ghcr.io/brdk-public/as-help-mcp:latest"
      ]
    }
  }
}

ボリュームパスをASのインストールに合わせて更新します。

• AS 4.x: C:\\BRAutomation\\AS412\\Help-en\\Data:/data/help:ro
• AS 6.x: C:\\Program Files (x86)\\BRAutomation\\AS6\\Help-en\\Data:/data/help:ro
• WSL内のAS 6.x: /mnt/c/Program Files (x86)/BRAutomation/AS6/Help-en/Data:/data/help:ro

オプション2: UV (ローカル開発)

{
  "servers": {
    "as-help": {
      "command": "uv",
      "args": [
        "run",
        "--directory",
        "/path/to/as-help-mcp",
        "as-help-server",
        "--help-root",
        "C:\\Program Files (x86)\\BRAutomation\\AS6\\Help-en\\Data",
        "--db-path",
        "..\\data\\as6\\.ashelp\\search.db",
        "--metadata-dir",
        "..\\data\\as6\\.ashelp_metadata",
        "--as-version",
        "6"
      ]
    }
  }
}

--directory をクローンしたリポジトリのパスに更新し、必要に応じてパスを調整します。

VS Codeを再起動し、Copilot Chatで "Search AS help for mapp Motion" とテストします。

初回実行時は検索インデックスの構築に5 - 10分かかります。 それ以降の起動は即座に行われます。

🔧 ローカル開発環境のセットアップ

オプション1: UV (推奨)

# クローンとインストール
git clone <repository-url>
cd as-help
uv sync --extra test --extra dev

# コマンドライン引数でサーバーを実行する（.envより優先）
uv run as-help-server --help-root "C:\BRAutomation\AS412\Help-en\Data" --db-path "data\.ashelp\search.db" --metadata-dir "data\.ashelp_metadata"

# または相対パスを使用する（自動的に解決されます）
uv run as-help-server --db-path ./data/ashelp.db --metadata-dir ./data

オプション2: 環境変数 (.env)

ルートディレクトリに .env ファイルを作成することもできます。コマンドライン引数が指定されている場合、これらの値は上書きされます。

AS_HELP_ROOT=C:\Program Files (x86)\BRAutomation\AS6\Help-en\Data
AS_HELP_VERSION=6

CLI引数

uv run as-help-server --help を実行して詳細を確認してください。

オプション3: Docker Compose

# ローカルビルド
docker compose build

# ヘルプファイルをマウントして実行する
docker compose run --rm \
  -v "C:\Program Files (x86)\BRAutomation\AS6\Help-en\Data:/data/help:ro" \
  as-help-local

MCPインスペクターでのテスト

MCPインスペクターは、ツールとプロンプトをテストするためのWeb UIを提供します。

# UVを使用する場合
uv run mcp dev src/server.py

# http://localhost:5173 でブラウザが開きます

注: Windowsでは、VS Codeの実行とデバッグパネルを代わりに使用してください（インスペクターとのstdioトランスポートの問題があります）。

VS Codeでのデバッグ

.vscode/launch.json の起動構成を使用します。

1. Rebuild BR Help Index - インデックスを構築する初回実行
2. Run BR Help MCP Server - 通常のサーバー起動
3. Test BR Help Indexer - クイックXMLパーステスト

🌐 環境変数とCLI引数

サーバーは、環境変数とコマンドライン引数の両方を使用した構成をサポートしています。CLI引数が優先されます。 相対パスは自動的に絶対パスに解決されます。

🛠️ ツール

💬 プロンプト

📚 リソース

🌐 複数のASバージョン

{
  "servers": {
    "as-help-4": {
      "command": "docker",
      "args": [
        "run", "--rm", "-i",
        "-v", "C:\\BRAutomation\\AS412\\Help-en\\Data:/data/help:ro",
        "-v", "ashelp-data-4:/data/db",
        "-e", "AS_HELP_VERSION=4",
        "-e", "AS_HELP_FORCE_REBUILD=false",
        "ghcr.io/brdk-public/as-help-mcp:latest"
      ]
    },
    "as-help-6": {
      "command": "docker",
      "args": [
        "run", "--rm", "-i",
        "-v", "C:\\Program Files (x86)\\BRAutomation\\AS6\\Help-en\\Data:/data/help:ro",
        "-v", "ashelp-data-6:/data/db",
        "-e", "AS_HELP_VERSION=6",
        "-e", "AS_HELP_FORCE_REBUILD=false",
        "ghcr.io/brdk-public/as-help-mcp:latest"
      ]
    }
  }
}