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>
144 lines
4.8 KiB
Python
144 lines
4.8 KiB
Python
import json
|
|
from typing import Any, Callable
|
|
|
|
from fastapi import Depends, FastAPI, Request
|
|
from fastapi.security import HTTPAuthorizationCredentials, HTTPBearer
|
|
from opentelemetry.metrics import Meter
|
|
from starlette.routing import Mount
|
|
|
|
from arcade_serve.core.base import (
|
|
BaseWorker,
|
|
Router,
|
|
)
|
|
from arcade_serve.core.common import RequestData, ResponseData, WorkerComponent
|
|
from arcade_serve.fastapi.auth import validate_engine_request
|
|
from arcade_serve.utils import is_async_callable
|
|
|
|
|
|
class FastAPIWorker(BaseWorker):
|
|
"""
|
|
An Arcade Worker that is hosted inside a FastAPI app.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
app: FastAPI,
|
|
secret: str | None = None,
|
|
*,
|
|
disable_auth: bool = False,
|
|
otel_meter: Meter | None = None,
|
|
components: list[type[WorkerComponent]] | None = None,
|
|
) -> None:
|
|
"""
|
|
Initialize the FastAPIWorker with a FastAPI app instance.
|
|
If no secret is provided, the worker will use the ARCADE_WORKER_SECRET environment variable.
|
|
Args:
|
|
app: The FastAPI app to host the worker in
|
|
secret: Optional secret for authorization
|
|
disable_auth: Whether to disable authorization
|
|
otel_meter: Optional OpenTelemetry meter
|
|
components: Optional list of components to register
|
|
"""
|
|
super().__init__(secret, disable_auth, otel_meter)
|
|
self.app = app
|
|
self.router = FastAPIRouter(app, self)
|
|
|
|
# Initialize components list
|
|
self.components: list[WorkerComponent] = []
|
|
|
|
# If no components specified, register the default routes from BaseWorker
|
|
if components is None:
|
|
self.register_routes(self.router)
|
|
else:
|
|
# Register the provided components
|
|
for component_cls in components:
|
|
self.register_component(component_cls)
|
|
|
|
def register_component(self, component_cls: type[WorkerComponent], **kwargs: Any) -> None:
|
|
"""
|
|
Register a component with the worker.
|
|
|
|
Args:
|
|
component_cls: The component class to register
|
|
**kwargs: Additional keyword arguments to pass to the component constructor
|
|
"""
|
|
component = component_cls(self, **kwargs)
|
|
component.register(self.router)
|
|
self.components.append(component)
|
|
|
|
|
|
security = HTTPBearer() # Authorization: Bearer <xxx>
|
|
|
|
|
|
class FastAPIRouter(Router):
|
|
def __init__(self, app: FastAPI, worker: BaseWorker) -> None:
|
|
self.app = app
|
|
self.worker = worker
|
|
|
|
def _wrap_handler(self, handler: Callable, require_auth: bool = True) -> Callable:
|
|
"""
|
|
Wrap the handler to handle FastAPI-specific request and response.
|
|
"""
|
|
|
|
use_auth_for_route = not self.worker.disable_auth and require_auth
|
|
|
|
def call_validate_engine_request(worker_secret: str) -> Callable:
|
|
async def dependency(
|
|
credentials: HTTPAuthorizationCredentials = Depends(security),
|
|
) -> None:
|
|
await validate_engine_request(worker_secret, credentials)
|
|
|
|
return dependency
|
|
|
|
async def wrapped_handler(
|
|
request: Request,
|
|
_: None = Depends(call_validate_engine_request(self.worker.secret))
|
|
if use_auth_for_route
|
|
else None,
|
|
) -> Any:
|
|
body_str = await request.body()
|
|
body_json = json.loads(body_str) if body_str else {}
|
|
request_data = RequestData(
|
|
path=request.url.path,
|
|
method=request.method,
|
|
body_json=body_json,
|
|
)
|
|
if is_async_callable(handler):
|
|
return await handler(request_data)
|
|
else:
|
|
return handler(request_data)
|
|
|
|
return wrapped_handler
|
|
|
|
def add_route(
|
|
self,
|
|
endpoint_path: str,
|
|
handler: Callable,
|
|
method: str,
|
|
require_auth: bool = True,
|
|
response_type: type[ResponseData] | None = None,
|
|
**kwargs: Any,
|
|
) -> None:
|
|
"""
|
|
Add a route to the FastAPI application.
|
|
"""
|
|
self.app.add_api_route(
|
|
f"{self.worker.base_path}/{endpoint_path}",
|
|
self._wrap_handler(handler, require_auth),
|
|
methods=[method],
|
|
response_model=response_type,
|
|
# **kwargs to pass to FastAPI
|
|
**kwargs,
|
|
)
|
|
|
|
def add_mount(self, path: str, app: Any, name: str | None = None) -> None:
|
|
"""Mount an ASGI application at the specified path.
|
|
|
|
Args:
|
|
path: The URL path to mount the app at
|
|
app: The ASGI application to mount
|
|
name: Optional name for the mount
|
|
"""
|
|
# Add mount to the FastAPI app's router
|
|
mount = Mount(path, app=app, name=name)
|
|
self.app.router.routes.append(mount)
|