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 协议的客户端上进行交互。