As Help MCP

🚀 AS Help MCP Server

AS Help MCP Server是一個用於貝加萊（B&R）Automation Studio幫助文檔搜索的MCP服務器。它藉助SQLite FTS5和BM25排名算法，實現了對所有幫助頁面的全文搜索。

🚀 快速開始

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分鐘 來構建搜索索引，後續啟動則是即時的。

✨ 主要特性

• 基於BM25排名的全文搜索
• 類別過濾和分層瀏覽
• 自動生成指向貝加萊在線幫助（AS4/AS6）的鏈接
• 支持通過HelpID查找，實現上下文相關幫助集成
• 通過MD5哈希在幫助目錄發生變化時自動重新索引
• 多線程並行索引

📦 安裝指南

前提條件

• 安裝貝加萊Automation Studio（包含幫助文檔）
• 安裝並運行Docker Desktop
• 安裝帶有GitHub Copilot擴展的VS Code

本地開發設置

選項 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

命令行參數

運行 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 Inspector進行測試

MCP Inspector提供了一個Web UI來測試工具和提示：

# 使用UV
uv run mcp dev src/server.py

# 在瀏覽器中打開 http://localhost:5173

注意：在Windows上，請使用VS Code的運行和調試面板（Inspector存在標準輸入輸出傳輸問題）。

VS Code調試

使用 .vscode/launch.json 中的啟動配置：

1. Rebuild BR Help Index - 首次運行以構建索引
2. Run BR Help MCP Server - 正常啟動服務器
3. Test BR Help Indexer - 快速XML解析測試

📚 詳細文檔

環境變量和命令行參數

服務器支持通過環境變量和命令行參數進行配置。命令行參數優先。相對路徑會自動解析為絕對路徑。

工具

提示

資源

多個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"
      ]
    }
  }
}

演示

點擊查看演示