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

130 lines
4 KiB
Python

"""Tests for ServerSession/RequestManager cancellation behavior."""
import asyncio
import json
from typing import Any
from unittest.mock import AsyncMock
import pytest
from arcade_mcp_server.session import ServerSession
@pytest.mark.asyncio
@pytest.mark.parametrize(
"method,params",
[
("sampling/createMessage", {"messages": [], "maxTokens": 1}),
("roots/list", None),
(
"completion/complete",
{"ref": {"type": "ref/prompt", "name": "x"}, "argument": {"name": "q", "value": ""}},
),
],
)
async def test_cancel_all_sends_notifications_and_fails_futures(
mcp_server, mock_read_stream, mock_write_stream, method, params
):
session = ServerSession(
server=mcp_server, read_stream=mock_read_stream, write_stream=mock_write_stream
)
assert session._request_manager is not None
mock_write_stream.send = AsyncMock()
pending_task = asyncio.create_task(
session._request_manager.send_request(method, params, timeout=5.0)
)
await asyncio.sleep(0)
await session._cleanup_pending_requests()
from arcade_mcp_server.exceptions import SessionError
with pytest.raises(SessionError):
await pending_task
# Verify a cancelled notification was sent
assert mock_write_stream.send.call_count >= 1
sent_methods = [
json.loads(call[0][0].strip()).get("method")
for call in mock_write_stream.send.call_args_list
]
assert "notifications/cancelled" in sent_methods
@pytest.mark.asyncio
@pytest.mark.parametrize(
"method,params",
[
("roots/list", None),
("sampling/createMessage", {"messages": [], "maxTokens": 1}),
],
)
async def test_closed_flag_drops_late_responses(
mcp_server, mock_read_stream, mock_write_stream, method, params
):
session = ServerSession(
server=mcp_server, read_stream=mock_read_stream, write_stream=mock_write_stream
)
assert session._request_manager is not None
mock_write_stream.send = AsyncMock()
send_task = asyncio.create_task(
session._request_manager.send_request(method, params, timeout=5.0)
)
await asyncio.sleep(0)
await session._cleanup_pending_requests()
# Simulate a late response from client; should be dropped silently
late_response: dict[str, Any] = {"jsonrpc": "2.0", "id": "unknown", "result": {"ok": True}}
await session._request_manager.handle_response(late_response)
from arcade_mcp_server.exceptions import SessionError
with pytest.raises(SessionError):
await send_task
@pytest.mark.asyncio
@pytest.mark.parametrize(
"method,params",
[
(
"completion/complete",
{"ref": {"type": "ref/prompt", "name": "x"}, "argument": {"name": "q", "value": "v"}},
),
("sampling/createMessage", {"messages": [], "maxTokens": 1}),
],
)
async def test_new_requests_rejected_after_close(
mcp_server, mock_read_stream, mock_write_stream, method, params
):
session = ServerSession(
server=mcp_server, read_stream=mock_read_stream, write_stream=mock_write_stream
)
assert session._request_manager is not None
await session._cleanup_pending_requests()
from arcade_mcp_server.exceptions import SessionError
with pytest.raises(SessionError):
await session._request_manager.send_request(method, params, timeout=0.1)
@pytest.mark.asyncio
async def test_cleanup_is_idempotent(mcp_server, mock_read_stream, mock_write_stream):
session = ServerSession(
server=mcp_server, read_stream=mock_read_stream, write_stream=mock_write_stream
)
assert session._request_manager is not None
await session._cleanup_pending_requests()
# Calling again should not raise and should not send extra notifications
before = getattr(mock_write_stream.send, "call_count", 0)
await session._cleanup_pending_requests()
after = getattr(mock_write_stream.send, "call_count", 0)
# Allow zero or unchanged; do not enforce increase
assert after >= before