Robotframeworklibrary To MCP

🚀 將 Robot Framework 庫轉換為 MCP 服務器的步驟指南

本指南詳細介紹瞭如何將 Robot Framework 庫轉換為 MCP 服務器，以及如何配置 MCP 客戶端，還提供了實際案例演示，助你輕鬆完成轉換並實現交互。

🚀 快速開始

轉換步驟

1. 克隆你的 Robot Framework 庫

首先，你需要克隆你要轉換的 Robot Framework 庫到本地開發環境中。

2. 定位 __init__.py 文件

打開庫文件夾，找到並編輯其中的 __init__.py 文件。這個文件中定義了你的庫類，通常使用混合核心（hybrid core）或動態核心（dynamic core）繼承自 Robot Framework 的基類。

示例代碼：

from robotlibcore import DynamicCore
class LibraryName(DynamicCore):
    def __init__(self):
        super().__init__()
        # 初始化邏輯

3. 添加 to_mcp 方法

在庫類中添加以下方法，使其能夠暴露關鍵字到 MCP 服務器。

def to_mcp(self):
    from mcp.server.fastmcp import FastMCP
    mcp = FastMCP(self.__class__.__name__)
    for kw in self.keywords.values():
        mcp.add_tool(kw)
    return mcp

4. 運行 MCP 服務器

在庫的根目錄下創建一個新的 Python 文件（例如 run_server.py），並添加以下代碼啟動 MCP 服務器：

from src.LibraryName import LibraryName

# 初始化你的庫實例
library_instance = LibraryName()
# 轉換為 MCP 服務器實例
mcp_server = library_instance.to_mcp()
# 啟動 MCP 服務器，使用標準輸入輸出傳輸協議
mcp_server.run(transport='stdio')

配置 MCP 客戶端（以 VSCode 為例）

1. 添加 MCP 服務器配置

打開 VSCode，按下 Ctrl + Shift + P，然後在命令面板中輸入 MCP:Add Server。

2. 配置 JSON 格式如下：

{
    "mcp": {
        "servers": {
            "LibName": {  # 服務器的唯一標識符
                "type": "stdio",  # 使用標準輸入輸出傳輸協議
                "command": "uv",  # 執行命令（根據實際情況修改）
                "args": [
                    "--directory",
                    "C:\\somefolder\\ABS Path to The library Root",  # 庫的絕對路徑
                    "run",
                    "test.py"  # 包含啟動服務器代碼的 Python 文件名
                ]
            }
        }
    }
}

💻 使用示例

基礎用法

以 MailClientLibrary 為例：

from src.MailClientLibrary import MailClientLibrary 

# 初始化郵件客戶端庫實例，配置必要的參數
mail_client = MailClientLibrary(
    Username="user",
    Password="pass",
    MailServerAddress="127.0.0.1",
    ImapPorts=[993, 143],
    Pop3Ports=[995, 110],
    SmtpPorts=[465, 25]
)

# 轉換為 MCP 服務器實例
mcp_server = mail_client.to_mcp()

# 啟動 MCP 服務器，使用標準輸入輸出傳輸協議
mcp_server.run(transport='stdio')

# 打印 MCP 服務器實例（可選）
print(mcp_server)

通過以上步驟，你可以輕鬆地將任何 Robot Framework 庫轉換為 MCP 服務器，並在支持 MCP 協議的客戶端上進行交互。