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>
161 lines
5 KiB
Python
161 lines
5 KiB
Python
"""Lifespan management for MCP server.
|
|
|
|
Provides a clean interface for managing server lifecycle with proper
|
|
resource initialization and cleanup.
|
|
"""
|
|
|
|
import asyncio
|
|
import logging
|
|
from collections.abc import AsyncIterator
|
|
from contextlib import AbstractAsyncContextManager, asynccontextmanager
|
|
from typing import Any, Callable
|
|
|
|
from arcade_mcp_server.exceptions import LifespanError
|
|
|
|
logger = logging.getLogger("arcade.mcp")
|
|
|
|
LifespanResult = dict[str, Any]
|
|
|
|
|
|
@asynccontextmanager
|
|
async def default_lifespan(server: Any) -> AsyncIterator[LifespanResult]:
|
|
"""Default lifespan that does basic startup/shutdown logging."""
|
|
logger.info(f"Starting MCP server: {getattr(server, 'name', 'unknown')}")
|
|
|
|
# Startup
|
|
try:
|
|
yield {}
|
|
finally:
|
|
# Shutdown
|
|
logger.info(f"Stopping MCP server: {getattr(server, 'name', 'unknown')}")
|
|
|
|
|
|
class LifespanManager:
|
|
"""Manages server lifecycle with proper resource management.
|
|
|
|
This class wraps a lifespan context manager and provides a clean
|
|
interface for server startup and shutdown operations.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
server: Any,
|
|
lifespan: Callable[[Any], AbstractAsyncContextManager[LifespanResult]] | None = None,
|
|
):
|
|
"""Initialize lifespan manager.
|
|
|
|
Args:
|
|
server: The server instance
|
|
lifespan: Optional custom lifespan function
|
|
"""
|
|
self.server = server
|
|
self.lifespan = lifespan or default_lifespan
|
|
self._stack: Any | None = None
|
|
self._context: LifespanResult | None = None
|
|
self._started = False
|
|
|
|
async def startup(self) -> LifespanResult:
|
|
"""Run startup phase of lifespan."""
|
|
if self._started:
|
|
raise LifespanError("Lifespan already started")
|
|
|
|
self._started = True
|
|
|
|
self._stack = asyncio.create_task(self._run_lifespan())
|
|
|
|
# Wait for startup to complete
|
|
while self._context is None and not self._stack.done():
|
|
await asyncio.sleep(0.01)
|
|
|
|
if self._stack.done() and self._context is None:
|
|
# Lifespan failed during startup
|
|
try:
|
|
await self._stack
|
|
except Exception as e:
|
|
raise LifespanError(f"Lifespan startup failed: {e}") from e
|
|
|
|
if self._context is None:
|
|
raise LifespanError("Lifespan startup failed")
|
|
return self._context
|
|
|
|
async def shutdown(self) -> None:
|
|
"""Run shutdown phase of lifespan."""
|
|
if not self._started:
|
|
return
|
|
|
|
self._started = False
|
|
|
|
if self._stack and not self._stack.done():
|
|
# Trigger shutdown by cancelling the lifespan task
|
|
self._stack.cancel()
|
|
try:
|
|
await self._stack
|
|
except asyncio.CancelledError:
|
|
pass
|
|
except Exception:
|
|
logger.exception("Error during lifespan shutdown")
|
|
|
|
self._context = None
|
|
self._stack = None
|
|
|
|
async def _run_lifespan(self) -> None:
|
|
"""Run the lifespan context manager."""
|
|
try:
|
|
async with self.lifespan(self.server) as context:
|
|
self._context = context
|
|
# Keep running until cancelled
|
|
while True:
|
|
await asyncio.sleep(1)
|
|
except asyncio.CancelledError:
|
|
# Normal shutdown
|
|
self._context = None
|
|
raise
|
|
except Exception:
|
|
# Abnormal shutdown
|
|
self._context = None
|
|
logger.exception("Error in lifespan")
|
|
raise
|
|
|
|
async def __aenter__(self) -> LifespanResult:
|
|
"""Async context manager entry."""
|
|
return await self.startup()
|
|
|
|
async def __aexit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
|
|
"""Async context manager exit."""
|
|
await self.shutdown()
|
|
|
|
|
|
def compose_lifespans(
|
|
*lifespans: Callable[[Any], AbstractAsyncContextManager[LifespanResult]],
|
|
) -> Callable[[Any], AbstractAsyncContextManager[LifespanResult]]:
|
|
"""Compose multiple lifespan functions into one.
|
|
|
|
Each lifespan's context is merged into a single dict.
|
|
Lifespans are started in order and stopped in reverse order.
|
|
"""
|
|
|
|
@asynccontextmanager
|
|
async def composed(server: Any) -> AsyncIterator[LifespanResult]:
|
|
contexts: list[tuple[AbstractAsyncContextManager[LifespanResult], LifespanResult]] = []
|
|
merged: LifespanResult = {}
|
|
|
|
# Start lifespans in order (sequential for compatibility)
|
|
for lifespan in lifespans:
|
|
ctx_mgr = lifespan(server)
|
|
context = await ctx_mgr.__aenter__()
|
|
contexts.append((ctx_mgr, context))
|
|
|
|
# Merge context if it's a dict
|
|
merged.update(context)
|
|
|
|
try:
|
|
yield merged
|
|
finally:
|
|
# Stop lifespans in reverse order
|
|
for ctx_mgr, _ in reversed(contexts):
|
|
try:
|
|
await ctx_mgr.__aexit__(None, None, None)
|
|
except Exception:
|
|
logger.exception("Error stopping lifespan")
|
|
|
|
return composed
|