admin-valentin/arcade-mcp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
arcade-mcp/libs/arcade-mcp-server/docs/examples
History
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
..
00_hello_world.md MCP Local (#563) 2025-09-25 15:28:15 -07:00
00_hello_world.py MCP Local (#563) 2025-09-25 15:28:15 -07:00
01_tools.md MCP Local (#563) 2025-09-25 15:28:15 -07:00
01_tools.py MCP Local (#563) 2025-09-25 15:28:15 -07:00
02_building_apps.md MCP Local (#563) 2025-09-25 15:28:15 -07:00
02_building_apps.py MCP Local (#563) 2025-09-25 15:28:15 -07:00
03_context.md MCP Local (#563) 2025-09-25 15:28:15 -07:00
03_context.py MCP Local (#563) 2025-09-25 15:28:15 -07:00
04_secrets.md MCP Local (#563) 2025-09-25 15:28:15 -07:00
04_secrets.py MCP Local (#563) 2025-09-25 15:28:15 -07:00
05_logging.md MCP Local (#563) 2025-09-25 15:28:15 -07:00
05_logging.py MCP Local (#563) 2025-09-25 15:28:15 -07:00
README.md MCP Local (#563) 2025-09-25 15:28:15 -07:00

README.md

Arcade MCP Examples

This directory contains examples demonstrating how to build MCP servers with your Arcade tools.

Examples Overview

Basic Examples

  1. 00_hello_world.py – Minimal tool example

    • Single @tool function showing the basics
    • Run: python -m arcade_mcp_server (or python -m arcade_mcp_server stdio)

  2. 01_tools.py – Creating tools and discovery

    • Simple parameters, lists, and TypedDict
    • How arcade_mcp_server discovers tools automatically
    • Run: python -m arcade_mcp_server

  3. 02_building_apps.py – Building apps with MCPApp

    • Create an MCPApp, register tools with @app.tool
    • Run HTTP: python 02_building_apps.py
    • Run stdio: python 02_building_apps.py stdio

  4. 03_context.py – Using Context

    • Access secrets, logging, and user context
    • Run: python -m arcade_mcp_server

  5. 04_tool_secrets.py – Working with secrets

    • Use requires_secrets and access masked values
    • Run: python -m arcade_mcp_server

  6. 05_logging.py – Logging with MCP

    • Demonstrates debug/info/warning/error levels and structured logs
    • Run: python 05_logging.py

Running Examples

Most examples can be run directly with the arcade_mcp_server CLI:

# Auto-discover tools in current directory
python -m arcade_mcp_server

# With specific transport
python -m arcade_mcp_server stdio  # For Claude Desktop
python -m arcade_mcp_server        # HTTP by default

# With debugging
python -m arcade_mcp_server --debug

# With hot reload (HTTP only)
python -m arcade_mcp_server --reload

For MCPApp examples, run the script directly to start an HTTP server.