arcade-mcp/libs/tests/arcade_mcp_server/test_middleware_base.py
Eric Gustin 3424ec8219
MCP Local (#563)
Versions:
* arcade-mcp\==1.0.0rc1
* arcade-mcp-server\==1.0.0rc1
* arcade-core\==2.5.0rc1
* arcade-tdk\==2.6.0rc1
* arcade-serve\==2.2.0rc1

### Summary
Adds first-class MCP support across Arcade, introduces a new MCP server
and CLI, unifies the project under the arcade-mcp name, overhauls
templates/scaffolding, and improves developer tooling, secrets
management, and examples.

### Highlights
- **MCP Server & Core**
- New MCP server with stdio and HTTP/SSE transports, session management,
resumability, and lifecycle handling.
- FastAPI-like `MCPApp` for building servers with lazy init; integrated
worker+MCP HTTP app option.
- Middleware system (logging and error handling), robust exception
hierarchy, and Pydantic-based settings.
- Async-safe managers for tools, resources, and prompts backed by
registries and locks.
- Developer-facing, transport-agnostic runtime context interfaces (logs,
tools, prompts, resources, sampling, UI, notifications).
- Conversion from Arcade ToolDefinition to MCP tool schema; OpenAI JSON
tool schema converter.
  - Parser supports `@app.tool`/`@app.tool(...)` decorators.

- **CLI**
  - New `mcp` command to run MCP servers with stdio or HTTP/SSE.
- New `secret` command to set/list/unset tool secrets (supports .env
input, preserves original casing for lookups).
- `new` command refactored; option to create a full toolkit package with
scaffolding.
  - `chat` command removed.
- `serve.py` imports updated to `arcade_serve.fastapi.telemetry`;
version retrieval now uses `arcade-mcp`.
  - `show.py` refactor to use new local catalog utilities.
- `display_tool_details` improved: adds “Default” column and handles
nested properties.

- **Configuration & Discovery**
- New `configure.py` to set up Claude Desktop, Cursor, and VS Code to
connect to local or Arcade Cloud MCP servers.
- Discovery utilities to find/install toolkits, build `ToolCatalog`s,
analyze files for tools, load kits from directories (pyproject parsing),
and build minimal toolkits.
- Better handling of provider API key resolution and evaluation suite
loading.

- **Templates & Scaffolding**
- Reorganized template structure (minimal vs full); moved
`.pre-commit-config.yaml`, `.ruff.toml`, license, Makefile, README,
tests, and tools layout to correct paths.
  - Minimal template adds `.env.example` for runtime secret injection.
- Template pyproject updated for MCP servers; includes sample server
with greeting and secret-reveal tools.
  - Authorization flow in templates simplified.

- **Repo-wide Renaming & Examples**
- Migrates references from `arcade-ai` to `arcade-mcp` across READMEs,
scripts, and package metadata.
- Examples updated (LangChain/LangGraph/AI SDK/TypeScript) and package
name changed to `arcade-mcp-sdk`.

- **Evals & Core Utilities**
- Evals now use OpenAI tooling format (`OpenAIToolList`, `to_openai`);
`tool_eval` takes `provider_api_key`.
- Core utilities: fixed `does_function_return_value` by dedenting before
parse; version bump to `2.5.0rc1` and dependency cleanup.

- **Tooling & CI**
- `setup-uv-env` action splits toolkit vs contrib dependency
installation.
- Pre-commit: excludes `libs/arcade-mcp-server/mkdocs.yml` and
`libs/tests/` from YAML and Ruff hooks; Ruff per-file ignores (e.g.,
C901 in `libs/**/*.py`, TRY400 in server docs paths).
- Makefile updates for uv env setup, quality checks, tests, builds, and
new `shell` target.
  - Added Makefile to MCP server library to streamline dev workflow.

- **Cleanup**
  - Removed `claude.json` config.
- Simplified stdio entrypoint; removed unused imports (`arcade_gmail`,
`arcade_search`).

### Breaking Changes
- **CLI**: `chat` command removed; use `mcp`, `secret`, and updated
`new`.
- **Naming**: All users should update references from `arcade-ai` to
`arcade-mcp`.
- **Templates**: File paths moved; downstream scripts referencing old
template locations may need updates.

### Getting Started
- Run an MCP server:
  - `arcade mcp --stdio --toolkits your_toolkit`
  - `arcade mcp --http --toolkits your_toolkit`
- Manage secrets:
  - `arcade secret set your_toolkit KEY=value`
  - `arcade secret list your_toolkit`
  - `arcade secret unset your_toolkit KEY`
- Configure clients:
- `arcade configure` to set up Claude Desktop, Cursor, and VS Code for
local/Arcade Cloud MCP.

---------

Co-authored-by: Sam Partee <sam@arcade-ai.com>
Co-authored-by: Shub <125150494+shubcodes@users.noreply.github.com>
2025-09-25 15:28:15 -07:00

209 lines
6.7 KiB
Python

"""Tests for Middleware base classes."""
from unittest.mock import Mock
import pytest
from arcade_mcp_server.middleware.base import (
Middleware,
MiddlewareContext,
)
class TestMiddlewareBase:
"""Test base middleware functionality."""
def test_middleware_context_creation(self):
"""Test MiddlewareContext creation."""
message = {"method": "test", "params": {}}
context = MiddlewareContext(
message=message,
mcp_context=Mock(),
source="client",
type="request",
method="test",
request_id="req-123",
session_id="sess-456",
)
assert context.message == message
assert context.source == "client"
assert context.type == "request"
assert context.method == "test"
assert context.request_id == "req-123"
assert context.session_id == "sess-456"
def test_middleware_context_metadata(self):
"""Test metadata management in context."""
context = MiddlewareContext(message={}, mcp_context=Mock())
# Initial metadata is empty
assert context.metadata == {}
# Add metadata
context.metadata["key1"] = "value1"
context.metadata["key2"] = {"nested": "value"}
assert context.metadata["key1"] == "value1"
assert context.metadata["key2"]["nested"] == "value"
@pytest.mark.asyncio
async def test_basic_middleware(self):
"""Test basic middleware implementation."""
# Track calls
middleware_called = False
class TestMiddleware(Middleware):
async def __call__(self, context, call_next):
nonlocal middleware_called
middleware_called = True
# Pass through to next
return await call_next(context)
# Create middleware
middleware = TestMiddleware()
# Mock next handler
async def next_handler(ctx):
return {"result": "success"}
# Execute
context = MiddlewareContext(message={}, mcp_context=Mock())
result = await middleware(context, next_handler)
assert middleware_called
assert result == {"result": "success"}
@pytest.mark.asyncio
async def test_middleware_modification(self):
"""Test middleware that modifies context."""
class ModifyingMiddleware(Middleware):
async def __call__(self, context, call_next):
# Modify context before
context.metadata["before"] = True
# Call next
result = await call_next(context)
# Modify result after
if isinstance(result, dict):
result["after"] = True
return result
middleware = ModifyingMiddleware()
async def next_handler(ctx):
assert ctx.metadata["before"] is True
return {"original": "value"}
context = MiddlewareContext(message={}, mcp_context=Mock())
result = await middleware(context, next_handler)
assert result == {"original": "value", "after": True}
@pytest.mark.asyncio
async def test_middleware_chain(self):
"""Test chaining multiple middleware."""
call_order = []
class Middleware1(Middleware):
async def __call__(self, context, call_next):
call_order.append("m1_before")
result = await call_next(context)
call_order.append("m1_after")
return result
class Middleware2(Middleware):
async def __call__(self, context, call_next):
call_order.append("m2_before")
result = await call_next(context)
call_order.append("m2_after")
return result
# Build chain manually
async def final_handler(ctx):
call_order.append("handler")
return "result"
m2 = Middleware2()
m1 = Middleware1()
# Chain: m1 -> m2 -> handler
async def m2_wrapped(ctx):
return await m2(ctx, final_handler)
context = MiddlewareContext(message={}, mcp_context=Mock())
result = await m1(context, m2_wrapped)
# Check order
assert call_order == ["m1_before", "m2_before", "handler", "m2_after", "m1_after"]
assert result == "result"
@pytest.mark.asyncio
async def test_middleware_error_propagation(self):
"""Test error propagation through middleware."""
class ErrorMiddleware(Middleware):
async def __call__(self, context, call_next):
try:
return await call_next(context)
except ValueError as e:
# Transform error
raise RuntimeError(f"Wrapped: {e}")
middleware = ErrorMiddleware()
async def failing_handler(ctx):
raise ValueError("Original error")
context = MiddlewareContext(message={}, mcp_context=Mock())
with pytest.raises(RuntimeError) as exc_info:
await middleware(context, failing_handler)
assert "Wrapped: Original error" in str(exc_info.value)
@pytest.mark.asyncio
async def test_middleware_short_circuit(self):
"""Test middleware that short-circuits the chain."""
class ShortCircuitMiddleware(Middleware):
async def __call__(self, context, call_next):
# Don't call next for certain conditions
if context.message.get("skip"):
return {"short_circuited": True}
return await call_next(context)
middleware = ShortCircuitMiddleware()
# Normal flow
context1 = MiddlewareContext(message={}, mcp_context=Mock())
async def handler(ctx):
return {"normal": True}
result1 = await middleware(context1, handler)
assert result1 == {"normal": True}
# Short circuit
context2 = MiddlewareContext(message={"skip": True}, mcp_context=Mock())
result2 = await middleware(context2, handler)
assert result2 == {"short_circuited": True}
def test_middleware_protocol(self):
"""Test that Middleware follows the protocol."""
# Middleware should be a protocol/ABC
assert callable(Middleware)
# Should not be instantiable directly
# (This is more of a documentation test since Python protocols are flexible)
# But subclasses should work
class ConcreteMiddleware(Middleware):
async def __call__(self, context, call_next):
return await call_next(context)
# Should be instantiable
middleware = ConcreteMiddleware()
assert isinstance(middleware, Middleware)