arcade-mcp/libs/tests/core/test_schema.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

118 lines
3.6 KiB
Python

import pytest
from arcade_core.schema import (
ToolAuthorizationContext,
ToolContext,
ToolMetadataItem,
ToolSecretItem,
)
def test_get_auth_token_or_empty_with_token():
expected_token = "test_token" # noqa: S105
auth_context = ToolAuthorizationContext(token=expected_token)
tool_context = ToolContext(authorization=auth_context)
actual_token = tool_context.get_auth_token_or_empty()
assert actual_token == expected_token
def test_get_auth_token_or_empty_without_token():
auth_context = ToolAuthorizationContext(token=None)
tool_context = ToolContext(authorization=auth_context)
assert tool_context.get_auth_token_or_empty() == ""
def test_get_auth_token_or_empty_no_authorization():
tool_context = ToolContext(authorization=None)
assert tool_context.get_auth_token_or_empty() == ""
def test_get_secret_valid():
key = "my_key"
val = "secret_value"
secrets = [ToolSecretItem(key=key, value=val)]
tool_context = ToolContext(secrets=secrets)
# When the secret exists, get_secret should return its value.
actual_secret = tool_context.get_secret(key)
assert actual_secret == val
def test_get_secret_with_case_insensitive_key():
key = "My_key"
val = "secret_value"
secrets = [ToolSecretItem(key=key, value=val)]
tool_context = ToolContext(secrets=secrets)
assert tool_context.get_secret(key.upper()) == val
assert tool_context.get_secret(key.lower()) == val
def test_get_secret_key_not_found():
key = "nonexistent_key"
secrets = [ToolSecretItem(key="other_key", value="another_secret")]
tool_context = ToolContext(secrets=secrets)
# When the key is not found, get_secret should raise a ValueError.
with pytest.raises(ValueError, match=f"Secret '{key}' not found in context."):
tool_context.get_secret(key)
def test_get_secret_when_secrets_is_none():
tool_context = ToolContext(secrets=None)
# When no secrets dictionary is provided, get_secret should raise a ValueError.
with pytest.raises(ValueError, match="Secret 'missing_key' not found in context."):
tool_context.get_secret("missing_key")
def test_get_secret_with_empty_key():
tool_context = ToolContext(secrets=[])
with pytest.raises(ValueError, match="Secret key passed to get_secret cannot be empty."):
tool_context.get_secret("")
def test_get_metadata_valid():
key = "my_key"
val = "metadata_value"
metadata = [ToolMetadataItem(key=key, value=val)]
tool_context = ToolContext(metadata=metadata)
assert tool_context.get_metadata(key) == val
def test_get_metadata_with_case_insensitive_key():
key = "My_key"
val = "metadata_value"
metadata = [ToolMetadataItem(key=key, value=val)]
tool_context = ToolContext(metadata=metadata)
assert tool_context.get_metadata(key.upper()) == val
assert tool_context.get_metadata(key.lower()) == val
def test_get_metadata_key_not_found():
key = "nonexistent_key"
metadata = [ToolMetadataItem(key="other_key", value="another_metadata")]
tool_context = ToolContext(metadata=metadata)
with pytest.raises(ValueError, match=f"Metadata '{key}' not found in context."):
tool_context.get_metadata(key)
def test_get_metadata_when_metadata_is_none():
tool_context = ToolContext(metadata=None)
with pytest.raises(ValueError, match="Metadata 'missing_key' not found in context."):
tool_context.get_metadata("missing_key")
def test_get_metadata_with_empty_key():
tool_context = ToolContext(metadata=[])
with pytest.raises(ValueError, match="Metadata key passed to get_metadata cannot be empty."):
tool_context.get_metadata("")