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>
251 lines
7.8 KiB
Makefile
251 lines
7.8 KiB
Makefile
|
|
.PHONY: install
|
|
install: ## Install the uv environment and all packages with dependencies
|
|
@echo "🚀 Creating virtual environment and installing all packages using uv workspace"
|
|
@uv sync --dev --extra all
|
|
@uv run pre-commit install
|
|
@echo "✅ All packages and dependencies installed via uv workspace"
|
|
|
|
.PHONY: install-toolkits
|
|
install-toolkits: ## Install dependencies for all toolkits
|
|
@echo "🚀 Installing dependencies for all toolkits"
|
|
@failed=0; \
|
|
successful=0; \
|
|
for dir in toolkits/*/ ; do \
|
|
if [ -d "$$dir" ] && [ -f "$$dir/pyproject.toml" ]; then \
|
|
echo "📦 Installing dependencies for $$dir"; \
|
|
if (cd $$dir && uv pip install -e ".[dev]"); then \
|
|
successful=$$((successful + 1)); \
|
|
else \
|
|
echo "❌ Failed to install dependencies for $$dir"; \
|
|
failed=$$((failed + 1)); \
|
|
fi; \
|
|
else \
|
|
echo "⚠️ Skipping $$dir (no pyproject.toml found)"; \
|
|
fi; \
|
|
done; \
|
|
echo ""; \
|
|
echo "📊 Installation Summary:"; \
|
|
echo " ✅ Successful: $$successful toolkits"; \
|
|
echo " ❌ Failed: $$failed toolkits"; \
|
|
if [ $$failed -gt 0 ]; then \
|
|
echo ""; \
|
|
echo "⚠️ Some toolkit installations failed. Check the output above for details."; \
|
|
exit 1; \
|
|
else \
|
|
echo ""; \
|
|
echo "🎉 All toolkit dependencies installed successfully!"; \
|
|
fi
|
|
|
|
.PHONY: check
|
|
check: ## Run code quality tools.
|
|
@echo "🚀 Linting code: Running pre-commit"
|
|
@uv run pre-commit run -a
|
|
@echo "🚀 Static type checking: Running mypy on libs"
|
|
@for lib in libs/arcade*/ ; do \
|
|
echo "🔍 Type checking $$lib"; \
|
|
(cd $$lib && uv run mypy . --exclude tests || true); \
|
|
done
|
|
|
|
.PHONY: check-libs
|
|
check-libs: ## Run code quality tools for each lib package
|
|
@echo "🚀 Running checks on each lib package"
|
|
@for lib in libs/arcade*/ ; do \
|
|
echo "🛠️ Checking lib $$lib"; \
|
|
(cd $$lib && uv run pre-commit run -a || true); \
|
|
(cd $$lib && uv run mypy . || true); \
|
|
done
|
|
|
|
.PHONY: check-toolkits
|
|
check-toolkits: ## Run code quality tools for each toolkit that has a Makefile
|
|
@echo "🚀 Running 'make check' in each toolkit with a Makefile"
|
|
@for dir in toolkits/*/ ; do \
|
|
if [ -f "$$dir/Makefile" ]; then \
|
|
echo "🛠️ Checking toolkit $$dir"; \
|
|
(cd "$$dir" && uv run pre-commit run -a && uv run mypy --config-file=pyproject.toml); \
|
|
else \
|
|
echo "🛠️ Skipping toolkit $$dir (no Makefile found)"; \
|
|
fi; \
|
|
done
|
|
|
|
.PHONY: test
|
|
test: ## Test the code with pytest
|
|
@echo "🚀 Testing libs: Running pytest"
|
|
@uv run pytest -W ignore -v libs/tests --cov=libs --cov-config=pyproject.toml --cov-report=xml
|
|
|
|
.PHONY: test-libs
|
|
test-libs: ## Test each lib package individually
|
|
@echo "🚀 Testing each lib package"
|
|
@for lib in libs/arcade*/ ; do \
|
|
echo "🧪 Testing $$lib"; \
|
|
(cd $$lib && uv run pytest -W ignore -v || true); \
|
|
done
|
|
|
|
.PHONY: test-toolkits
|
|
test-toolkits: ## Iterate over all toolkits and run pytest on each one
|
|
@echo "🚀 Testing code in toolkits: Running pytest"
|
|
@for dir in toolkits/*/ ; do \
|
|
toolkit_name=$$(basename "$$dir"); \
|
|
echo "🧪 Testing $$toolkit_name toolkit"; \
|
|
(cd $$dir && uv run pytest -W ignore -v --cov=arcade_$$toolkit_name --cov-report=xml || exit 1); \
|
|
done
|
|
|
|
.PHONY: coverage
|
|
coverage: ## Generate coverage report
|
|
@echo "coverage report"
|
|
@uv run coverage report
|
|
@echo "Generating coverage report"
|
|
@uv run coverage html
|
|
|
|
.PHONY: build
|
|
build: clean-build ## Build wheel files using uv
|
|
@echo "🚀 Creating wheel files for all lib packages"
|
|
@for lib in libs/arcade*/ ; do \
|
|
if [ -f "$$lib/pyproject.toml" ]; then \
|
|
echo "🛠️ Building $$lib"; \
|
|
(cd $$lib && uv build); \
|
|
fi; \
|
|
done
|
|
|
|
.PHONY: build-toolkits
|
|
build-toolkits: ## Build wheel files for all toolkits
|
|
@echo "🚀 Creating wheel files for all toolkits"
|
|
@failed=0; \
|
|
successful=0; \
|
|
for dir in toolkits/*/ ; do \
|
|
if [ -d "$$dir" ] && [ -f "$$dir/pyproject.toml" ]; then \
|
|
toolkit_name=$$(basename "$$dir"); \
|
|
echo "🛠️ Building toolkit $$toolkit_name"; \
|
|
if (cd $$dir && uv build); then \
|
|
successful=$$((successful + 1)); \
|
|
else \
|
|
echo "❌ Failed to build toolkit $$toolkit_name"; \
|
|
failed=$$((failed + 1)); \
|
|
fi; \
|
|
else \
|
|
echo "⚠️ Skipping $$dir (no pyproject.toml found)"; \
|
|
fi; \
|
|
done; \
|
|
echo ""; \
|
|
echo "📊 Build Summary:"; \
|
|
echo " ✅ Successful: $$successful toolkits"; \
|
|
echo " ❌ Failed: $$failed toolkits"; \
|
|
if [ $$failed -gt 0 ]; then \
|
|
echo ""; \
|
|
echo "⚠️ Some toolkit builds failed. Check the output above for details."; \
|
|
exit 1; \
|
|
else \
|
|
echo ""; \
|
|
echo "🎉 All toolkit wheels built successfully!"; \
|
|
fi
|
|
|
|
.PHONY: clean-build
|
|
clean-build: ## clean build artifacts
|
|
@echo "🗑️ Cleaning build artifacts"
|
|
@for lib in libs/arcade*/ ; do \
|
|
(cd $$lib && rm -rf dist); \
|
|
done
|
|
|
|
.PHONY: publish
|
|
publish: ## publish a release to pypi.
|
|
@echo "🚀 Publishing all lib packages to PyPI"
|
|
@for lib in libs/arcade*/ ; do \
|
|
if [ -f "$$lib/pyproject.toml" ]; then \
|
|
echo "📦 Publishing $$lib"; \
|
|
(cd $$lib && uv publish --token $(PYPI_TOKEN) || true); \
|
|
fi; \
|
|
done
|
|
|
|
.PHONY: build-and-publish
|
|
build-and-publish: build publish ## Build and publish.
|
|
|
|
.PHONY: docker
|
|
docker: ## Build and run the Docker container
|
|
@echo "🚀 Building lib packages and toolkit wheels..."
|
|
@make full-dist
|
|
@echo "🚀 Building Docker image"
|
|
@cd docker && make docker-build
|
|
@cd docker && make docker-run
|
|
|
|
.PHONY: docker-base
|
|
docker-base: ## Build and run the Docker container
|
|
@echo "🚀 Building lib packages and toolkit wheels..."
|
|
@make full-dist
|
|
@echo "🚀 Building Docker image"
|
|
@cd docker && INSTALL_TOOLKITS=false make docker-build
|
|
@cd docker && INSTALL_TOOLKITS=false make docker-run
|
|
|
|
.PHONY: publish-ghcr
|
|
publish-ghcr: ## Publish to the GHCR
|
|
# Publish the base image - ghcr.io/arcadeai/worker-base
|
|
@cd docker && INSTALL_TOOLKITS=false make publish-ghcr
|
|
# Publish the image with toolkits - ghcr.io/arcadeai/worker
|
|
@cd docker && INSTALL_TOOLKITS=true make publish-ghcr
|
|
|
|
.PHONY: full-dist
|
|
full-dist: clean-dist ## Build all projects and copy wheels to ./dist
|
|
@echo "🛠️ Building a full distribution with lib packages and toolkits"
|
|
|
|
@echo "🛠️ Building all lib packages and copying wheels to ./dist"
|
|
@mkdir -p dist
|
|
|
|
@for lib in arcade-core arcade-tdk arcade-serve ; do \
|
|
echo "🛠️ Building libs/$$lib wheel..."; \
|
|
(cd libs/$$lib && uv build); \
|
|
done
|
|
|
|
@echo "🛠️ Building arcade-mcp package and copying wheel to ./dist"
|
|
@uv build
|
|
@rm -f dist/*.tar.gz
|
|
|
|
@echo "🛠️ Building all toolkit packages and copying wheels to ./dist"
|
|
@for dir in toolkits/*/ ; do \
|
|
if [ -d "$$dir" ] && [ -f "$$dir/pyproject.toml" ]; then \
|
|
toolkit_name=$$(basename "$$dir"); \
|
|
echo "🛠️ Building toolkit $$toolkit_name wheel..."; \
|
|
(cd $$dir && uv build); \
|
|
cp $$dir/dist/*.whl dist/; \
|
|
fi; \
|
|
done
|
|
|
|
.PHONY: clean-dist
|
|
clean-dist: ## Clean all built distributions
|
|
@echo "🗑️ Cleaning dist directory"
|
|
@rm -rf dist
|
|
@echo "🗑️ Cleaning libs/*/dist directories"
|
|
@for lib in libs/arcade*/ ; do \
|
|
rm -rf "$$lib"/dist; \
|
|
done
|
|
@echo "🗑️ Cleaning toolkits/*/dist directory"
|
|
@for toolkit_dir in toolkits/*; do \
|
|
if [ -d "$$toolkit_dir" ]; then \
|
|
rm -rf "$$toolkit_dir"/dist; \
|
|
fi; \
|
|
done
|
|
|
|
.PHONY: setup
|
|
setup: ## Run uv environment setup script
|
|
@chmod +x ./uv_setup.sh
|
|
@./uv_setup.sh
|
|
|
|
.PHONY: lint
|
|
lint: check ## Alias for check command
|
|
|
|
.PHONY: clean
|
|
clean: clean-build clean-dist ## Clean all build and distribution artifacts
|
|
|
|
.PHONY: help
|
|
help:
|
|
@echo "🛠️ Arcade Dev Commands:\n"
|
|
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
|
|
|
|
.DEFAULT_GOAL := help
|
|
|
|
.PHONY: shell
|
|
shell: ## Open an interactive shell with the virtual environment activated
|
|
@if [ -f ".venv/bin/activate" ]; then \
|
|
. .venv/bin/activate && exec $$SHELL -l; \
|
|
else \
|
|
echo "⚠️ Virtual environment not found. Run 'make setup' first."; \
|
|
exit 1; \
|
|
fi
|