Skip to main content
Glama

🤖 RobotMCP - AI 驱动的测试自动化桥梁

Python Robot Framework FastMCP License

输入通俗英语,输出真正的 Robot Framework 测试——由 AI 代理替你完成输入。

RobotMCP(rf-mcp)是一个模型上下文协议(MCP)服务器,让你的编码代理掌握 Robot Framework 的能力。代理可以发现关键字,实时 针对 Browser、Selenium、Appium、Requests、数据库或桌面运行步骤,观察实际发生的情况,并且——一旦步骤通过——为你编写一份干净的 .robot 套件。没有猜测的定位器,没有幻觉关键字,没有“在我机器上能跑”。基于 Robot Framework 构建:开源,且持续演进。

刚接触 rf-mcp? 请跳转到 快速入门。想要完整了解?请参阅 MCP 工具参考、配置 和 实战示例。

📺 视频教程

RobotMCP 教程

介绍

https://github.com/user-attachments/assets/ad89064f-cab3-4ae6-a4c4-5e8c241301a1


✨ 快速开始

三条命令和一句话。这就是全部设置。

1️⃣ 将其安装为工具

前置要求?

  • 安装 Python +v3.12

  • 以管理员身份在 PowerShell 中运行 > winget install astral-sh.uv # 以启用 uv 命令

  • 安装 VScode 及扩展(GitHub Copilot 并完成登录) # 以启用代理终端

  • 安装 VScode 扩展 Material Icon themes、Save Typing、Dracula、Robocorp # 以启用 robot framework

# Everything (Browser, Selenium, Appium, Requests, Database)
uv tool install "rf-mcp[all]"

# ...or just what you need — API testing is pure Python, nothing else to do:
uv tool install "rf-mcp[api]"

这会将 robotmcp 命令添加到你的 PATH。额外选项决定附带哪些测试库——请参阅安装部分的额外选项表。

2️⃣ 将其接入你的编码代理

robotmcp init            # detects libraries, prints the MCP config to paste
robotmcp install         # registers rf-mcp into the agents it finds

robotmcp install 会为 Claude Code、Codex、GitHub Copilot、opencode、Gemini CLI、Kilo Code、goose 和 Cursor 写入正确的 MCP 配置——每种格式各不相同,且不会影响你的其他服务器。想手动操作?每个代理都接受:

{ "mcpServers": { "robotmcp": { "command": "robotmcp" } } }
{
  "servers": {
    "robotmcp": {
      "type": "stdio",
      "command": "uv",
      "args": ["run", "-m", "robotmcp.server"],
      "env": { "UV_COMPILE_BYTECODE": "1" }
    }
  }
}

UV_COMPILE_BYTECODE=1 会在安装时预编译依赖树。如果没有它,安装/升级后的首次服务器启动会在 MCP 握手完成前花费数秒进行 .pyc 编译(某些客户端会超时并显示服务器不可用)。这是一次性的安装时成本。

HTTP

使用 HTTP 传输启动 MCP 服务器:

uv run -m robotmcp.server --transport http --host 127.0.0.1 --port 8000

然后配置你的 AI 代理:

{
  "servers": {
    "robotmcp": {
      "type": "http",
      "url": "http://localhost:8000/mcp"
    }
  }
}

Claude Code

claude mcp add rf-mcp -- uvx rf-mcp

3️⃣ 开始测试——只需提问

Use #robotmcp to create a TestSuite and execute it step wise.
Create a test for https://www.saucedemo.com/ that:
- Logs in to https://www.saucedemo.com/ with valid credentials
- Adds two items to cart
- Completes checkout process
- Verifies success message

Use Selenium Library.
Execute the test suite stepwise and build the final version afterwards.

就这样。 rf-mcp 会引导代理完成发现、实时执行和套件生成——你只需描述测试。


Related MCP server: robotframework-mcp

📚 文档

指南

内容

快速入门

安装、接入代理、运行你的第一个测试

MCP 工具参考

rf-mcp 向代理暴露的每个工具——参数、返回值、何时使用

配置

每个 ROBOTMCP_* 环境变量和 CLI 标志

示例

可复制粘贴的 Web / API / 移动端 / 桌面 / BDD / 数据驱动演练

库插件

让 rf-mcp 了解你自己的 Robot Framework 库

指令模板

按项目调整代理行为


🛠️ 安装

快速开始 涵盖了推荐路径(uv tool install)。本节包含额外选项表、替代安装方法以及完整的代理注册详情。

额外选项

额外选项决定附带哪些 Robot Framework 库:

额外选项

添加内容

安装后

api

RequestsLibrary

无

web

SeleniumLibrary + Browser

Selenium:无(Selenium Manager 获取驱动程序);Browser:robotmcp init --browsers

mobile

AppiumLibrary

Appium 服务器(外部)

database

DatabaseLibrary

一个数据库驱动程序

desktop

PlatynUI 原生桌面(Windows/Linux)

Python 3.12+

frontend

Django 仪表盘

—

memory

持久化语义记忆(sqlite-vec + model2vec)

ROBOTMCP_MEMORY_ENABLED=true

all

上述所有 Robot Framework 库(在 Python 3.12+ 上包含 desktop)

如上所述

Browser Library 还需要 Playwright 浏览器——在 rf-mcp 自己的环境中运行一次 robotmcp init --browsers(或 rfbrowser init)。Node.js 仅 Browser 需要。

其他安装方法

pip install "rf-mcp[all]"                 # pip instead of uv
uv add "rf-mcp[all]" && uv sync           # into an existing uv project

# From source (development)
git clone https://github.com/manykarim/rf-mcp.git && cd rf-mcp
uv sync --all-extras --dev

Docker

预构建镜像(用于 CI 的无头模式,以及用于可视化调试的 VNC 镜像):

docker pull ghcr.io/manykarim/rf-mcp:latest          # headless
docker run -p 8000:8000 -p 8001:8001 ghcr.io/manykarim/rf-mcp:latest    # HTTP + frontend
docker run -it --rm ghcr.io/manykarim/rf-mcp:latest uv run robotmcp     # STDIO

docker pull ghcr.io/manykarim/rf-mcp-vnc:latest      # X11 desktop over VNC/noVNC
docker run -p 8000:8000 -p 8001:8001 -p 5900:5900 -p 6080:6080 ghcr.io/manykarim/rf-mcp-vnc:latest

无头模式捆绑了 Chromium、Firefox ESR 和 Playwright 浏览器。VNC 端口:8000(MCP HTTP)、8001(前端)、5900(VNC)、6080(noVNC——http://localhost:6080/vnc.html)。

注册到编码代理

robotmcp list                              # supported agents + what's detected/registered
robotmcp install                           # interactive: registers into detected agents
robotmcp install --agents claude-code,codex,gemini
robotmcp install --agents all --scope user
robotmcp install --dry-run                 # show the plan, write nothing
robotmcp uninstall                         # safe, reversible removal

支持的代理(每种写入自己的文件/格式,其他 MCP 服务器保留):Claude Code、OpenAI Codex、GitHub Copilot、opencode、Gemini CLI、Kilo Code、goose、Cursor(以及 pi,在其配置约定确认前列为计划中)。

使用你项目的环境。 安装到具有自己设置环境(uv、poetry、pdm、pipenv、rye、hatch 或普通 .venv)的项目中,rf-mcp 将针对该环境运行——因此它能看到你项目的库、关键字和资源,而不仅仅是捆绑的。它会启动解析后的命令,并在写入配置之前验证你的库是否可达;盲目的或损坏的命令会被拒绝。全局 uvx / uv tool 安装仍可为每个项目服务,无需逐项目设置。使用 -C <dir> 指定,使用 --into-project 选择将 rf-mcp 安装到项目环境中,并运行 robotmcp doctor --project-dir <dir> 查看启动时能访问到你的哪些库。

范围。 安装默认使用 --scope project(写入当前项目,例如 ./.mcp.json),前提是代理支持;使用 --scope user 进行全局(主目录)安装。goose 仅支持用户范围;GitHub Copilot 仅支持项目范围。

安全且可逆。 每次更改都记录在哈希跟踪的清单中(~/.local/state/robotmcp/install-manifest.json)。robotmcp uninstall 仅删除自安装以来未更改的条目——手动编辑的条目会保留并报告,且不会触及无关的服务器。更愿意自己编辑配置?添加 { "mcpServers": { "robotmcp": { "command": "robotmcp" } } }。

🔌 库插件

通过插件系统使用自定义库扩展 RobotMCP。提供两种发现模式:

  • 入口点(robotmcp.library_plugins)用于打包的插件。

  • 清单文件(JSON)位于 .robotmcp/plugins/ 下,用于工作区覆盖。

有关详细说明,请参阅库插件编写指南,并探索 examples/plugins/sample_plugin 中的示例插件以快速上手。


🖥️ 前端仪表盘

RobotMCP 附带一个可选的基于 Django 的仪表盘,可镜像活动会话、关键字和工具活动。

RobotMCP 前端仪表盘

  1. 安装前端额外选项

    pip install rf-mcp[frontend]
  2. 启用前端启动 MCP 服务器

    uv run -m robotmcp.server --with-frontend
    • 默认 URL:http://127.0.0.1:8001/

    • 快速切换:--frontend-host、--frontend-port、--frontend-base-path

    • 环境变量等效项:ROBOTMCP_ENABLE_FRONTEND=1、ROBOTMCP_FRONTEND_HOST、ROBOTMCP_FRONTEND_PORT、ROBOTMCP_FRONTEND_BASE_PATH、ROBOTMCP_FRONTEND_DEBUG

  3. 将你的 MCP 客户端(Cline、Claude Desktop 等)连接到同一服务器进程——会话激活后,仪表盘会自动流式传输事件。

要禁用某次运行的仪表盘,请省略该标志或传递 --without-frontend。


📋 指令模板

RobotMCP 通过 MCP initialize 响应向 LLM 发送服务器级指令,引导它们在执行关键字之前先发现关键字。这显著减少了失败的工具调用和浪费的令牌,尤其是对于较小的 LLM。

配置

三个环境变量控制指令行为:

变量

值

默认

ROBOTMCP_INSTRUCTIONS

off / default / custom

default

ROBOTMCP_INSTRUCTIONS_TEMPLATE

minimal / standard / detailed / browser-focused / api-focused

standard

ROBOTMCP_INSTRUCTIONS_FILE

.txt 或 .md 文件的路径

(无,mode=custom 时必需)

ROBOTMCP_LOG_LEVEL

DEBUG / INFO / WARNING / ERROR — stderr 日志详细程度

WARNING

ROBOTMCP_MCP_LOG_NOTIFICATIONS

设置为 1 以同时将日志作为 MCP notifications/message(结构化、带级别标签)转发给客户端

(关闭)

输出与日志。 MCP stdio 通道(stdout)仅承载 JSON-RPC;所有日志和一行就绪横幅都发送到 stderr。日志默认级别为 WARNING,以免淹没客户端——设置 ROBOTMCP_LOG_LEVEL=INFO/DEBUG 以进行故障排除。日志永远不会阻塞执行(在后台线程上以溢出丢弃方式排空),并且 fd 1 永远不会被重定向出传输层。

内置模板

模板

~Token 数

适用场景

minimal

~40

高性能 LLM(Claude Opus、GPT-4)——仅需简要提醒

standard

~400

中端 LLM(Claude Sonnet、GPT-4o)——均衡的工作流指南

detailed

~600

小型 LLM(Claude Haiku、GPT-4o-mini)——带示例的分步指导

browser-focused

~350

仅限 Web 的测试场景

api-focused

~300

仅限 API 的测试场景

示例

{
  "servers": {
    "robotmcp": {
      "type": "stdio",
      "command": "uv",
      "args": ["run", "-m", "robotmcp.server"],
      "env": {
        "ROBOTMCP_INSTRUCTIONS": "default",
        "ROBOTMCP_INSTRUCTIONS_TEMPLATE": "detailed"
      }
    }
  }
}

自定义指令

设置 ROBOTMCP_INSTRUCTIONS=custom,并通过 ROBOTMCP_INSTRUCTIONS_FILE 提供文件。自定义文件支持 {available_tools} 占位符替换。允许的扩展名:.txt、.md、.instruction、.instructions。如果文件缺失或验证失败,服务器会自动回退到 standard 模板。

完整指南请参阅 docs/INSTRUCTION_TEMPLATES_GUIDE.md。


🪝 调试附加桥接

https://github.com/user-attachments/assets/8d87cd6e-c32e-4481-9f37-48b83f69f72f

RobotMCP 内置 robotmcp.attach.McpAttach,这是一个轻量级的 Robot Framework 库,通过 localhost HTTP 桥接暴露实时的 ExecutionContext。当您从 VS Code(RobotCode)或其他 IDE 调试测试套件时,该桥接让 RobotMCP 复用进程内的变量、导入和关键字搜索顺序,而无需创建独立的上下文。

MCP 服务器设置

带传递环境变量的调试桥接示例配置

使用 UV

{
  "servers": {
    "RobotMCP": {
      "type": "stdio",
      "command": "uv",
      "args": ["run", "src/robotmcp/server.py"],
      "env": {
        "ROBOTMCP_ATTACH_HOST": "127.0.0.1",
        "ROBOTMCP_ATTACH_PORT": "7317",
        "ROBOTMCP_ATTACH_TOKEN": "change-me",
        "ROBOTMCP_ATTACH_DEFAULT": "auto"
      }
    }
  }
}

使用 Docker

{
  "servers": {
    "RobotMCP": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "ghcr.io/manykarim/rf-mcp:latest", "uv", "run", "robotmcp"],
      "env": {
        "ROBOTMCP_ATTACH_HOST": "127.0.0.1",
        "ROBOTMCP_ATTACH_PORT": "7317",
        "ROBOTMCP_ATTACH_TOKEN": "change-me",
        "ROBOTMCP_ATTACH_DEFAULT": "auto"
      }
    }
  }
}

Robot Framework 设置

在您正在调试的测试套件中导入该库并启动服务循环:

*** Settings ***
Library    robotmcp.attach.McpAttach    token=${DEBUG_TOKEN}

*** Variables ***
${DEBUG_TOKEN}    change-me

*** Test Cases ***
Serve From Debugger
    MCP Serve    port=7317    token=${DEBUG_TOKEN}    mode=blocking    poll_ms=100
    [Teardown]    MCP Stop
  • MCP Serve port=7317 token=${TOKEN} mode=blocking|step poll_ms=100 — 启动 HTTP 服务器(如果尚未运行)并处理桥接命令。在关键字主体执行期间使用 mode=step 以仅处理一个排队的请求。

  • MCP Stop — 向服务循环发出退出信号(可从测试套件或通过 RobotMCP 的 attach_stop_bridge 远程调用)。

  • MCP Process Once — 处理单个待处理请求并立即返回;适用于测试套件在测试操作之间轮询的场景。

  • MCP Start — MCP Serve 的别名,用于向后兼容。

桥接默认绑定到 127.0.0.1,并期望客户端在 X-MCP-Token 头中发送共享令牌。

配置 RobotMCP 进行附加

通过环境变量提供桥接连接信息来启动 robotmcp.server 并启用附加路由(令牌必须与测试套件匹配):

export ROBOTMCP_ATTACH_HOST=127.0.0.1
export ROBOTMCP_ATTACH_PORT=7317          # optional, defaults to 7317
export ROBOTMCP_ATTACH_TOKEN=change-me    # optional, defaults to 'change-me'
export ROBOTMCP_ATTACH_DEFAULT=auto       # auto|force|off (auto routes when reachable)
export ROBOTMCP_ATTACH_STRICT=0           # set to 1/true to fail when bridge is unreachable
uv run python -m robotmcp.server

当设置了 ROBOTMCP_ATTACH_HOST 时,execute_step(..., use_context=true) 及其他上下文感知工具会首先尝试在实时调试会话中运行。使用新的 MCP 工具从任何代理管理桥接:

  • attach_status — 报告桥接的配置、可达性和诊断信息(/diagnostics)。

  • attach_stop_bridge — 发送 /stop 命令,进而触发被调试测试套件中的 MCP Stop。


🎪 示例工作流

🌐 Web 应用测试(BDD)

提示词:

Use RobotMCP to create a test suite and execute it step wise.
It shall:

- Open https://demoshop.makrocode.de/
- Add item to cart
- Assert item was added to cart
- Add another item to cart
- Assert another item was added to cart
- Checkout
- Assert checkout was successful

Execute step by step and build final test suite afterwards
Create in BDD style and use Keywords with embedded arguments when applicable

结果: 采用 Given/When/Then 关键字、嵌入参数和提取变量的 BDD 风格 Robot Framework 测试套件。

🌐 Web 应用测试(数据驱动)

提示词:

Use RobotMCP to create a test suite and execute it step wise.
It shall:

- Open https://saucedemo.com
- Login with different user/password combinations
- Assert message or login

Execute step by step and build final test suite afterwards
Create in datadriven style and add multiple test rows with different scenarios
Use Test Template setting in suite

结果: 使用 Test Template 和参数化行覆盖每个登录场景的数据驱动 Robot Framework 测试套件。

📱 移动应用测试

提示词:

Use RobotMCP to create a TestSuite and execute it step wise.
It shall:
- Launch app from tests/appium/SauceLabs.apk
- Perform login flow
- Add products to cart
- Complete purchase

Appium server is running at http://localhost:4723
Execute the test suite stepwise and build the final version afterwards.

结果: 使用 AppiumLibrary 关键字和设备能力的移动测试套件。

🔌 API 测试

提示词:

Read the Restful Booker API documentation at https://restful-booker.herokuapp.com.
Use RobotMCP to create a TestSuite and execute it step wise.
It shall:

- Create a new booking
- Authenticate as admin
- Update the booking
- Delete the booking
- Verify each response

Execute the test suite stepwise and build the final version afterwards.

结果: 使用 RequestsLibrary 并带有适当错误处理的 API 测试套件。

🧪 XML/数据库测试

提示词:

Create a xml file with books and authors.
Use RobotMCP to create a TestSuite and execute it step wise.
It shall:
- Parse XML structure
- Validate specific nodes and attributes
- Assert content values
- Check XML schema compliance

Execute the test suite stepwise and build the final version afterwards.

结果: 使用 Robot Framework 的 XML 库进行 XML 处理测试。


🔍 MCP 工具

rf-mcp 以 MCP 工具的形式向代理暴露其能力,按用途分组:规划与编排、会话与执行、发现与文档、可观测性与诊断、测试套件生命周期、定位器指导、视觉验证,以及可选的持久化记忆。

完整参考: docs/MCP_TOOLS.md — 每个工具的参数、返回值及适用场景。您的代理会直接读取这些描述;您很少需要手动调用它们。

🧪 BDD 与数据驱动测试生成

BDD 风格(Given/When/Then)

提示词:

Use RobotMCP to create a test suite and execute it step wise.
It shall:

- Open https://demoshop.makrocode.de/
- Add item to cart
- Assert item was added to cart
- Add another item to cart
- Assert another item was added to cart
- Checkout
- Assert checkout was successful

Execute step by step and build final test suite afterwards
Create in BDD style and use Keywords with embedded arguments when applicable

结果: RobotMCP 逐步执行每个步骤,在操作之间检查 DOM,并生成带有 Given/When/Then 关键字的 BDD 风格测试套件:

*** Test Cases ***
Demoshop BDD Purchase Workflow
    Given the demoshop is open
    When the user adds the first product to cart
    Then the cart should contain 1 item
    When the user adds the second product to cart
    Then the cart should contain 2 items
    When the user proceeds to checkout
    And the user fills in the checkout form
    And the user places the order
    Then the order confirmation should be displayed

*** Keywords ***
the demoshop is open
    New Browser    chromium
    New Context
    New Page    ${DEMOSHOP_URL}

the user adds the first product to cart
    Click    ${FIRST_PRODUCT_BUTTON}

在逐步执行期间,使用 execute_step 上的 bdd_group 和 bdd_intent 来控制步骤如何分组为行为关键字。最后调用 build_test_suite(bdd_style=True)。

数据驱动模板

提示词:

Use RobotMCP to create a test suite and execute it step wise.
It shall:

- Open https://saucedemo.com
- Login with different user/password combinations
- Assert message or login

Execute step by step and build final test suite afterwards
Create in datadriven style and add multiple test rows with different scenarios
Use Test Template setting in suite

结果: RobotMCP 使用 Test Template 和命名数据行构建参数化测试套件:

*** Settings ***
Library         Browser
Test Template   Verify Login

*** Test Cases ***          USERNAME            PASSWORD        EXPECTED
Valid User                  standard_user       secret_sauce    Products
Locked Out User             locked_out_user     secret_sauce    locked out
Invalid Password            standard_user       wrong_pass      Username and password do not match

使用 manage_session(action="start_test", template="Verify Login") 设置模板关键字,然后使用 manage_session(action="add_data_row", test_name="Valid User", args=["standard_user", "secret_sauce", "Products"]) 添加每一行。


🧠 小型 LLM 优化

RobotMCP 包含针对小型和中型 LLM(8K-32K 上下文窗口)的优化,可减少 token 开销并提高工具调用准确性。

动态工具配置文件

根据工作流阶段控制哪些工具对 LLM 可见。较小的模型看到更少、更紧凑的工具:

manage_session(action="set_tool_profile", tool_profile="browser_exec")

配置文件:browser_exec、api_exec、discovery、minimal_exec、full。将工具描述开销从约 7,000 个 token 减少到约 1,000 个。也可以通过 ROBOTMCP_TOOL_PROFILE 环境变量设置。

响应详细程度

控制响应详细程度以减少 token 消耗。大多数工具可通过 detail_level 参数使用:

  • minimal — 仅输出必要内容(减少 60-80% 的 token)

  • standard — 均衡输出(默认)

  • full — 完整详细输出

通过 ROBOTMCP_OUTPUT_VERBOSITY=compact|standard|verbose 设置默认值。

增量状态响应

get_session_state 支持增量响应,仅返回自上次调用以来发生变化的部分:

# First call returns full state (version 1):
get_session_state(session_id="...", sections=["variables", "page_source"])

# Subsequent calls return only what changed:
get_session_state(session_id="...", mode="delta", since_version=1)

在 mode="auto"(默认)模式下,当存在先前版本时,服务器会自动返回增量响应。对于多步骤工作流(仅变量或页面内容在步骤之间变化),这可将 token 使用量减少 50-80%。

工件外部化

大型输出(HTML 页面源码、执行日志、堆栈跟踪)会自动外部化为可获取的工件,而不是内联在响应中:

# Response includes artifact_id instead of full content:
{"result": "...", "artifact_id": "abc123", "artifact_hint": "Full page source available via fetch_artifact"}

# Fetch when needed:
fetch_artifact(artifact_id="abc123")

这使工具响应保持紧凑,同时保留按需访问完整输出的能力。

意图操作

intent_action 工具为常见测试操作提供了与库无关的入口点。它不需要 LLM 知道特定库的关键字名称和定位器语法,而是表达意图:

intent_action(intent="click", target="text=Login", session_id="...")
intent_action(intent="fill", target="#username", value="testuser", session_id="...")

服务器将意图 + 目标解析为会话活动库(Browser、SeleniumLibrary 或 AppiumLibrary)对应的正确关键字和定位器格式。

导航回退

当 intent_action(intent="navigate") 因没有打开浏览器或页面而失败时,服务器会自动打开浏览器/页面并重试:

  • Browser 库:执行 New Browser + New Page(如果浏览器已存在则仅执行 New Page)

  • SeleniumLibrary:执行 Open Browser about:blank chrome

响应中包含 fallback_applied: true 和 fallback_steps 计数。每个会话可节省 2-4 次工具调用。

批量执行

execute_batch 工具在单次 MCP 调用中执行多个关键字,将 N 次往返减少为 1 次。步骤可以通过 ${STEP_N} 变量引用前面步骤的结果:

execute_batch(session_id="...", steps=[
    {"keyword": "Go To", "args": ["https://example.com"]},
    {"keyword": "Get Title", "assign_to": "title"},
    {"keyword": "Should Be Equal", "args": ["${STEP_2}", "Example Domain"]}
], on_failure="recover")

如果某个步骤失败,resume_batch 允许您插入修复步骤并从失败点重试。

严格模式提示

当 Browser 库关键字因选择器匹配多个元素(Playwright 严格模式)而失败时,错误响应会包含提示,建议使用 >> nth=0(从零开始的索引)或 >> visible=true 选择器链,并附上使用实际关键字名称和元素数量的具体示例。

类型约束参数

所有 action/mode/strategy 参数都使用 Literal 类型,在 JSON Schema 中生成 enum 约束。这消除了幻觉值(例如,action="setup" 而不是 action="init")。所有值都接受不区分大小写的输入。

自动参数强制转换

常见的小型 LLM 错误会在服务器端自动纠正:

  • JSON 字符串化的数组("[\"Browser\"]")会被解析为原生数组

  • 逗号分隔的字符串("Browser,BuiltIn")会被拆分为列表

  • 已弃用的关键字(GET)会被映射到当前等效项(GET On Session)

指令模板

可配置的服务器级指令引导 LLM 遵循"先发现后行动"模式。选择适合您 LLM 能力的模板大小——从适用于 Claude Opus 的 minimal(约 40 个 token)到适用于 Claude Haiku 的 detailed(约 600 个 token)。请参阅上文 指令模板。


🧠 持久化语义记忆

RobotMCP 可以从过去的会话中学习并回忆成功的模式、定位器和错误修复——减少重复测试场景中的试错。

工作原理

记忆由 sqlite-vec(向量搜索)和 model2vec(256 维嵌入)驱动。启用后,服务器会:

  1. 存储每次工具调用后的成功步骤序列、有效定位器和错误→修复映射

  2. 回忆相关记忆并将其作为提示注入工具响应(例如,execute_step 失败时包含先前的修复方案,get_session_state 包含先前成功的步骤模式)

  3. 跨会话学习——热数据库在服务器重启后仍然保留

安装

pip install rf-mcp[memory]
# or
uv pip install rf-mcp[memory]

配置

通过环境变量启用:

{
  "servers": {
    "robotmcp": {
      "type": "stdio",
      "command": "uv",
      "args": ["run", "-m", "robotmcp.server"],
      "env": {
        "ROBOTMCP_MEMORY_ENABLED": "true",
        "ROBOTMCP_MEMORY_DB_PATH": "./memory.db"
      }
    }
  }
}

记忆 MCP 工具

启用记忆后,会额外提供五个工具:

工具

描述

recall_step

回忆先前成功的步骤序列。在构建新的测试步骤之前调用,以复用经过验证的模式。

recall_fix

回忆已知的错误修复方案。在 execute_step 失败后、重试之前立即调用。

recall_locator

回忆 UI 元素的有效定位器。在检查熟悉元素的 DOM 之前调用。

store_knowledge

存储领域知识(例如,站点结构、认证流程)以供将来回忆。

get_memory_status

在会话开始时检查记忆可用性和统计信息。

响应增强

记忆提示会自动注入到现有工具响应中——无需 LLM 配合:

  • execute_step 失败:错误响应中包含先前的修复方案和有效定位器

  • get_session_state:包含该场景先前成功的步骤模式

  • analyze_scenario:建议从过去会话中回忆的步骤序列

所有记忆查找都有 50ms 超时,以避免影响响应延迟。

基准测试结果

在 8 个场景(72 次 opencode 调用,每次 3 次迭代)中使用 qwen/qwen3-coder 进行测试:

场景类型

最佳结果

记忆召回率

复杂 Web 流程(结账)

-23% 调用,-22% 令牌

3/3 次迭代

重度探索式浏览

最佳迭代 -44% 调用

3/3 次迭代

API 错误恢复

-3% 调用 ±3%(最紧凑 CI)

3/3 次迭代

记忆优势在复杂、多步骤场景中最为显著,在这些场景中,过去的定位器和步骤序列可减少探索性工具调用。


⚙️ 配置

rf-mcp 以合理的默认设置运行;当您需要调整时,一切都可以通过环境变量实现——指令模板、attach 桥接、输出/令牌经济性、记忆、前端仪表盘、PlatynUI 桌面安全等。

完整参考: docs/CONFIGURATION.md — 每个 ROBOTMCP_* 变量及其可接受值和默认值,以及 robotmcp CLI 标志和子命令。

🤝 贡献

我们欢迎贡献!以下是入门方法:

  1. Fork 仓库

  2. Clone 您的 fork 到本地

  3. 安装开发依赖:uv sync

  4. 创建功能分支

  5. 添加新功能的全面测试

  6. 运行测试:uv run pytest tests/

  7. 提交 pull request

📝 更新日志

  • v0.34.0 – 原生桌面自动化(rf-mcp[desktop]、PlatynUI、Windows 就绪);项目感知安装程序,使用您项目自身的库;更精简的代理指令;修复冷启动挂起、Windows 试运行死锁和生成套件路径问题;在 FastMCP 3 上恢复工具配置文件

  • v0.31.1 – 打包清理(从 sdist 中排除测试/示例)

  • v0.31.0 – BDD/数据驱动生成、命名空间架构修复、持久记忆、71-88% 令牌减少

  • v0.30.1 – FastMCP 3.x 兼容层

  • v0.30.0 – 小型 LLM 优化(工具配置文件、意图操作、响应优化、类型约束)

  • v0.29.0 – 指令模板、多测试会话、批量执行、智能超时

📄 许可证

Apache 2.0 许可证 - 详情请参阅 LICENSE 文件。


⭐ 如果 RobotMCP 对您的测试自动化之旅有所帮助,请在 GitHub 上为我们点星!

为 Robot Framework 和 AI 自动化社区倾心打造。

Available Tools

19 tools
analyze_scenarioA

Analyze a natural-language scenario into structured intent and create a session.

WORKFLOW: This is the single front door — your FIRST tool call for any test scenario. It CREATES the session, so do NOT also call manage_session(action="init") for the same scenario (that causes redundant session churn). Reuse the returned session_id in every later call.

What this tool does:

  1. Creates a new session with unique session_id (or reuses provided one)

  2. Analyzes scenario to detect context (web/api/mobile/desktop)

  3. Auto-configures libraries based on scenario text

  4. Returns session_id for use in ALL subsequent tool calls

CRITICAL: Save the session_id from the response and use it in all other tool calls.

ParametersJSON Schema
NameRequiredDescriptionDefault
contextNoApplication context (e.g., "web", "mobile", "api", "desktop"); defaults to "web". An explicit context="desktop" DETERMINISTICALLY forces a native desktop (PlatynUI) session regardless of scenario wording — phrasing or word order cannot flip it to mobile/Appium. Use it for Linux/GNOME desktop GUI scenarios.web
scenarioYesHuman-language description of the task to automate.
session_idNoOptional existing session id to reuse; if omitted, a new one is created.

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden — and it mostly succeeds. It discloses the mutation behavior prominently (CREATES a session), explains the side effects of misuse (redundant session churn), and instructs the agent to save and reuse the returned session_id. It could note failure/error behavior, but the key behavioral traits are covered.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Well-structured with a WORKFLOW block, numbered steps, and a highlighted CRITICAL note, with the key routing information (front door, don't call manage_session) front-loaded. Minor redundancy exists between the WORKFLOW summary and the numbered list, but every section earns its place for an orchestration tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a complex orchestration tool, the description covers the full workflow: session creation, context detection, library auto-configuration, and session_id reuse across subsequent calls. An output schema exists, so return-value details are not the description's responsibility. The only gap is explicit error/failure behavior.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% with already-rich parameter text, including the deterministic desktop-forcing behavior of the context enum. Baseline 3 applies: the description confirms the workflow relationship to session_id but adds little parameter-level meaning beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb+resource ('Analyze a natural-language scenario into structured intent and create a session') and explicitly names it as 'the single front door'. It clearly distinguishes itself from the sibling manage_session by warning against redundant session churn, so an agent can tell it apart without opening other schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives explicit when-to-use guidance ('your FIRST tool call for any test scenario') and explicit when-not-to-use guidance ('do NOT also call manage_session(action="init")'). It names the alternative tool and the failure mode it avoids, leaving nothing to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

build_test_suiteC

Generate a Robot Framework test suite from previously executed steps.

ParametersJSON Schema
NameRequiredDescriptionDefault
tagsNoOptional test tags.
bdd_styleNoGenerate BDD-style suite with a Keywords section. When True, steps are grouped into behavioral keywords (Given/When/Then) and a ``*** Keywords ***`` section is appended to the generated .robot content.
test_nameYesName for the generated test case.
session_idNoSession containing executed steps; auto-resolves if empty/invalid.
output_pathNoOptional absolute path to persist the generated .robot suite to disk directly (UTF-8; parent directories created). ALWAYS use this to save a suite — do NOT write ``rf_text`` via the ``Create File`` keyword: Robot Framework resolves ``${variables}`` and interprets ``\n``/``\t`` escapes inside the argument, which silently corrupts the suite content (assigned vars collapse to their runtime values, escaped newlines become raw line breaks). Writing here goes through plain file I/O and preserves the generated text byte-for-byte. When set, the response includes ``output_path`` and ``output_bytes`` (or ``output_error`` on a write failure — the build still succeeds).
documentationNoOptional test case documentation.
data_driven_modeNoHow to render data-driven (template) test cases. "auto" (default) — auto-detect: named rows → suite_template, else per_test. "per_test" — [Template] per test case with data rows (current behavior). "suite_template" — Test Template in Settings, each named row is a separate test case with individual pass/fail in reports.auto
include_pre_startNoWhether to adopt exploratory steps executed BEFORE start_test into the generated test body. Default False excludes them (the response reports ``excluded_pre_start_count`` + a summary) so the suite reflects only intended in-test interactions. Set True to preserve the prior adoption behavior.
remove_library_prefixesNoWhether to strip library prefixes from keywords.

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only states that it generates a suite from steps, but omits side effects like file writing (hinted in schema) or whether state is modified. The description adds minimal behavioral context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, compact sentence that directly states the core purpose. It is appropriately sized and front-loaded, though it could incorporate more behavioral context without becoming verbose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (9 parameters) and lack of annotations, the description is inadequate. It doesn't explain the generation process, output format (despite an output schema), or edge cases like session_id auto-resolution. The schema fills parameter details, but the description fails to provide overarching usage context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all 9 parameters are thoroughly documented in the schema. The main description does not add any parameter-specific details or clarifications beyond what the schema provides, justifying the baseline score of 3.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly states the verb 'Generate' and the resource 'Robot Framework test suite' from 'previously executed steps'. It clearly indicates the tool's function and distinguishes it from execution-oriented siblings like run_test_suite, though it doesn't explicitly name alternatives.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives such as run_test_suite or execute_flow. There's no mention of prerequisites, context, or scenarios where this tool is preferred, leaving the agent to infer usage.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

check_library_availabilityA

Verify that specified Robot Framework libraries can be imported/installed.

Recommended as step 3 after analyze_scenario and recommend_libraries; use the recommended names to avoid unnecessary checks.

ParametersJSON Schema
NameRequiredDescriptionDefault
librariesYesLibrary names to verify (preferably from recommend_libraries output).

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description must convey behavioral traits. It states 'Verify' which implies a read-only check, but also mentions 'imported/installed' without clarifying whether it performs installation or just checks availability. It does not disclose side effects, error behavior, or what happens when a library is missing. This is a significant gap for a tool that may have installation implications.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences with the primary purpose front-loaded in the first sentence and usage recommendation in the second. No superfluous words, concise and scannable, making it easy for an agent to quickly grasp the tool's role.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has a simple one-parameter schema and an output schema, so the description does not need to explain return values. However, it leaves ambiguity about whether the tool only checks or also installs libraries, and what happens for unavailable libraries. Given the lack of annotations, this ambiguity affects completeness. While the usage workflow is clearly defined, the behavioral gap keeps it from being fully complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema already provides a complete description for the 'libraries' parameter, including a preference for using recommend_libraries output (100% schema coverage). The tool description adds no additional parameter semantics beyond what the schema provides, so the baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb 'Verify' and a resource 'specified Robot Framework libraries', clearly indicating the tool checks import/install availability. It does not explicitly name a sibling it is not, but the context of recommendation workflow helps distinguish it from 'recommend_libraries'. Overall, purpose is clear and actionable.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly recommends this as step 3 after 'analyze_scenario' and 'recommend_libraries', and advises using recommended names to avoid unnecessary checks. This provides clear when-to-use guidance and implies the tool should be used after library recommendation, not before, effectively routing the agent to the correct workflow.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

execute_batchA

Execute multiple RF keywords in one call with recovery and variable chaining.

Reduces N MCP round-trips to 1. Steps run sequentially; each step's return value is available to later steps via ${STEP_N} references in arguments. Both 0-based (${STEP_0} = first step) and 1-based (${STEP_1} = first step) indexing are accepted. When ambiguous, 1-based is preferred.

ParametersJSON Schema
NameRequiredDescriptionDefault
stepsYesList of step dicts, each with: - keyword (str, required): RF keyword name - arguments (list[str], optional): Positional arguments, may contain ${STEP_N} (both 0-based and 1-based indexing supported). This is the canonical key (parity with execute_step). The legacy alias ``args`` is also accepted; supplying BOTH with different values is a validation error. - label (str, optional): Human-readable label - timeout (str, optional): Per-step RF timeout (e.g., "10s") - assign_to (str, optional): Variable name to capture return value (e.g., "cart_count") NOTE: batch steps do NOT support ``bdd_group``/``bdd_intent`` — use per-step ``execute_step(bdd_group=..., bdd_intent=...)`` for BDD grouping. A step missing ``keyword`` returns an actionable validation error.
on_failureNoPolicy on step failure: - "stop": abort immediately - "retry": retry without recovery logic - "recover" (default): attempt tiered recovery before giving up On DESKTOP (PlatynUI) sessions, retries are restricted to failures where the input provably never fired (element-not-found); any other desktop failure records immediately instead of blindly re-firing a click/keystroke, and retries run with a capped descriptor-resolution timeout so a bad locator cannot burn the whole budget.recover
session_idYesSession to execute within (must exist or be auto-created).
timeout_msNoTotal batch time budget in milliseconds (1000-600000, default 120000).
max_recovery_attemptsNoMax recovery retries per failed step (1-10, default 2).

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.9/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the burden. It discloses sequential execution, variable chaining via ${STEP_N}, and the 0-based/1-based indexing ambiguity with a preference. It does not elaborate on recovery mechanics beyond 'with recovery', but the schema covers on_failure parameters. The disclosed sequencing and indexing are valuable behavioral insights.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise and well-structured. The first sentence states the core purpose, followed by a clear benefit (round-trip reduction), then precise behavioral details about sequencing and indexing. Every sentence carries necessary information without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the 5 parameters and existing output schema, the description covers the essential operational context: what it does, how steps chain, and indexing rules. It omits details like failure policies or timeout expectations, but those are documented in the schema parameters, so the description is sufficiently complete for an agent to call correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3. The description adds meaning beyond the schema by explaining the ${STEP_N} indexing nuances (0-based vs 1-based) and the preference when ambiguous, which is not fully specified in the schema's step description. This enriches the semantic understanding of arguments.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool executes multiple RF keywords in one call, with recovery and variable chaining. It differentiates from single-step siblings like execute_step by emphasizing batch execution and round-trip reduction, though it could more explicitly contrast with execute_flow or other batching tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies a batch use case via 'multiple keywords' and 'reduces N MCP round-trips to 1', but it does not explicitly state when to choose this over execute_step (e.g., for single keywords or BDD grouping). The schema notes BDD limitations, but the description itself lacks explicit alternatives or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

execute_flowC

Execute structured flow (if/for/try) within a session.

ParametersJSON Schema
NameRequiredDescriptionDefault
itemsNoItems to iterate when structure="for".
rethrowNoWhether to rethrow after except/finally.
item_varNoVariable name to bind each item in for-each loops.item
conditionNoExpression for if/conditional flows.
structureYesFlow type ("if", "for", "try").
try_stepsNoSteps for the try block (when structure="try").
else_stepsNoSteps for the else branch (if).
session_idYesSession id to run the flow in.
then_stepsNoSteps for the main branch (if/loop body/try block).
except_stepsNoSteps for the except block.
finally_stepsNoSteps for the finally block.
max_iterationsNoMaximum iterations for for-each loops.
except_patternsNoError patterns to match for except handling.
stop_on_failureNoWhether to stop loop/branch execution on first failure.

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations at all, the description carries the full burden of disclosing side effects, state changes, and error behavior, but it does not do so. It does not mention that executing a flow may mutate session state, how failures or rethrows behave, or whether partial execution leaves side effects. The schema hints at these behaviors through fields like stop_on_failure and rethrow, but the description itself does not surface them.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single compact sentence with the core idea front-loaded and no filler. While it is lean and well ordered, it is also somewhat under-specified for such a complex tool, so it earns a 4 rather than a 5.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 14-parameter control-flow executor with no annotations and many structure-dependent fields, a one-line description is not enough to guide correct invocation. It does not explain how the structure parameter selects among if/for/try block parameters, what side effects flow execution has on the session, or how errors are handled. The presence of an output schema reduces the return-value burden, but the invocation and execution semantics remain under-specified.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the input schema already documents all 14 parameters, including structure-specific fields like then_steps, except_steps, and max_iterations. The tool description adds no parameter-level meaning beyond what the schema already provides, so the baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb ('Execute'), a resource ('structured flow'), and enumerates the supported flow types ('if/for/try'), while scoping execution to a session. This makes it reasonably distinct from sibling tools like execute_step or execute_batch, though it does not explicitly name or contrast those alternatives.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use execute_flow versus execute_step, execute_batch, or other siblings. It only states the operation and the session context; there are no exclusions, conditions, or pointers to alternatives, so choosing this tool over its siblings is left entirely to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

execute_stepB

Execute a single Robot Framework keyword (or Evaluate) within a session.

ParametersJSON Schema
NameRequiredDescriptionDefault
modeNo"keyword" (default) or "evaluate" (runs BuiltIn.Evaluate).keyword
recordNoOverride the record gate that decides whether a successful step is appended to session.steps for build_test_suite output. - None (default): auto-classify. Read-only inspection keywords (Get Title, Log, etc.) are NOT recorded; everything else IS. Carve-outs that always record: ``assign_to`` is set, or a named test is currently open (after start_test). - True: force-record this step regardless of classification. - False: drop this step regardless of classification. The decision is surfaced as ``recorded: bool`` in the response.
keywordYesKeyword name (Library.Keyword supported). Use find_keywords to discover correct keyword names before calling.
argumentsNoKeyword arguments; positional and named (`name=value`) supported.
assign_toNoVariable name(s) to assign the result to (string or list). CRITICAL: Use this to capture results for later steps. Example: assign_to="response" captures ${response} variable
bdd_groupNoOptional group name for BDD keyword generation. Steps with the same bdd_group are clustered into a single behavioral keyword when build_test_suite(bdd_style=True) is called. Example: bdd_group="add product to cart"
bdd_intentNoBDD intent prefix for the group: "given", "when", "then", "and", "but". Used with bdd_group to assign Given/When/Then prefixes in the generated BDD test suite.
expressionNoExpression for mode="evaluate"; falls back to keyword/first argument.
session_idNoSession to execute in; resolves default if omitted.default
timeout_msNoOptional timeout in milliseconds for keyword execution. If not provided, uses smart defaults based on keyword type: - Element actions (Click, Fill): 5000ms - Navigation (Go To, New Page): 60000ms - Read operations (Get Text): 2000ms - API calls (GET, POST): 30000ms Set to 0 or negative to disable timeout.
use_contextNoWhether to run inside RF native context; defaults via config/attach.
detail_levelNoResponse verbosity: "minimal" | "standard" | "full".minimal
scenario_hintNoOptional scenario text to auto-configure libraries on first call.
raise_on_failureNoIf True, raise on failure; otherwise return error in payload.
pre_validate_timeout_msNoOverride the pre-validation gate's timeout for this single call. Pre-validation is the fast ~500ms-default check that verifies an element is visible / enabled before the keyword runs; it auto-retries once with a 200ms backoff on transient failures. - None (default): use ``ExecutionConfig.PRE_VALIDATION_TIMEOUT`` (500ms) for slow-loading pages this is sometimes too tight. - A positive int (e.g. 2000): extend the gate to this many milliseconds for this call only. Useful when a page legitimately takes ~1–2s to settle. - 0 or negative: skip pre-validation entirely for this call (last resort — also disables the keyword timeout). Failure responses include a ``pre_validate_timeout_hint`` entry explaining how to use this when the gate trips.

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

B3.2/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It only states the purpose and does not reveal side effects, error handling, or return behavior. While schema parameter descriptions cover things like recording and timeouts, the top-level description itself lacks any behavioral context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, front-loaded sentence that conveys the core action with zero waste. It is appropriately sized and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With 15 parameters, an output schema, and rich sibling tools, the description is too minimal. It does not synthesize the overall behavior (e.g., how steps are recorded for build_test_suite, BDD grouping, or when to use this over execute_batch). The schema covers details, but the high-level context is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema has 100% coverage with detailed descriptions for all 15 parameters. The one-sentence description adds no parameter-specific meaning beyond the schema, so the baseline of 3 is appropriate given the high schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it executes a single Robot Framework keyword or Evaluate within a session, distinguishing it from siblings like execute_batch or execute_flow that handle multiple steps. The verb 'Execute' and resource 'single Robot Framework keyword' are specific and unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description does not explicitly state when to use this tool versus alternatives. It mentions 'within a session' but provides no guidance on scenarios where execute_batch or execute_flow would be preferable. The only hint appears in the schema description for the keyword parameter, but that is not part of the tool description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

find_keywordsA

Discover Robot Framework keywords using multiple strategies.

WHEN TO USE THIS TOOL:

  • ALWAYS before calling execute_step with an unfamiliar keyword

  • When you're unsure of exact keyword name or spelling

  • To discover what keywords are available in imported libraries

  • When error says "No keyword with name 'X' found"

ParametersJSON Schema
NameRequiredDescriptionDefault
limitNoOptional maximum number of results to return.
queryYesSearch text or intent description. Examples: "click a button", "validate json", "get*request"
contextNoScenario context (e.g., "web", "mobile", "api") used by semantic discovery.web
strategyNoDiscovery approach: - "semantic": Hybrid keyword search combining name/doc pattern matching, tag/action-class classification, and (when installed) sentence-transformers embedding similarity. For best semantic ranking, install the optional extra: ``uv add robotmcp[semantic]``. Without the extra, falls back to pattern + tag + difflib SequenceMatcher ranking; the strategy is still useful but ranking quality is reduced. - "pattern": Glob/regex matching (best when you know partial name) - "catalog": List all available keywords. This is a LITERAL substring filter on keyword/library names — a multi-word natural-language query will return 0; use library_name= to list a library (e.g. "PlatynUI"/"PlatynUI.BareMetal"), or strategy="semantic" for intent matching. - "session": List keywords from session's loaded librariessemantic
session_idNoRequired for strategy="session" to search the live RF namespace.
library_nameNoOptional library filter applied to ALL strategies. When set, restricts results to the named library and its compatible siblings (e.g., library_name="Browser" excludes SeleniumLibrary but keeps BuiltIn, Collections, String). Takes precedence over the session's explicit_library_preference when both are present. Catalog strategy additionally scopes the underlying lookup to this library.
current_stateNoOptional state payload to improve semantic matching.
strict_libraryNoOBS-33 — when True AND a library preference is set (via ``library_name`` or session ``explicit_library_preference``), exclude EVERY library that isn't the preferred one. Default behaviour (False) preserves "compatible siblings" — BuiltIn / Collections / String / DateTime etc. remain visible alongside the preferred library. Use strict mode to scope discovery tightly to a single library (e.g., pattern ``"Get*"`` + ``library_name="Browser"`` + ``strict_library=True`` → Browser keywords only, no BuiltIn helpers).

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the behavioral burden. The detailed strategy parameter documentation discloses important behavior: semantic search has an optional dependency and falls back to pattern matching when not installed, catalog strategy is a literal substring filter that returns 0 for multi-word natural-language queries, and session strategy requires a session_id. It does not explicitly state read-only/no-side-effects, but 'Discover' plus the described search mechanics make the behavior clear.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core purpose, immediately followed by actionable usage guidance. The long parameter documentation is dense but each part earns its place given the tool's complexity, and no redundant or filler text is present.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has 8 parameters and an output schema, but the description covers all necessary context: when to call it, how each strategy behaves, library filtering, strict mode, and session requirements. An agent can correctly invoke this tool without needing to infer missing information.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the parameter descriptions go far beyond names. Each strategy is explained with its intended use and limitations, library_name semantics clarify sibling compatibility and precedence, and strict_library is described with a concrete example. This gives the agent everything needed to choose parameter values correctly.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: 'Discover Robot Framework keywords using multiple strategies.' It clearly distinguishes this discovery/search tool from execution tools like execute_step and detail tools like get_keyword_info by framing the tool as the way to find keywords before executing them.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides an explicit 'WHEN TO USE THIS TOOL' section with concrete triggers such as 'ALWAYS before calling execute_step with an unfamiliar keyword' and when an error says keyword not found. It does not explicitly name alternative tools for cases like retrieving details for a known keyword, so it stops short of full when-not guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_keyword_infoA

Get keyword/library docs or parse a signature. Call this before execute_step when you know the keyword name but not its arguments.

Modes: "keyword" (default — document one keyword), "library" (list a library's keywords), "session" (resolve against the live session namespace), "parse" (parse a signature string). Pass session_id to scope the lookup to that session's libraries.

ParametersJSON Schema
NameRequiredDescriptionDefault
modeNoOne of "keyword" (default), "library", "session", or "parse".keyword
argumentsNoOptional arguments to parse when mode="parse".
session_idNoOptional session id. - mode="keyword" / "global" (OBS-19): when provided without ``library_name``, restricts the keyword lookup to libraries imported in that session (plus neutral helpers like BuiltIn, Collections). When the keyword exists only in other libraries, the response carries a library-mismatch error + plugin-generated alternative hint instead of the keyword doc. Sessions without ``session_id`` get the global lookup (cross-library matches[]). - mode="session" / "namespace": required to address the live RF namespace. - **Externalisation gate (OBS-21)**: any mode with ``session_id`` provided enables artifact externalisation for large payloads (``library.doc``, ``library.keywords``, ``keyword.doc``, ``matches``). Without ``session_id``, payloads stay inline regardless of size — there's no artifact store to write to, so sessionless callers get the full content. Preserves backwards compat.
keyword_nameNoKeyword to document (required for modes "keyword"/"session"/"parse").
library_nameNoLibrary to document (required for mode "library"; optional for keyword mode — explicit per-call scope that takes precedence over session-derived scope).

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.2/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It does explain the modes and session scoping, but it does not explicitly state that it is a read-only operation or disclose potential behaviors like the library-mismatch error and artifact externalisation (though these are detailed in the schema). The description adds some context but not a comprehensive behavioral profile.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise: two sentences and a list of modes. The primary purpose is front-loaded, and every sentence contributes. No fluff or redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (5 parameters, multiple modes) and the presence of a detailed output schema and exhaustive schema descriptions, the description is sufficient. It covers the primary use case and mode enumeration. It omits some nuances (e.g., externalisation) but those are covered in the schema, so the description is adequately complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description adds value by clarifying the modes and the role of session_id (e.g., scoping the lookup), but it does not go deeply beyond what the schema already documents. It meets but does not exceed the baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states a specific action ('Get keyword/library docs or parse a signature') with a concrete verb and resource. It also enumerates distinct modes, making the tool's scope unambiguous and distinguishing it from other lookup tools like find_keywords.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly instructs when to use: 'Call this before execute_step when you know the keyword name but not its arguments.' It also lists modes, which implicitly guide when each is appropriate. This is clear, actionable guidance with no reliance on inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_locator_guidanceA

Provide locator/selector guidance for Browser, SeleniumLibrary, AppiumLibrary, PlatynUI.BareMetal, or RequestsLibrary.

For API testing, call with library="requests" (or "api") to get a RequestsLibrary request/response cookbook — session setup, response-field access (${resp.json()["field"]}), the $resp-in-Evaluate rule, Status Should Be, JSON body/headers, the Cookie token header, and expected_status= for non-2xx — BEFORE writing Evaluate-based assertions.

For VISUAL validation, call with library="visual" (or "screenshot") to learn WHEN a screenshot beats the DOM/ARIA tree (canvas/image text, layout/overlap, obscured elements, color, charts) and the dual read-back pattern — useful for any UI library (Browser/Selenium/Appium/PlatynUI) when a multimodal model drives rf-mcp.

ParametersJSON Schema
NameRequiredDescriptionDefault
libraryNoTarget library ("Browser", "SeleniumLibrary", "AppiumLibrary", "PlatynUI.BareMetal", or "RequestsLibrary"/"api"). Case-insensitive.browser
keyword_nameNoOptional keyword name for context-specific hints.
error_messageNoOptional error text to tailor guidance (e.g., from a failed keyword).

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description must carry the full burden. It explains the tool's action ('provide guidance') but does not disclose side effects, return format (though output schema exists), or any limitations. It is not misleading, but it does not add behavioral context beyond the basic function.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured, front-loading the core purpose and then detailing two important use cases. It is somewhat long but each sentence provides useful information, and the sections are clearly separated. No redundant words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description, combined with the presence of an output schema, covers the main usage scenarios effectively. It explains why and when to use it for API and visual cases, which are the most specialized. The general case (any of the listed libraries) is mentioned but could be slightly more elaborated, yet it is sufficient.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, but the description adds significant value for the `library` parameter by specifying aliases ('requests'/'api', 'visual'/'screenshot') and detailing what guidance each subset includes (API cookbook contents, visual validation scenarios). This enriches the schema's basic description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: providing locator/selector guidance for specific libraries (Browser, SeleniumLibrary, etc.). It distinguishes itself from siblings by highlighting specific use cases for API testing and visual validation, making it obvious when this tool is relevant versus others.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives explicit when-to-use guidance for two major scenarios: API testing (library='requests') and visual validation (library='visual'), including details like 'BEFORE writing Evaluate-based assertions.' However, it does not explicitly state when NOT to use it or mention alternatives beyond siblings, though the context makes it clear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_session_stateC

Retrieve aggregated session state for debugging and visibility.

ParametersJSON Schema
NameRequiredDescriptionDefault
modeNoauto
sectionsNoSpecific data blocks to include (e.g., summary, page_source, variables, application_state, ui_tree). ui_tree (desktop/PlatynUI sessions only): accessibility-tree snapshot. Lists applications; pass application names via elements_of_interest to expand their subtrees (bounded depth, ADR-025).
session_idYesActive session identifier to inspect.
state_typeNoType of application state to fetch when requesting application_state (dom|api|database|all).all
since_versionNo
dom_chunk_sizeNoMaximum size of each DOM chunk when streaming is enabled (minimum 1024 bytes).
include_dom_streamNoChunk large page_source payloads into page_source_stream entries for easier transport.
include_reduced_domNoWhether to include lightweight semantic DOM (ARIA snapshots) for quick inspection.
elements_of_interestNoTargeted element identifiers passed to application state collectors.
page_source_filteredNoWhen True, returns sanitized/filtered DOM text instead of the full source.
page_source_filtering_levelNoFiltering aggressiveness for DOM output (standard|aggressive).standard

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

C2.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden. It implies a read-only inspection ('Retrieve') and mentions debugging, but does not explicitly state non-mutating behavior, performance implications, or any side effects. The word 'retrieve' hints at safety but is not declared.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single 10-word sentence, which is extremely concise but under-specified for a tool with 11 parameters. While it has no fluff, it is not appropriately sized for the tool's complexity, missing necessary operational context.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (11 parameters, modes, streaming options), the description is far from complete. It does not define 'aggregated', explain deltas vs full state, or mention any configuration nuances. The output schema exists, but the behavior and semantics of the tool are largely undefined.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 82%, so most parameters are documented in the schema. The description adds 'aggregated' to clarify the output nature, but does not explain undocumented parameters like mode and since_version. The minimal description does not compensate for these gaps.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states a specific verb ('Retrieve') and resource ('aggregated session state') with a stated purpose ('for debugging and visibility'). It is distinct from siblings like manage_session which suggests management rather than read-only inspection.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool versus alternatives such as manage_session or execute_flow. The description gives a high-level purpose but no conditions, exclusions, or prerequisites for invoking this tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

intent_actionA

Execute a high-level intent that auto-resolves to the correct library keyword.

Valid intents: navigate, click, fill, hover, select, assert_visible, extract, wait_for.

Also accepted but DEPRECATED:

  • extract_text — equivalent to extract with mode="text". The extract verb is the canonical mode-aware getter (text / attribute / count / value / url / title) and additionally surfaces extracted_value at the top level of the response. extract_text will be removed in a future release; prefer intent="extract" for new code.

The intent is resolved based on the session's active library (Browser/SeleniumLibrary/AppiumLibrary).

ParametersJSON Schema
NameRequiredDescriptionDefault
nthNoZero-based nth-match index. Disambiguates when multiple elements match the same locator (e.g., an id duplicated across mobile vs desktop nav). Browser library appends ``>> nth=<n>``; SeleniumLibrary appends ``:nth-of-type(<n+1>)`` for CSS locators only (other locator types are unaffected and log a debug-level warning).
modeNoFor ``intent="extract"`` only. Selects what to read from the page; ignored for other intents. "text" — element text content (default) "attribute" — element attribute value (requires attribute_name) "count" — number of matching elements (multi-match OK) "value" — DOM property "value" (input values) "url" — current page URL (no target needed) "title" — current page title (no target needed) The extracted value is surfaced as ``result["extracted_value"]`` and assigned to ``assign_to`` if provided. mode="count" additionally skips pre-validation for this call — counting is the only mode where matching zero/multiple elements is the expected outcome rather than a failure.text
forceNoUse when: the element is visible but Playwright reports it "blocked by another element" — overlay, sticky header, cookie-consent banner, modal backdrop, animation still running. Symptom: ``Click intercepted`` or ``element is not stable`` / ``outside of the viewport`` errors despite the element appearing correct in the ARIA snapshot. Example: a "Submit" button covered by a sticky consent banner the user can't dismiss programmatically. What it does: for a Browser-library click intent, swaps ``Click`` for ``Click With Options force=True``, which skips Playwright's actionability checks. For other libraries / intents whose mapping declares no ``force_keyword``, the flag is silently ignored. Caveat: do NOT use ``force=True`` to drive elements that are genuinely hidden (display:none, visibility:hidden) — that's an anti-pattern; the resulting click won't behave like a real user click. Prefer natural locators first; fall through to ``force=True`` only when an overlay is the genuine cause.
matchNoSelect-match strategy for the ``select`` intent. ``"label"`` (default) - match by visible option text. Mirrors RF semantics for ``Select Options By label``. ``"value"`` - match by ``<option value="X">`` attribute. ``"index"`` - match by zero-based integer index. ``"text"`` - synonym for ``"label"`` (most libraries). ``"auto"`` - OPT-IN heuristic. Numeric value -> ``"value"``, otherwise ``"label"``. Use with care: numeric visible labels (years, amounts) mis-route. For SeleniumLibrary, this also picks the dispatched keyword (``Select From List By Label`` / ``Value`` / ``Index``). Ignored for non-select intents.label
valueNoValue for fill/select intents
commitNoUse when: the page uses Vue, React, Angular reactive forms, jQuery validate, idealForms, formvalidation.io, or any framework that gates validation on the DOM ``change`` event. Symptom: a form submit is rejected with a "required" or validation error despite every visible field appearing correctly filled; the framework's internal model still thinks the inputs are empty because Playwright's ``fill`` didn't fire a real ``change``. What it does: after a successful Browser-library FILL, dispatches a real DOM ``change`` event on the target via Browser's ``Dispatch Event`` keyword. Off by default — the follow-up is best-effort and any failure is logged and ignored (it never escalates a successful fill into a failed step). No effect for non-FILL intents, non-Browser libraries, or failed fills.
intentYesAction verb (e.g. "click", "navigate", "fill", "extract")
targetNoLocator or URL (e.g. "#submit", "text=Login", "https://example.com"). Optional for extract mode="url"/mode="title".
optionsNoAdditional options (e.g. {"timeout": "10s"})
assign_toNoVariable name to capture result (esp. useful for extract: the extracted text/count/attribute is assigned to this var).
session_idNoSession to execute against (uses default if not provided)
detail_levelNoResponse detail levelstandard
attribute_nameNoRequired when ``intent="extract"`` and ``mode="attribute"``; the HTML attribute name to read (e.g. ``"href"``, ``"data-testid"``, ``"value"``). Ignored for other modes.

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It explains that the intent is resolved based on the session's active library, lists valid intents, and details the deprecation of extract_text. It does not explicitly state whether operations can be mutating (e.g., clicks, fills) or require permissions, but it does give substantive behavior context. A 4 is appropriate.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is about 200 words, well-structured with paragraphs and bullet-like lists. It front-loads the purpose and valid intents, then addresses deprecation. It is not overly verbose and conveys key information efficiently, though it could be slightly tightened. A 4 reflects good organization without wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description, combined with the extremely detailed schema (100% coverage) and an output schema, provides a complete picture. It explains the intent resolution, deprecation, and library-dependent behavior. Nothing critical is missing for an agent to call this tool correctly, especially given the parameter-rich schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description itself focuses on the intent mechanism and deprecation, not on individual parameters. All parameter meanings are already exhaustively documented in the schema (mode, force, commit, match, etc.). The description adds no new parameter semantics beyond what the schema provides, hence the baseline 3.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb ('Execute') and resource ('high-level intent that auto-resolves to the correct library keyword'), and lists valid intents. It is clear and not a tautology, though it does not explicitly differentiate from sibling tools like execute_step or execute_flow, so it earns a 4 rather than a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description does not provide guidance on when to use this tool versus alternatives. It only mentions the deprecated extract_text and prefers extract, but does not say when to choose intent_action over execute_step, execute_flow, or other siblings. No when-to-use or when-not-to-use guidance is present.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

manage_attachC

Inspect or control attach bridge configuration.

ParametersJSON Schema
NameRequiredDescriptionDefault
actionNoOne of: - "status" (default): Check bridge configuration and health - "stop": Send stop command to bridge (sets stop flag) - "cleanup"/"clean": Clean expired sessions and check bridge health - "reset"/"reconnect": Stop bridge and clean all local sessions - "disconnect_all"/"terminate"/"force_stop": Force stop bridge and terminate allstatus

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

There are no annotations, so the description must carry the full burden of disclosing behavioral traits. 'Inspect or control' hints at mutation but does not disclose the potentially destructive force-stop/terminate/disconnect-all actions, side effects, or reversibility. The action enum documents these, but the description itself is silent.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is one concise, front-loaded sentence with no filler. It could be slightly more informative about destructive behavior, but as a high-level statement it is efficiently worded and easy to parse.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The rich action enum and presence of an output schema cover much of what an agent needs to invoke the tool, but the top-level description still lacks usage context and safety warnings for a tool with highly destructive actions. It is adequate but has clear gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The single parameter is 100% covered by schema descriptions with an exhaustive enum and per-action semantics, so the description does not need to add parameter detail. It also adds none, which is acceptable given the baseline for full schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

'Inspect or control attach bridge configuration' names a specific verb and resource, making the tool's scope clear. It is not tautological and the 'attach bridge' resource distinguishes it from the sibling session/library tools, though it does not explicitly reference them.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description offers no guidance on when to use this tool versus manage_session or the other siblings, no mention of the default action, and no exclusions. The only usage hints come from the action enum in the schema, which the description itself does not surface.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

manage_library_pluginsC

Inspect or reload library plugins.

ParametersJSON Schema
NameRequiredDescriptionDefault
actionNoOne of "list", "reload", or "diagnose".list
plugin_nameNoPlugin name when action="diagnose".

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

There are no annotations, so the description carries the full burden of explaining behavior. It implies reload is a mutating operation and inspect is non-mutating, but it does not disclose side effects, reversibility, permission requirements, or what diagnose actually does.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is four words with no filler, so it is very concise and front-loaded. However, the brevity creates ambiguity by substituting 'inspect' for the schema's more specific 'list' and 'diagnose' actions.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with three distinct actions and no annotation coverage, a single generic sentence is not enough. An agent cannot tell what diagnose entails, what reload's consequences are, or when to reach for this tool instead of a sibling. The output schema covers return shape but not these behavioral and usage gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Input schema coverage is 100%, and the schema already documents both parameters, including the action enum and the conditional plugin_name. The description adds no parameter-specific meaning, but the baseline of 3 is appropriate because the schema handles the semantic load.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description identifies a specific resource ('library plugins') and high-level operations ('inspect or reload'), giving a general sense of purpose. However, it collapses the three concrete actions in the schema (list, reload, diagnose) into two umbrella verbs, and it does not explicitly mention 'diagnose' as a distinct operation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided about when to use this tool or how to choose among list, reload, and diagnose. There is no mention of alternatives or exclusions, so the agent must infer usage solely from the schema enum and sibling names.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

manage_sessionA

Manage session lifecycle: initialize, configure libraries/variables, and organize tests.

For a NEW scenario, prefer analyze_scenario — it is the front door that CREATES the session (and auto-configures libraries). Use manage_session for explicit session ops on an existing session (importing extra libraries/resources/variables, multi-test structure). Do NOT call action="init" right after analyze_scenario — the session already exists; that only causes redundant churn.

Workflows: Single test: analyze_scenario -> execute_step (repeat) -> build_test_suite Multi-test: analyze_scenario -> set_suite_setup -> start_test -> execute_step (repeat) -> end_test -> start_test -> ... -> build_test_suite (action="init" is the explicit alternative when you are NOT starting from analyze_scenario, e.g. driving a bare session directly.)

Actions and parameters (session_id is always required):

init             - Create session and load libraries (explicit entry; for a new
                   scenario prefer analyze_scenario instead).
                   Params: libraries (list of library names),
                           variables (dict or list to pre-set).

import_library   - Add a library to an existing session.
                   Params: library_name, args (constructor args), alias.

import_resource  - Import a Robot Framework resource file.
                   Params: resource_path, args.

set_variables    - Set variables in the session.
                   Params: variables (dict {"NAME": "value"} or list ["NAME=value"]),
                           scope ("test" | "suite" | "global", default "suite").

import_variables - Load variables from a Python variable file.
                   Params: variable_file_path, args (passed to get_variables()).

start_test       - Begin a named test (enables multi-test mode). Local mode only.
                   Params: test_name (required),
                           test_documentation, test_tags,
                           test_setup (dict {"keyword": "...", "arguments": [...]}),
                           test_teardown (same format as test_setup).
                   Alias: start_task.

end_test         - End the current test. Local mode only.
                   Params: test_status ("pass" or "fail", default "pass"),
                           test_message (optional error description).
                   NOTE: test_status and test_message are session tracking metadata.
                   They do NOT affect the .robot file generated by build_test_suite.
                   Alias: end_task.

add_data_row     - Add a data row to the current data-driven (template) test.
                   Requires an active test with template set via start_test.
                   Params: args (list of values matching the template keyword's [Arguments]).
                   Alias: data_row.
                   Example:
                     manage_session(action="start_test", test_name="Cart Test",
                                  template="Add And Verify Product")
                     manage_session(action="add_data_row", args=["Backpack", "1", "$29.99"])
                     manage_session(action="add_data_row", args=["Bike Light", "2", "$39.98"])
                     manage_session(action="end_test")
                   The data rows appear under [Template] in the generated .robot file.

list_tests       - List all tests in the session with their status and step counts.
                   Params: (none).

set_suite_setup    - Set a suite-level setup keyword (appears in *** Settings ***).
                     Params: keyword (required), args (keyword arguments).

set_suite_teardown - Set a suite-level teardown keyword (appears in *** Settings ***).
                     Params: keyword (required), args (keyword arguments).

Returns: Dict with success, session_id, and action-specific details. On failure: error and guidance fields are present.

Examples: Initialize session with libraries: manage_session(action="init", session_id="s1", libraries=["Browser", "BuiltIn", "Collections"])

Set suite-level variables:
    manage_session(action="set_variables", session_id="s1",
                   variables={"BASE_URL": "https://example.com", "TIMEOUT": "30"})

Import a library with constructor arguments:
    manage_session(action="import_library", session_id="s1",
                   library_name="Browser", args=["chromium"])

Load a Python variable file:
    manage_session(action="import_variables", session_id="s1",
                   variable_file_path="config/variables.py",
                   args=["production", "secret_key"])

Start a named test (multi-test mode):
    manage_session(action="start_test", session_id="s1",
                   test_name="Login Test", test_tags=["smoke"],
                   test_setup={"keyword": "Open Browser", "arguments": ["chromium"]})

End the current test:
    manage_session(action="end_test", session_id="s1")

Set suite setup (for generated .robot file):
    manage_session(action="set_suite_setup", session_id="s1",
                   keyword="New Browser", args=["chromium"])

Set suite teardown:
    manage_session(action="set_suite_teardown", session_id="s1",
                   keyword="Close Browser")
ParametersJSON Schema
NameRequiredDescriptionDefault
argsNo
aliasNo
scopeNosuite
actionYes
keywordNo
profileNo
scenarioNo
templateNo
librariesNo
test_nameNo
test_tagsNo
variablesNo
model_nameNo
model_tierNo
session_idNo
test_setupNo
test_statusNopass
library_nameNo
test_messageNo
tool_profileNo
resource_pathNo
test_teardownNo
test_documentationNo
variable_file_pathNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It reveals important side effects and constraints: init after analyze_scenario causes redundant churn, end_test status is only session tracking metadata and does not affect the generated .robot file, add_data_row rows appear under [Template], and start_test/end_test are local mode only. This is strong, specific behavioral transparency.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is long but appropriately structured for a multi-action tool: it opens with the key routing warning, then provides workflows, per-action parameters, return behavior, and examples. Every section is useful, and the most important usage guidance is front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with 24 parameters, no annotations, and zero schema descriptions, the description is unusually comprehensive: it covers workflows, all major actions, return values, failure guidance, and common usage examples. The main gap is the undocumented set_tool_profile/tool_profile-related parameters and a few schema-only fields, leaving some invocation paths unexplained.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema has 0% description coverage, so the description compensates in detail for most parameters: each action lists its relevant params, and examples clarify data shapes such as variables, test_setup, and args. However, several schema parameters—profile, tool_profile, scenario, model_name, model_tier, and the set_tool_profile action—are not documented in the description, and template is referenced but not listed under start_test params. This prevents a perfect score.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The opening sentence states the tool's scope: "Manage session lifecycle: initialize, configure libraries/variables, and organize tests." It then differentiates itself sharply from analyze_scenario, which is the session-creating front door. This makes the tool's purpose and boundaries immediately clear.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives explicit when-to-use and when-not-to-use guidance: prefer analyze_scenario for new scenarios, do not call action="init" right after analyze_scenario, and use manage_session for explicit session operations on existing sessions. It also provides concrete single-test and multi-test workflows and an explicit alternative for the init action.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

recommend_librariesA

Recommend libraries for a scenario or generate/merge sampling prompts.

WHEN TO USE THIS TOOL:

  • IMMEDIATELY after analyze_scenario, before execute_step

  • When you encounter "No keyword with name" errors

  • To discover which libraries provide needed functionality

This tool analyzes scenario text and suggests relevant libraries, saving you from guessing which libraries to import.

ParametersJSON Schema
NameRequiredDescriptionDefault
kNoNumber of samples to request when mode="sampling_prompt" (defaults to 4).
modeNo"direct", "sampling_prompt", or "merge_samples".direct
contextNoContext such as "web", "mobile", or "api". Defaults to "web".web
samplesNoSampled recommendations to merge when mode="merge_samples".
scenarioYesNatural-language description of the task to automate.
session_idNoOptional session id to align recommendations with an existing session.
include_keywordsNoWhen True, include a compact keyword list (names only) for the top recommendation.
apply_search_orderNoWhen True, applies recommended order to the session.
check_availabilityNoWhen True, checks installability/presence of suggested libs.
use_llm_refinementNoWhen True, uses LLM via ctx.sample() to refine recommendations.
available_librariesNoOptional pre-fetched library metadata to use instead of registry defaults.
max_recommendationsNoMaximum libraries to return (direct mode).

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full disclosure burden, but it only describes a suggestion/analysis behavior. It does not disclose that the default apply_search_order=true can mutate session search order, that check_availability defaults to true and probes the environment, or that use_llm_refinement can invoke ctx.sample(). These are material behavioral traits for an agent deciding whether to call this tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is reasonably compact and front-loaded with the core purpose, followed by scannable bullets. It is slightly repetitive because the opening sentence and the final sentence both express the recommending idea, but the structure helps an agent scan quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The output schema and high schema coverage remove the need to describe return values and parameter formats. However, for a 12-parameter, multi-mode tool with no annotations, the description omits important context such as session-mutating defaults and how the sampling/merge modes relate to the main recommendation workflow.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description adds no parameter-level meaning beyond naming 'scenario' as the input; the schema's own parameter descriptions already carry the mode, k, samples, and flag semantics.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb and object: 'Recommend libraries for a scenario or generate/merge sampling prompts.' It reinforces this with 'analyzes scenario text and suggests relevant libraries', and situates it among siblings by saying it runs after analyze_scenario and before execute_step and is used to discover which libraries provide needed functionality.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The 'WHEN TO USE THIS TOOL' section gives explicit triggers: immediately after analyze_scenario, on 'No keyword with name' errors, and when discovering needed libraries. It lacks explicit when-not-to-use guidance or named alternative tools such as check_library_availability or find_keywords, so it is clear but not a full routing map.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

resume_batchA

Resume a failed batch from its failure point, optionally inserting fix steps.

After execute_batch returns status=FAIL with a batch_id, call this to:

  1. Re-run the failed step (with optional fix_steps injected before it)

  2. Continue executing remaining steps from the original batch

ParametersJSON Schema
NameRequiredDescriptionDefault
batch_idYesThe batch_id from a failed execute_batch response.
fix_stepsNoOptional steps to execute before retrying the failed step. Same format as execute_batch steps.
timeout_msNoOverride remaining timeout budget (uses original if omitted).

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavior disclosure. It clearly explains that the tool reruns the failed step, optionally injects fix_steps before it, and continues remaining steps from the original batch. It does not discuss side effects or edge cases like repeated failures, but the core execution behavior is transparent.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is compact and front-loaded with the core purpose, then uses a numbered list to clarify the exact order of operations. Every sentence earns its place; there is no redundant or filler content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description provides the essential precondition, the execution sequence, and the optional fix-step mechanism. Since an output schema exists, return-value details are not required, and the parameter schema covers format specifics. It could be slightly more explicit about not using this tool for non-failed batches, but the current framing is sufficient.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents each parameter thoroughly. The description adds workflow context around 'fix_steps' and the failure-point relationship, but does not meaningfully expand on parameter formats or defaults beyond what the schema provides.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb ('resume') with a clear resource ('a failed batch'), and precisely states the behavior: re-run the failed step and continue remaining steps. It clearly differentiates itself from execute_batch by describing the failure-point continuation workflow rather than initial execution.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives a specific trigger condition: 'After execute_batch returns status=FAIL with a batch_id, call this to...' This is clear enough for an agent to know when to invoke it. It does not explicitly list exclusions or alternative tools, but the failure condition and step-by-step follow-up make the usage context unambiguous.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

run_test_suiteB

Validate or execute a Robot Framework suite.

ParametersJSON Schema
NameRequiredDescriptionDefault
modeNo"dry"/"validate" for dry run; "full" to execute. Defaults to "full".full
session_idNoSession containing steps to build/execute; optional if suite_file_path is given.
output_levelNoResponse verbosity ("minimal", "standard", "detailed").standard
suite_file_pathNoPath to an existing .robot file to validate/execute.
include_warningsNoWhether to include warnings in validation output.
validation_levelNoDry-run validation depth ("minimal", "standard", "strict"). Default "standard".standard
execution_optionsNoRF execution options (variables, tags, loglevel, etc.). For ``suite_file_path`` with dry/validate mode, these are forwarded to Robot (e.g. ``variables``, ``include_tags``, ``exclude_tags``, ``test`` / ``tests``, ``pythonpath``, ``loglevel``). Subprocess cap: ``dry_run_timeout`` (preferred), ``dryrun_timeout``, or ``timeout`` (seconds); default comes from config ``DRY_RUN_TIMEOUT``.
capture_screenshotsNoEnable screenshot capture on failures (if supported).

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

B3.2/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description must disclose behavior on its own. It only states 'validate or execute', but doesn't mention side effects (e.g., whether execution is destructive, whether it generates reports, whether it requires a running session) or any constraints. This is insufficient for an agent to predict the tool's impact, especially given the tool's complexity.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, concise sentence that front-loads the tool's purpose. It avoids unnecessary detail and stays focused, scoring high on efficiency. There is no redundant wording or filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite having eight parameters, nested options, and an output schema, the one-sentence description does not explain overall workflow, mode selection, or parameter combinations (e.g., session_id vs suite_file_path). The schema covers individual parameters, but the description lacks the high-level context needed for a tool this complex, especially with sibling tools that may overlap in functionality.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema already provides descriptions for all parameters (100% coverage), so the description does not need to repeat them. The description adds nothing about parameter usage, but the baseline is 3 given complete schema coverage. The description's lack of parameter context doesn't degrade the score, as the schema fills the gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's function: 'Validate or execute a Robot Framework suite.' It specifies the resource (Robot Framework suite) and the actions (validate/execute), which is enough to distinguish it from sibling tools that target individual steps or flows. The verb is specific and the scope is unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description offers no guidance on when to use this tool over alternatives like build_test_suite, execute_flow, or execute_step. It neither states conditions nor recommends alternatives, leaving the agent to infer usage from the tool name and schema. There is no mention of prerequisites or typical scenarios.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

set_library_search_orderC

Set explicit library search order for keyword resolution.

ParametersJSON Schema
NameRequiredDescriptionDefault
librariesYesLibrary names in priority order (highest first).
session_idNoSession to apply the search order to.default

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations are absent, so the description carries the full burden. It only says 'set', which implies a mutation, but does not disclose consequences such as whether the order is replaced entirely, session-specific effects, permissions required, or any side effects. For a mutation tool, this is insufficient disclosure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, focused sentence that front-loads the core action and purpose. There is zero waste—every word contributes meaning. It is optimally concise for its content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite having an output schema, the description lacks critical behavioral context: what an 'explicit order' means in practice, whether it replaces or merges with existing orders, and how it affects keyword resolution across sessions. Since annotations are missing, the description should fill this gap but does not.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with both parameters well-documented ('Library names in priority order (highest first)' and 'Session to apply the search order to'). The description adds no parameter-specific detail beyond the schema, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action 'Set' and the resource 'library search order', with the purpose 'for keyword resolution'. It is distinct from siblings like manage_library_plugins and recommend_libraries, though it does not explicitly name them. The verb and resource are specific enough to differentiate.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no guidance on when to use this tool versus alternatives. The description only states what it does, with no mention of conditions, exclusions, or scenarios where another tool would be more appropriate. This is a significant gap given the large sibling list.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

visual_checkA

Capture a screenshot of the current UI for VISUAL validation (change: visual-inspection-guidance).

Token-cheap by DEFAULT: saves the screenshot to disk and returns the PATH as text — a multimodal agent WITH file access reads that file on demand for checks the DOM/ARIA can't do (canvas/image text, layout/overlap, obscured elements, color, charts). Call get_locator_guidance(library="visual") for when to use it.

Set return_image=true ONLY if your model is multimodal AND cannot read the saved file (e.g. a hosted/remote MCP): the response then includes an image content block. This requires ROBOTMCP_SCREENSHOT_MODE to allow images (image|auto); text-only deployments (mode=file, the default) always return just the path so a text-only model is never sent unsupported image content.

Works across Browser/SeleniumLibrary/AppiumLibrary/PlatynUI (uses the session's screenshot keyword). Degrades cleanly if capture fails.

ParametersJSON Schema
NameRequiredDescriptionDefault
filenameNo
session_idYes
return_imageNo

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description fully carries the burden. It discloses default behavior (saves to disk, returns path), the effect of return_image=true (image content block), the required ROBOTMCP_SCREENSHOT_MODE, and graceful degradation on failure. This is rich and actionable.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is long but every sentence earns its place. It is front-loaded with the core action and then covers options, environment, and compatibility. The structure is logical and not repetitive, though slightly dense.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema and no annotations, this description is near-complete: it covers purpose, usage scenarios, return types, environmental requirements, supported libraries, and failure behavior. An agent would have enough context to invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description must compensate. It thoroughly explains return_image (default false, mode requirements) and implies filename through 'saves the screenshot to disk'. session_id is left inferred, but overall it adds significant meaning to otherwise bare parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: 'Capture a screenshot of the current UI for VISUAL validation'. It explicitly distinguishes the tool's use case (checks DOM/ARIA can't do) from other tools. This makes it easy to differentiate from siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides explicit when-to-use guidance by listing scenarios like 'canvas/image text, layout/overlap, obscured elements, color, charts' and directs to 'Call get_locator_guidance(library="visual")' for more. It also implies not to use when DOM/ARIA checks suffice.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 19 tool updatesv0.35.0
    • First observedanalyze_scenario
    • First observedbuild_test_suite
    • First observedcheck_library_availability
    • First observedexecute_batch
    • First observedexecute_flow
    • First observedexecute_step
    • First observedfind_keywords
    • First observedget_keyword_info
    • First observedget_locator_guidance
    • First observedget_session_state
    • First observedintent_action
    • First observedmanage_attach
    • First observedmanage_library_plugins
    • First observedmanage_session
    • First observedrecommend_libraries
    • First observedresume_batch
    • First observedrun_test_suite
    • First observedset_library_search_order
    • First observedvisual_check

TDQS

B3.4/5.0

Scored across 19 tools

Disambiguation3/5

The set has several overlapping clusters: session creation (analyze_scenario vs manage_session init), execution (intent_action, execute_step, execute_batch, execute_flow), and keyword/library discovery (recommend_libraries, find_keywords, get_keyword_info, check_library_availability). The detailed descriptions help differentiate these tools, but the boundaries are not always obvious, and two discovery tools share the same 'No keyword with name' trigger.

Naming Consistency4/5

Most tools follow a clear verb_noun snake_case pattern such as execute_batch, recommend_libraries, and build_test_suite. A few names deviate—intent_action is noun-oriented and visual_check is adjective+noun—but the overall convention is consistent and readable.

Tool Count3/5

19 tools is on the heavy side and includes several near-duplicate discovery and execution aids that could be consolidated. However, the server covers a broad workflow from scenario analysis through suite generation and visual validation, so the count is not unreasonable for its scope.

Completeness4/5

The workflow from scenario analysis through keyword discovery, execution, batching, suite generation, and running is well covered. Minor gaps exist, such as no explicit session teardown/reset action and some redundancy among discovery helpers, but agents can work around these.

Maintenance

ActivitySlowing
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers

  • A
    license
    B
    quality
    B
    maintenance
    RobotMCP is a comprehensive Model Context Protocol (MCP) server that bridges the gap between human language and Robot Framework automation. It enables AI agents to understand test intentions, execute steps interactively, and generate complete test suites from successful executions.
    19
    2,793 PyPI
    117
    Apache 2.0
  • A
    license
    Not graded
    quality
    D
    maintenance
    Enables generating Robot Framework test cases with SeleniumLibrary, creating page object models, and performing performance monitoring through natural language.
    9 npm
    MIT
  • A
    license
    Not graded
    quality
    C
    maintenance
    Enables AI agents to drive Robot Framework through natural language, discovering keywords, running live test steps across web, mobile, API, database, and desktop targets, and generating clean .robot test suites from plain-English instructions.
    Apache 2.0