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>
236 lines
8.4 KiB
Python
236 lines
8.4 KiB
Python
"""Connect command for configuring MCP clients."""
|
|
|
|
import json
|
|
import os
|
|
import platform
|
|
from pathlib import Path
|
|
|
|
import typer
|
|
from rich.console import Console
|
|
|
|
console = Console()
|
|
|
|
|
|
def get_claude_config_path() -> Path:
|
|
"""Get the Claude Desktop configuration file path."""
|
|
system = platform.system()
|
|
if system == "Darwin": # macOS
|
|
return (
|
|
Path.home()
|
|
/ "Library"
|
|
/ "Application Support"
|
|
/ "Claude"
|
|
/ "claude_desktop_config.json"
|
|
)
|
|
elif system == "Windows":
|
|
return Path(os.environ["APPDATA"]) / "Claude" / "claude_desktop_config.json"
|
|
else: # Linux
|
|
return Path.home() / ".config" / "Claude" / "claude_desktop_config.json"
|
|
|
|
|
|
def get_cursor_config_path() -> Path:
|
|
"""Get the Cursor configuration file path."""
|
|
system = platform.system()
|
|
if system == "Darwin": # macOS
|
|
return Path.home() / ".cursor" / "mcp.json"
|
|
elif system == "Windows":
|
|
return Path(os.environ["APPDATA"]) / "Cursor" / "mcp.json"
|
|
else: # Linux
|
|
return Path.home() / ".config" / "Cursor" / "mcp.json"
|
|
|
|
|
|
def get_vscode_config_path() -> Path:
|
|
"""Get the VS Code configuration file path."""
|
|
# Paths to global 'Default User' MCP configuration file
|
|
system = platform.system()
|
|
if system == "Darwin": # macOS
|
|
return Path.home() / "Library" / "Application Support" / "Code" / "User" / "mcp.json"
|
|
elif system == "Windows":
|
|
return Path(os.environ["APPDATA"]) / "Code" / "User" / "mcp.json"
|
|
else: # Linux
|
|
return Path.home() / ".config" / "Code" / "User" / "mcp.json"
|
|
|
|
|
|
def configure_claude_local(server_name: str, port: int = 8000, path: Path | None = None) -> None:
|
|
"""Configure Claude Desktop to add a local MCP server to the configuration."""
|
|
config_path = path or get_claude_config_path()
|
|
config_path.parent.mkdir(parents=True, exist_ok=True)
|
|
|
|
# Load existing config or create new one
|
|
config = {}
|
|
if config_path.exists():
|
|
with open(config_path) as f:
|
|
config = json.load(f)
|
|
|
|
# Add or update MCP servers configuration
|
|
if "mcpServers" not in config:
|
|
config["mcpServers"] = {}
|
|
|
|
config["mcpServers"][server_name] = {
|
|
"command": "python",
|
|
"args": ["-m", "arcade_mcp_server", "stream"],
|
|
"url": f"http://localhost:{port}/mcp",
|
|
}
|
|
|
|
# Write updated config
|
|
with open(config_path, "w") as f:
|
|
json.dump(config, f, indent=2)
|
|
|
|
console.print(
|
|
f"✅ Configured Claude Desktop by adding local MCP server '{server_name}' to the configuration",
|
|
style="green",
|
|
)
|
|
console.print(
|
|
f" MCP client config file: {config_path.as_posix().replace(' ', '\\ ')}", style="dim"
|
|
)
|
|
console.print(f" MCP Server URL: http://localhost:{port}/mcp", style="dim")
|
|
console.print(" Restart Claude Desktop for changes to take effect.", style="yellow")
|
|
|
|
|
|
def configure_claude_arcade(server_name: str, path: Path | None = None) -> None:
|
|
"""Configure Claude Desktop to add an Arcade Cloud MCP server to the configuration."""
|
|
# This would connect to the Arcade Cloud to get the server URL
|
|
# For now, this is a placeholder
|
|
console.print("[red]Connecting to Arcade Cloud servers not yet implemented[/red]")
|
|
|
|
|
|
def configure_cursor_local(server_name: str, port: int = 8000, path: Path | None = None) -> None:
|
|
"""Configure Cursor to add a local MCP server to the configuration."""
|
|
config_path = path or get_cursor_config_path()
|
|
config_path.parent.mkdir(parents=True, exist_ok=True)
|
|
|
|
# Load existing config or create new one
|
|
config = {}
|
|
if config_path.exists():
|
|
with open(config_path) as f:
|
|
config = json.load(f)
|
|
|
|
# Add or update MCP servers configuration
|
|
if "mcpServers" not in config:
|
|
config["mcpServers"] = {}
|
|
|
|
config["mcpServers"][server_name] = {
|
|
"name": server_name,
|
|
"type": "stream", # Cursor prefers stream
|
|
"url": f"http://localhost:{port}/mcp",
|
|
}
|
|
|
|
# Write updated config
|
|
with open(config_path, "w") as f:
|
|
json.dump(config, f, indent=2)
|
|
|
|
console.print(
|
|
f"✅ Configured Cursor by adding local MCP server '{server_name}' to the configuration",
|
|
style="green",
|
|
)
|
|
console.print(
|
|
f" MCP client config file: {config_path.as_posix().replace(' ', '\\ ')}", style="dim"
|
|
)
|
|
console.print(f" MCP Server URL: http://localhost:{port}/mcp", style="dim")
|
|
console.print(" Restart Cursor for changes to take effect.", style="yellow")
|
|
|
|
|
|
def configure_cursor_arcade(server_name: str, path: Path | None = None) -> None:
|
|
"""Configure Cursor to add an Arcade Cloud MCP server to the configuration."""
|
|
console.print("[red]Connecting to Arcade Cloud servers not yet implemented[/red]")
|
|
|
|
|
|
def configure_vscode_local(server_name: str, port: int = 8000, path: Path | None = None) -> None:
|
|
"""Configure VS Code to add a local MCP server to the configuration."""
|
|
config_path = path or get_vscode_config_path()
|
|
config_path.parent.mkdir(parents=True, exist_ok=True)
|
|
# Load existing config or create new one
|
|
config = {}
|
|
if config_path.exists():
|
|
with open(config_path) as f:
|
|
try:
|
|
config = json.load(f)
|
|
except json.JSONDecodeError as e:
|
|
raise ValueError(
|
|
f"\n\tFailed to load MCP configuration file at {config_path.as_posix()} "
|
|
f"\n\tThe file contains invalid JSON: {e}. "
|
|
"\n\tPlease check the file format or delete it to create a new configuration."
|
|
)
|
|
|
|
# Add or update MCP servers configuration
|
|
if "servers" not in config:
|
|
config["servers"] = {}
|
|
|
|
config["servers"][server_name] = {
|
|
"type": "http",
|
|
"url": f"http://localhost:{port}/mcp",
|
|
}
|
|
|
|
# Write updated config
|
|
with open(config_path, "w") as f:
|
|
json.dump(config, f, indent=2)
|
|
|
|
console.print(
|
|
f"✅ Configured VS Code by adding local MCP server '{server_name}' to the configuration",
|
|
style="green",
|
|
)
|
|
console.print(
|
|
f" MCP client config file: {config_path.as_posix().replace(' ', '\\ ')}", style="dim"
|
|
)
|
|
console.print(f" MCP Server URL: http://localhost:{port}/mcp", style="dim")
|
|
console.print(" Restart VS Code for changes to take effect.", style="yellow")
|
|
|
|
|
|
def configure_vscode_arcade(server_name: str, path: Path | None = None) -> None:
|
|
"""Configure VS Code to add an Arcade Cloud MCP server to the configuration."""
|
|
console.print("[red]Connecting to Arcade Cloud servers not yet implemented[/red]")
|
|
|
|
|
|
def configure_client(
|
|
client: str,
|
|
server_name: str | None = None,
|
|
from_local: bool = False,
|
|
from_arcade: bool = False,
|
|
port: int = 8000,
|
|
path: Path | None = None,
|
|
) -> None:
|
|
"""
|
|
Configure an MCP client to connect to a server.
|
|
|
|
Args:
|
|
client: The MCP client to configure (claude, cursor, vscode)
|
|
server_name: Name of the server to add to the configuration
|
|
from_local: Add a local server to the configuration
|
|
from_arcade: Add an Arcade Cloud server to the configuration
|
|
port: Port for local servers (default: 8000)
|
|
path: Custom path to the MCP client configuration file
|
|
"""
|
|
if not from_local and not from_arcade:
|
|
console.print("[red]Must specify either --from-local or --from-arcade[/red]")
|
|
raise typer.Exit(1)
|
|
|
|
if from_local and from_arcade:
|
|
console.print("[red]Cannot specify both --from-local and --from-arcade[/red]")
|
|
raise typer.Exit(1)
|
|
|
|
# Default server name if not provided
|
|
if not server_name:
|
|
# Try to detect from current directory
|
|
server_name = Path.cwd().name if Path("server.py").exists() else "arcade-mcp-server"
|
|
|
|
client_lower = client.lower()
|
|
|
|
if client_lower == "claude":
|
|
if from_local:
|
|
configure_claude_local(server_name, port, path)
|
|
else:
|
|
configure_claude_arcade(server_name, path)
|
|
elif client_lower == "cursor":
|
|
if from_local:
|
|
configure_cursor_local(server_name, port, path)
|
|
else:
|
|
configure_cursor_arcade(server_name, path)
|
|
elif client_lower == "vscode":
|
|
if from_local:
|
|
configure_vscode_local(server_name, port, path)
|
|
else:
|
|
configure_vscode_arcade(server_name, path)
|
|
else:
|
|
console.print(f"[red]Unknown client: {client}[/red]")
|
|
console.print("Supported clients: claude, cursor, vscode")
|
|
raise typer.Exit(1)
|