arcade-mcp/libs/arcade-mcp-server/arcade_mcp_server/managers/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

146 lines
4.6 KiB
Python

"""
Base Async Managers
Provides async-safe registries with RW locking, versioning, and subscriptions.
"""
from __future__ import annotations
import asyncio
from collections.abc import Callable, Iterable
from types import TracebackType
from typing import Any, Generic, TypeVar, cast
K = TypeVar("K")
V = TypeVar("V")
class AsyncRWLock:
"""Simple async RW lock allowing concurrent readers and exclusive writers."""
def __init__(self) -> None:
self._reader_count = 0
self._reader_lock = asyncio.Lock()
self._gate = asyncio.Lock()
async def read(self) -> Any:
class _ReadCtx:
async def __aenter__(_self) -> None:
async with self._reader_lock:
self._reader_count += 1
if self._reader_count == 1:
await self._gate.acquire()
async def __aexit__(
_self,
exc_type: type[BaseException] | None,
exc: BaseException | None,
tb: TracebackType | None,
) -> None:
async with self._reader_lock:
self._reader_count -= 1
if self._reader_count == 0:
self._gate.release()
return _ReadCtx()
async def write(self) -> Any:
class _WriteCtx:
async def __aenter__(_self) -> None:
await self._gate.acquire()
async def __aexit__(
_self,
exc_type: type[BaseException] | None,
exc: BaseException | None,
tb: TracebackType | None,
) -> None:
self._gate.release()
return _WriteCtx()
class AsyncRegistry(Generic[K, V]):
"""Async-safe registry with deterministic listing and change notifications."""
def __init__(self, component: str) -> None:
self.component = component
self._items: dict[K, V] = {}
self._lock = AsyncRWLock()
self._version = 0
self._subscribers: list[Callable[[str, K | None, V | None, V | None, int], None]] = []
def subscribe(self, fn: Callable[[str, K | None, V | None, V | None, int], None]) -> None:
self._subscribers.append(fn)
async def get(self, key: K) -> V:
async with await self._lock.read():
if key not in self._items:
raise KeyError(f"{self.component.title()} '{key}' not found")
return self._items[key]
async def keys(self) -> list[K]:
async with await self._lock.read():
return sorted(self._items.keys(), key=lambda k: str(k))
async def list(self) -> list[V]:
async with await self._lock.read():
return [self._items[k] for k in sorted(self._items.keys(), key=lambda k: str(k))]
async def upsert(self, key: K, value: V) -> None:
async with await self._lock.write():
old = self._items.get(key)
self._items[key] = value
self._version += 1
version = self._version
for fn in self._subscribers:
fn("upsert", key, old, value, version)
async def remove(self, key: K) -> V:
async with await self._lock.write():
if key not in self._items:
raise KeyError(f"{self.component.title()} '{key}' not found")
old = self._items.pop(key)
self._version += 1
version = self._version
for fn in self._subscribers:
fn("remove", key, old, None, version)
return old
async def bulk_load(self, items: Iterable[tuple[K, V]]) -> None:
async with await self._lock.write():
for k, v in items:
self._items[k] = v
self._version += 1
version = self._version
for fn in self._subscribers:
fn("bulk_load", cast(K, None), None, None, version)
@property
def version(self) -> int:
return self._version
class ComponentManager(Generic[K, V]):
"""Base component manager with lifecycle and async registry."""
def __init__(self, component: str) -> None:
self.registry: AsyncRegistry[K, V] = AsyncRegistry(component)
self._started = False
async def start(self) -> None:
if self._started:
return
self._started = True
async def stop(self) -> None:
if not self._started:
return
self._started = False
def subscribe(self, fn: Callable[[str, K | None, V | None, V | None, int], None]) -> None:
self.registry.subscribe(fn)
@property
def version(self) -> int:
return self.registry.version