arcade-mcp/libs/tests/arcade_mcp_server/test_openapi_docs.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

80 lines
2.8 KiB
Python

"""Test that MCP routes appear in OpenAPI documentation."""
import pytest
from arcade_core import ToolCatalog
from arcade_core.toolkit import Toolkit
from arcade_mcp_server.settings import MCPSettings
from arcade_mcp_server.worker import create_arcade_mcp
from fastapi.testclient import TestClient
def test_mcp_routes_in_openapi(monkeypatch):
"""Test that MCP routes appear in FastAPI OpenAPI documentation."""
# Set environment variables for settings
monkeypatch.setenv("ARCADE_AUTH_DISABLED", "true")
monkeypatch.setenv("ARCADE_WORKER_SECRET", "test")
monkeypatch.setenv("MCP_SERVER_NAME", "test-mcp")
monkeypatch.setenv("MCP_SERVER_VERSION", "0.1.0")
# Create a simple catalog
catalog = ToolCatalog()
toolkit = Toolkit(name="test", package_name="test", version="0.1.0", description="Test toolkit")
catalog.add_toolkit(toolkit)
# Create MCP settings from environment
mcp_settings = MCPSettings.from_env()
# Create the app
app = create_arcade_mcp(catalog, mcp_settings=mcp_settings)
# Create test client
client = TestClient(app)
# Get OpenAPI schema
response = client.get("/openapi.json")
assert response.status_code == 200
openapi_schema = response.json()
# Check that MCP paths are documented
assert "/mcp/" in openapi_schema["paths"]
mcp_path = openapi_schema["paths"]["/mcp/"]
# Check POST endpoint
assert "post" in mcp_path
assert mcp_path["post"]["summary"] == "Send MCP message"
assert "MCPRequest" in str(mcp_path["post"])
assert "MCPResponse" in str(mcp_path["post"])
# Check GET endpoint
assert "get" in mcp_path
assert mcp_path["get"]["summary"] == "Establish SSE stream"
# Check DELETE endpoint
assert "delete" in mcp_path
assert mcp_path["delete"]["summary"] == "Terminate session"
# Check that component schemas are defined
components = openapi_schema.get("components", {}).get("schemas", {})
assert "MCPRequest" in components
assert "MCPResponse" in components
# Verify MCPRequest schema
mcp_request = components["MCPRequest"]
assert "jsonrpc" in mcp_request["properties"]
assert "method" in mcp_request["properties"]
assert "params" in mcp_request["properties"]
assert "id" in mcp_request["properties"]
# Verify that the paths include the MCP tag
assert "tags" in mcp_path["post"]
assert "MCP Protocol" in mcp_path["post"]["tags"]
# Verify the actual proxy is mounted (not routes)
# The OpenAPI docs should exist but not interfere with the mount
import inspect
mounts = [route for route in app.routes if hasattr(route, "app") and hasattr(route, "path")]
mcp_mounts = [m for m in mounts if m.path == "/mcp"]
assert len(mcp_mounts) == 1, "Should have exactly one mount at /mcp"