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>
231 lines
7.4 KiB
Python
231 lines
7.4 KiB
Python
# Ignore hardcoded secret linting
|
|
# ruff: noqa: S105
|
|
# ruff: noqa: S106
|
|
import json
|
|
import os
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
from arcade_cli.deployment import (
|
|
Config,
|
|
Deployment,
|
|
LocalPackages,
|
|
Package,
|
|
PackageRepository,
|
|
Pypi,
|
|
Secret,
|
|
Worker,
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def test_dir():
|
|
return Path(__file__).parent
|
|
|
|
|
|
def test_invalid_toml_path(test_dir):
|
|
with pytest.raises(FileNotFoundError):
|
|
Deployment.from_toml(test_dir / "test_files" / "invalid.toml")
|
|
|
|
|
|
def test_missing_fields(test_dir):
|
|
with pytest.raises(ValueError):
|
|
Deployment.from_toml(test_dir / "test_files" / "invalid.fields.worker.toml")
|
|
|
|
|
|
def test_deployment_parsing(test_dir):
|
|
config_path = test_dir / "test_files" / "full.worker.toml"
|
|
deployment = Deployment.from_toml(config_path)
|
|
|
|
# Test config section
|
|
assert deployment.worker[0].config.id == "test"
|
|
assert deployment.worker[0].config.enabled is True
|
|
assert deployment.worker[0].config.timeout == 10
|
|
assert deployment.worker[0].config.retries == 3
|
|
assert deployment.worker[0].config.secret == Secret(value="test-secret", pattern=None)
|
|
|
|
# Test pypi section
|
|
assert deployment.worker[0].pypi_source.packages == [Package(name="arcade-x")]
|
|
|
|
# Test local_packages section
|
|
assert deployment.worker[0].local_source.packages == ["./mock_toolkit"]
|
|
|
|
# Test custom_repositories section
|
|
repo = deployment.worker[0].custom_source[0]
|
|
assert repo.index == "pypi"
|
|
assert repo.index_url == "https://pypi.org/simple"
|
|
assert repo.trusted_host == "pypi.org"
|
|
assert repo.packages == [Package(name="arcade-mcp", specifier=">=1.0.0")]
|
|
|
|
repo = deployment.worker[0].custom_source[1]
|
|
assert repo.index == "pypi2"
|
|
assert repo.index_url == "https://pypi2.org/simple"
|
|
assert repo.trusted_host == "pypi2.org"
|
|
assert repo.packages == [Package(name="arcade-slack")]
|
|
|
|
|
|
def test_specifier():
|
|
from packaging.requirements import Requirement
|
|
|
|
req = Requirement("arcade-mcp>=1.0.0")
|
|
assert req.name == "arcade-mcp"
|
|
assert req.specifier == ">=1.0.0"
|
|
|
|
|
|
@pytest.mark.skip(reason="This test is flaky and needs to be fixed")
|
|
def test_deployment_dict(test_dir):
|
|
config_path = test_dir / "test_files" / "full.worker.toml"
|
|
deployment = Deployment.from_toml(config_path)
|
|
expected = json.loads("""{
|
|
"name": "test",
|
|
"secret": "test-secret",
|
|
"enabled": true,
|
|
"timeout": 10,
|
|
"retries": 3,
|
|
"wait": false,
|
|
"pypi": {
|
|
"packages": [
|
|
{
|
|
"name": "arcade-x",
|
|
"specifier": null
|
|
}
|
|
],
|
|
"index": "pypi",
|
|
"index_url": "https://pypi.org/simple",
|
|
"trusted_host": "pypi.org"
|
|
},
|
|
"custom_repositories": [
|
|
{
|
|
"packages": [
|
|
{
|
|
"name": "arcade-mcp",
|
|
"specifier": ">=1.0.0"
|
|
}
|
|
],
|
|
"index": "pypi",
|
|
"index_url": "https://pypi.org/simple",
|
|
"trusted_host": "pypi.org"
|
|
},
|
|
{
|
|
"packages": [
|
|
{
|
|
"name": "arcade-slack",
|
|
"specifier": null
|
|
}
|
|
],
|
|
"index": "pypi2",
|
|
"index_url": "https://pypi2.org/simple",
|
|
"trusted_host": "pypi2.org"
|
|
}
|
|
],
|
|
"local_packages": [
|
|
{
|
|
"name": "mock_toolkit",
|
|
"content": "H4sIAOgdymcC/+2XwWuDMBTGPftXZDltMNIkJtrCOrpbL4PdSxmiKXNVIzHt6n+/OAvtNrqbMur7Xd7j5YGH5Ps+JBMyWbzEh6WKU2W8XqAdlyqlgTj17ZxRzriHDt4A7GobG/d5b5zwKSpsVqg5iwRjs6kMBJEzMYtC7nvA1VPoZPtqtc63mZ14/ek/krKrYVcp/655JtyLY4wHNHL6D5iMPCSH1H+dGtX84YBubbO5vvsn4P/g/+f+LyihPBSUSfD/sfl/EWclqZo+9B8Kcdn/eXTyf+bmTAjp9E+H1P9I/b8yWWlv8VLlub5HH9rk6Q2+A+mPhf+R/8Hv/GeQ/4Pkf/Qj/3lEpAgCOQUPGF3+V01l9LtKLLG6yAfLf07F2f9fq/+QhhTyfwhW7d2TSitrmrVfxoVCc4TPXwX298rUmS7bA0oYodhPVZ2YrLLH6bNbR8d1tNEGPZnExQn2451906Z2OyvczdBDqvaL+Ksnrn3EazAaAAAAAAAAAAAAAAAAAOiJT7MTVu0AKAAA"
|
|
}
|
|
]
|
|
}""")
|
|
got = deployment.worker[0].request().model_dump(mode="json")
|
|
# Remove encoding part that contains the content
|
|
got["local_packages"][0].pop("content")
|
|
expected["local_packages"][0].pop("content")
|
|
|
|
assert got == expected
|
|
|
|
|
|
def test_missing_local_package(test_dir):
|
|
config_path = test_dir / "test_files" / "invalid.localfile.worker.toml"
|
|
deployment = Deployment.from_toml(config_path)
|
|
with pytest.raises(FileNotFoundError):
|
|
deployment.worker[0].request()
|
|
|
|
|
|
def test_invalid_local_package(test_dir):
|
|
config_path = test_dir / "test_files" / "invalid.localfile.worker.toml"
|
|
deployment = Deployment.from_toml(config_path)
|
|
with pytest.raises(FileNotFoundError):
|
|
deployment.worker[1].request()
|
|
|
|
|
|
def test_unconfigured_local_package(test_dir):
|
|
config_path = test_dir / "test_files" / "invalid.localfile.worker.toml"
|
|
deployment = Deployment.from_toml(config_path)
|
|
with pytest.raises(ValueError):
|
|
deployment.worker[2].request()
|
|
|
|
|
|
def test_duplicate_pypi_packages():
|
|
worker = Worker(
|
|
toml_path=Path(__file__),
|
|
config=Config(id="test", secret=Secret(value="test-secret", pattern=None)),
|
|
pypi_source=Pypi(packages=["arcade-slack", "arcade-slack"]),
|
|
)
|
|
with pytest.raises(ValueError):
|
|
worker.validate_packages()
|
|
|
|
|
|
def test_duplicate_custom_repository_packages():
|
|
worker = Worker(
|
|
toml_path=Path(__file__),
|
|
config=Config(id="test", secret=Secret(value="test-secret", pattern=None)),
|
|
custom_source=[
|
|
PackageRepository(
|
|
index="pypi",
|
|
index_url="https://pypi.org/simple",
|
|
trusted_host="pypi.org",
|
|
packages=["arcade-slack", "arcade-slack"],
|
|
)
|
|
],
|
|
)
|
|
with pytest.raises(ValueError):
|
|
worker.validate_packages()
|
|
|
|
|
|
def test_duplicate_local_packages():
|
|
worker = Worker(
|
|
toml_path=Path(__file__),
|
|
config=Config(id="test", secret=Secret(value="test-secret", pattern=None)),
|
|
local_source=LocalPackages(packages=["./mock_toolkit", "./mock_toolkit"]),
|
|
)
|
|
with pytest.raises(ValueError):
|
|
worker.validate_packages()
|
|
|
|
|
|
def test_duplicate_all_typed_packages():
|
|
worker = Worker(
|
|
toml_path=Path(__file__),
|
|
config=Config(id="test", secret=Secret(value="test-secret", pattern=None)),
|
|
pypi_source=Pypi(packages=["arcade-slack"]),
|
|
custom_source=[
|
|
PackageRepository(
|
|
index="pypi",
|
|
index_url="https://pypi.org/simple",
|
|
trusted_host="pypi.org",
|
|
packages=["arcade-slack", "arcade-x"],
|
|
)
|
|
],
|
|
local_source=LocalPackages(packages=["./arcade-x"]),
|
|
)
|
|
with pytest.raises(ValueError):
|
|
worker.validate_packages()
|
|
|
|
|
|
def test_duplicate_worker_names():
|
|
worker = Worker(
|
|
toml_path=Path(__file__),
|
|
config=Config(id="test", secret=Secret(value="test-secret", pattern=None)),
|
|
)
|
|
worker2 = Worker(
|
|
toml_path=Path(__file__),
|
|
config=Config(id="test", secret=Secret(value="test-secret", pattern=None)),
|
|
)
|
|
with pytest.raises(ValueError):
|
|
Deployment(workers=[worker, worker2])
|
|
|
|
|
|
def test_secret_parsing(test_dir):
|
|
os.environ["TEST_WORKER_SECRET"] = "test-secret"
|
|
deployment = Deployment.from_toml(test_dir / "test_files" / "env.secret.worker.toml")
|
|
assert deployment.worker[0].config.secret == Secret(
|
|
value="test-secret", pattern="TEST_WORKER_SECRET"
|
|
)
|