arcade-mcp/examples/evals/eval_arcade_gateway.py
jottakka 98fad93d21
Adding MCP Servers supports to Arcade Evals (#689)
# MCP Server Tool Evaluation Support

## Overview
Add support for evaluating tools from remote MCP servers without
requiring Python callables. Enables direct evaluation of any
MCP-compatible tool server.

## What's New

### Core Features
- **`MCPToolRegistry`**: Evaluate tools from a single MCP server
- **`CompositeMCPRegistry`**: Evaluate tools from multiple MCP servers
simultaneously
- **Automatic loaders**: `load_from_stdio()` and `load_from_http()` to
fetch tools from running servers
- **Automatic namespacing**: Tools prefixed with server name (e.g.,
`server_tool_name`)
- **Smart name resolution**: Use short names if unique, full names if
ambiguous
- **OpenAI strict mode**: Automatic schema conversion prevents parameter
hallucinations

### Usage

**Automatic Loading:**
```python
from arcade_evals import load_from_stdio, MCPToolRegistry

# Load tools automatically from MCP server
tools = load_from_stdio(["npx", "-y", "@modelcontextprotocol/server-github"])
registry = MCPToolRegistry(tools)
```

**Single MCP Server:**
```python
from arcade_evals import MCPToolRegistry, ExpectedToolCall

registry = MCPToolRegistry(mcp_tools)
suite = EvalSuite(catalog=registry)

suite.add_case(
    expected_tool_calls=[
        ExpectedToolCall(tool_name="tool_name", args={...})
    ]
)
```

**Multiple MCP Servers:**
```python
from arcade_evals import CompositeMCPRegistry, load_from_stdio

# Load from multiple servers
github_tools = load_from_stdio(["npx", "-y", "@modelcontextprotocol/server-github"])
slack_tools = load_from_stdio(["npx", "-y", "@modelcontextprotocol/server-slack"])

composite = CompositeMCPRegistry(
    tool_lists={
        "github": github_tools,
        "slack": slack_tools,
    }
)

suite = EvalSuite(catalog=composite)

suite.add_case(
    expected_tool_calls=[
        ExpectedToolCall(tool_name="github_list_issues", args={...})
    ]
)
```

## Implementation

### Files Changed
- **`libs/arcade-evals/arcade_evals/registry.py`** (NEW): Registry
abstractions and implementations
- **`libs/arcade-evals/arcade_evals/loaders.py`** (NEW): Automatic tool
loading from MCP servers
- **`libs/arcade-evals/arcade_evals/eval.py`** (MODIFIED): Enhanced
`ExpectedToolCall` and evaluation logic
- **`libs/arcade-evals/arcade_evals/__init__.py`** (MODIFIED): Exported
new registries and loaders

### Key Technical Details
- Added `BaseToolRegistry` interface for abstraction
- `MCPToolRegistry` handles single server tools
- `CompositeMCPRegistry` manages multiple servers with collision
detection
- `load_from_stdio()` and `load_from_http()` for automatic tool
discovery
- Fixed name normalization bug: MCP tools use underscores (not dots)
- Optimized tool copying: 2.5x faster via shallow copy

## Testing
-  41 tests passing (25 new tests added)
-  `test_eval_mcp_registry.py`: MCPToolRegistry functionality
-  `test_eval_composite_mcp.py`: CompositeMCPRegistry with multiple
servers
-  Verified backward compatibility with Python tools

## Backward Compatibility
 **100% backward compatible** - No breaking changes


## Breaking Changes
**None**


<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Adds end-to-end eval UX: examples, a robust CLI runner, and rich
outputs.
> 
> - **New examples**: `eval_arcade_gateway.py`,
`eval_stdio_mcp_server.py`, `eval_http_mcp_server.py`,
`eval_comprehensive_comparison.py` with timeouts, error handling, and
track-based comparisons; detailed `README.md`
> - **CLI runner**: `arcade_cli/evals_runner.py` to execute
evals/capture in parallel with progress, error isolation, failed-only
filtering, context inclusion, and multi-provider/model support
> - **Output formatters**: `arcade_cli/formatters/` (txt, md, html,
json) for evals and capture; comparative and multi-model HTML with tabs
and context rendering
> - **Display refactor**: `display.py` now supports writing multiple
formats, failed-only disclaimers, include-context, and improved console
summaries
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
ff8acf9c34a6b61462a019a1ee9df081006517d0. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Francisco Liberal <francisco@arcade.dev>
Co-authored-by: Mateo Torres <torresmateo@gmail.com>
2026-01-07 20:26:23 -03:00

135 lines
4 KiB
Python

"""Arcade Gateway evaluation - Loading tools from cloud-hosted toolkits.
This example demonstrates loading and evaluating tools from Arcade Gateway,
which provides access to pre-built toolkits (Math, GitHub, Slack, Linear, etc.).
Prerequisites:
1. Get your API key: https://docs.arcade.dev/en/get-started/setup/api-keys
2. Create an MCP Gateway at https://portal.arcade.dev
3. Add toolkits to your gateway (e.g., Math, GitHub, Slack)
4. Get your ARCADE_API_KEY and ARCADE_USER_ID from the portal
Full setup guide: https://docs.arcade.dev/en/guides/create-tools/mcp-gateways
Run:
# Set environment variables
export ARCADE_API_KEY=your_arcade_key
export ARCADE_USER_ID=your_user_id
# Run the evaluation
arcade evals examples/evals/eval_arcade_gateway.py \\
-p openai:gpt-4o \\
-k openai:YOUR_KEY \\
-o results.html -d
"""
import asyncio
import os
from arcade_evals import (
BinaryCritic,
EvalRubric,
EvalSuite,
ExpectedMCPToolCall,
tool_eval,
)
# =============================================================================
# CONFIGURATION
# =============================================================================
ARCADE_API_KEY = os.environ.get("ARCADE_API_KEY", "YOUR_ARCADE_API_KEY_HERE")
ARCADE_USER_ID = os.environ.get("ARCADE_USER_ID", "YOUR_USER_ID_HERE")
default_rubric = EvalRubric(
fail_threshold=0.7,
warn_threshold=0.9,
)
# =============================================================================
# EVAL SUITE
# =============================================================================
@tool_eval()
async def eval_arcade_gateway() -> EvalSuite:
"""Evaluate Math toolkit from Arcade Gateway."""
suite = EvalSuite(
name="Arcade Gateway - Math Toolkit",
system_message="You are a helpful math assistant. Use tools to perform calculations.",
rubric=default_rubric,
)
print("\n Loading Arcade Gateway...")
try:
await asyncio.wait_for(
suite.add_arcade_gateway(
gateway_slug="Math",
arcade_api_key=ARCADE_API_KEY,
arcade_user_id=ARCADE_USER_ID,
),
timeout=10.0,
)
print(" ✓ Arcade Gateway (Math toolkit)")
except asyncio.TimeoutError:
print(" ✗ Arcade Gateway - timeout")
return suite
except Exception as e:
print(f" ✗ Arcade Gateway - {type(e).__name__}: {e}")
return suite
# Test Case 1: Simple addition
suite.add_case(
name="Simple addition - 10 + 5",
user_message="What is 10 plus 5?",
expected_tool_calls=[
ExpectedMCPToolCall(
tool_name="Math_Add",
args={"a": 10, "b": 5},
)
],
critics=[
BinaryCritic(critic_field="a", weight=0.5),
BinaryCritic(critic_field="b", weight=0.5),
],
)
# Test Case 2: Larger numbers
suite.add_case(
name="Addition - 123 + 456",
user_message="Calculate 123 + 456",
expected_tool_calls=[
ExpectedMCPToolCall(
tool_name="Math_Add",
args={"a": 123, "b": 456},
)
],
critics=[
BinaryCritic(critic_field="a", weight=0.5),
BinaryCritic(critic_field="b", weight=0.5),
],
)
# Test Case 3: Conversational context
suite.add_case(
name="Addition with context",
user_message="Now add them together",
expected_tool_calls=[
ExpectedMCPToolCall(
tool_name="Math_Add",
args={"a": 50, "b": 25},
)
],
critics=[
BinaryCritic(critic_field="a", weight=0.5),
BinaryCritic(critic_field="b", weight=0.5),
],
additional_messages=[
{"role": "user", "content": "I have two numbers: 50 and 25"},
{"role": "assistant", "content": "Great! I'll remember those numbers."},
],
)
return suite