arcade-mcp/libs/arcade-mcp-server/arcade_mcp_server/middleware/error_handling.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

107 lines
3.9 KiB
Python

"""Error handling middleware for MCP server."""
import logging
from typing import Any
from arcade_mcp_server.convert import convert_content_to_structured_content, convert_to_mcp_content
from arcade_mcp_server.middleware.base import CallNext, Middleware, MiddlewareContext
from arcade_mcp_server.types import CallToolResult, JSONRPCError
logger = logging.getLogger("arcade.mcp")
class ErrorHandlingMiddleware(Middleware):
"""Middleware that handles errors and converts them to appropriate responses."""
def __init__(self, mask_error_details: bool = True):
"""Initialize error handling middleware.
Args:
mask_error_details: Whether to mask error details in responses
"""
self.mask_error_details = mask_error_details
async def on_message(
self,
context: MiddlewareContext[Any],
call_next: CallNext[Any, Any],
) -> Any:
"""Wrap all messages with error handling."""
try:
return await call_next(context)
except Exception as e:
return self._handle_error(context, e)
async def on_call_tool(
self,
context: MiddlewareContext[Any],
call_next: CallNext[Any, Any],
) -> Any:
"""Handle tool call errors specially."""
try:
return await call_next(context)
except Exception as e:
# For tool calls, return error as CallToolResult
error_message = self._get_error_message(e)
logger.exception(f"Error calling tool: {error_message}")
content = convert_to_mcp_content(error_message)
structured_content = convert_content_to_structured_content({"error": error_message})
return CallToolResult(
content=content,
structuredContent=structured_content,
isError=True,
)
def _handle_error(self, context: MiddlewareContext[Any], error: Exception) -> Any:
"""Convert exception to appropriate error response."""
error_message = self._get_error_message(error)
# Log the full error
logger.exception(f"Error processing {context.method}: {error}")
# Get request ID if available
request_id = context.request_id
if not request_id and hasattr(context.message, "id"):
request_id = str(getattr(context.message, "id", "unknown"))
# Return JSON-RPC error
return JSONRPCError(
id=request_id or "unknown",
error={
"code": self._get_error_code(error),
"message": error_message,
},
)
def _get_error_message(self, error: Exception) -> str:
"""Get appropriate error message based on configuration."""
if self.mask_error_details:
# Return generic message for security
error_type = type(error).__name__
if error_type in ["ValueError", "TypeError", "KeyError"]:
return "Invalid request parameters"
elif error_type in ["NotFoundError", "FileNotFoundError"]:
return "Resource not found"
elif error_type in ["PermissionError", "AuthorizationError"]:
return "Permission denied"
else:
return "Internal server error"
else:
# Return actual error message for debugging
return str(error)
def _get_error_code(self, error: Exception) -> int:
"""Get JSON-RPC error code for exception."""
error_type = type(error).__name__
# Map common errors to JSON-RPC codes
if error_type in ["ValueError", "TypeError", "KeyError"]:
return -32602 # Invalid params
elif error_type in ["NotFoundError", "FileNotFoundError"]:
return -32601 # Method not found
elif error_type in ["PermissionError", "AuthorizationError"]:
return -32603 # Internal error (used for auth)
else:
return -32603 # Generic internal error