Robotframeworklibrary To MCP

🚀 Guide to Converting a Robot Framework Library to an MCP Server

This guide provides a step-by-step process to convert a Robot Framework library into an MCP server, along with instructions for configuring an MCP client and a practical example.

🚀 Quick Start

Step 1: Clone Your Robot Framework Library

First, clone the Robot Framework library you want to convert to your local development environment.

Step 2: Locate the __init__.py File

Open the library folder and find the __init__.py file. Edit this file, which defines your library class. Usually, it inherits from the base class of Robot Framework using a hybrid core or dynamic core.

Example Code:

from robotlibcore import DynamicCore
class LibraryName(DynamicCore):
    def __init__(self):
        super().__init__()
        # Initialization logic

Step 3: Add the to_mcp Method

Add the following method to your library class to expose keywords to the MCP server.

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

Step 4: Run the MCP Server

Create a new Python file (e.g., run_server.py) in the root directory of your library and add the following code to start the MCP server:

from src.LibraryName import LibraryName

# Initialize your library instance
library_instance = LibraryName()
# Convert to an MCP server instance
mcp_server = library_instance.to_mcp()
# Start the MCP server using the standard input/output transport protocol
mcp_server.run(transport='stdio')

📦 Configuration of the MCP Client (Taking VSCode as an Example)

Step 1: Add MCP Server Configuration

Open VSCode, press Ctrl + Shift + P, and then enter MCP:Add Server in the command palette.

Step 2: Configure in JSON Format

{
    "mcp": {
        "servers": {
            "LibName": {  # Unique identifier for the server
                "type": "stdio",  # Use the standard input/output transport protocol
                "command": "uv",  # Execution command (modify according to the actual situation)
                "args": [
                    "--directory",
                    "C:\\somefolder\\ABS Path to The library Root",  # Absolute path to the library
                    "run",
                    "test.py"  # Name of the Python file containing the server startup code
                ]
            }
        }
    }
}

💻 Usage Examples

Basic Usage

Taking MailClientLibrary as an example:

from src.MailClientLibrary import MailClientLibrary 

# Initialize the mail client library instance and configure the necessary parameters
mail_client = MailClientLibrary(
    Username="user",
    Password="pass",
    MailServerAddress="127.0.0.1",
    ImapPorts=[993, 143],
    Pop3Ports=[995, 110],
    SmtpPorts=[465, 25]
)

# Convert to an MCP server instance
mcp_server = mail_client.to_mcp()

# Start the MCP server using the standard input/output transport protocol
mcp_server.run(transport='stdio')

# Print the MCP server instance (optional)
print(mcp_server)

By following the above steps, you can easily convert any Robot Framework library into an MCP server and interact with it on clients that support the MCP protocol.