diff --git a/examples/clients/conformance-auth-client/README.md b/examples/clients/conformance-auth-client/README.md new file mode 100644 index 000000000..312a992d0 --- /dev/null +++ b/examples/clients/conformance-auth-client/README.md @@ -0,0 +1,49 @@ +# MCP Conformance Auth Client + +A Python OAuth client designed for use with the MCP conformance test framework. + +## Overview + +This client implements OAuth authentication for MCP and is designed to work automatically with the conformance test framework without requiring user interaction. It programmatically fetches authorization URLs and extracts auth codes from redirects. + +## Installation + +```bash +cd examples/clients/conformance-auth-client +uv sync +``` + +## Usage with Conformance Tests + +Run the auth conformance tests against this Python client: + +```bash +# From the conformance repository +npx @modelcontextprotocol/conformance client \ + --command "uv run --directory /path/to/python-sdk/examples/clients/conformance-auth-client python -m mcp_conformance_auth_client" \ + --scenario auth/basic-dcr +``` + +Available auth test scenarios: + +- `auth/basic-dcr` - Tests OAuth Dynamic Client Registration flow +- `auth/basic-metadata-var1` - Tests OAuth with authorization metadata + +## How It Works + +Unlike interactive OAuth clients that open a browser for user authentication, this client: + +1. Receives the authorization URL from the OAuth provider +2. Makes an HTTP request to that URL directly (without following redirects) +3. Extracts the authorization code from the redirect response +4. Uses the code to complete the OAuth token exchange + +This allows the conformance test framework's mock OAuth server to automatically provide auth codes without human interaction. + +## Direct Usage + +You can also run the client directly: + +```bash +uv run python -m mcp_conformance_auth_client http://localhost:3000/mcp +``` diff --git a/examples/clients/conformance-auth-client/mcp_conformance_auth_client/__init__.py b/examples/clients/conformance-auth-client/mcp_conformance_auth_client/__init__.py new file mode 100644 index 000000000..71edc1c75 --- /dev/null +++ b/examples/clients/conformance-auth-client/mcp_conformance_auth_client/__init__.py @@ -0,0 +1,185 @@ +#!/usr/bin/env python3 +""" +MCP OAuth conformance test client. + +This client is designed to work with the MCP conformance test framework. +It automatically handles OAuth flows without user interaction by programmatically +fetching the authorization URL and extracting the auth code from the redirect. + +Usage: + python -m mcp_conformance_auth_client +""" + +import asyncio +import logging +import sys +from datetime import timedelta +from urllib.parse import ParseResult, parse_qs, urlparse + +import httpx +from mcp import ClientSession +from mcp.client.auth import OAuthClientProvider, TokenStorage +from mcp.client.streamable_http import streamablehttp_client +from mcp.shared.auth import OAuthClientInformationFull, OAuthClientMetadata, OAuthToken +from pydantic import AnyUrl + +# Set up logging to stderr (stdout is for conformance test output) +logging.basicConfig( + level=logging.DEBUG, + format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", + stream=sys.stderr, +) +logger = logging.getLogger(__name__) + + +class InMemoryTokenStorage(TokenStorage): + """Simple in-memory token storage for conformance testing.""" + + def __init__(self): + self._tokens: OAuthToken | None = None + self._client_info: OAuthClientInformationFull | None = None + + async def get_tokens(self) -> OAuthToken | None: + return self._tokens + + async def set_tokens(self, tokens: OAuthToken) -> None: + self._tokens = tokens + + async def get_client_info(self) -> OAuthClientInformationFull | None: + return self._client_info + + async def set_client_info(self, client_info: OAuthClientInformationFull) -> None: + self._client_info = client_info + + +class ConformanceOAuthCallbackHandler: + """ + OAuth callback handler that automatically fetches the authorization URL + and extracts the auth code, without requiring user interaction. + + This mimics the behavior of the TypeScript ConformanceOAuthProvider. + """ + + def __init__(self): + self._auth_code: str | None = None + self._state: str | None = None + + async def handle_redirect(self, authorization_url: str) -> None: + """ + Fetch the authorization URL and extract the auth code from the redirect. + + The conformance test server returns a redirect with the auth code, + so we can capture it programmatically. + """ + logger.debug(f"Fetching authorization URL: {authorization_url}") + + async with httpx.AsyncClient() as client: + response = await client.get( + authorization_url, + follow_redirects=False, # Don't follow redirects automatically + ) + + # Check for redirect response + if response.status_code in (301, 302, 303, 307, 308): + location = response.headers.get("location") + if location: + redirect_url: ParseResult = urlparse(location) + query_params: dict[str, list[str]] = parse_qs(redirect_url.query) + + if "code" in query_params: + self._auth_code = query_params["code"][0] + state_values = query_params.get("state") + self._state = state_values[0] if state_values else None + logger.debug(f"Got auth code from redirect: {self._auth_code[:10]}...") + return + else: + raise RuntimeError(f"No auth code in redirect URL: {location}") + else: + raise RuntimeError(f"No redirect location received from {authorization_url}") + else: + raise RuntimeError(f"Expected redirect response, got {response.status_code} from {authorization_url}") + + async def handle_callback(self) -> tuple[str, str | None]: + """Return the captured auth code and state, then clear them for potential reuse.""" + if self._auth_code is None: + raise RuntimeError("No authorization code available - was handle_redirect called?") + auth_code = self._auth_code + state = self._state + # Clear the stored values so the next auth flow gets fresh ones + self._auth_code = None + self._state = None + return auth_code, state + + +async def run_client(server_url: str) -> None: + """ + Run the conformance test client against the given server URL. + + This function: + 1. Connects to the MCP server with OAuth authentication + 2. Initializes the session + 3. Lists available tools + 4. Calls a test tool + """ + logger.debug(f"Starting conformance auth client for {server_url}") + + # Create callback handler that will automatically fetch auth codes + callback_handler = ConformanceOAuthCallbackHandler() + + # Create OAuth authentication handler + oauth_auth = OAuthClientProvider( + server_url=server_url, + client_metadata=OAuthClientMetadata( + client_name="conformance-auth-client", + redirect_uris=[AnyUrl("http://localhost:3000/callback")], + grant_types=["authorization_code", "refresh_token"], + response_types=["code"], + ), + storage=InMemoryTokenStorage(), + redirect_handler=callback_handler.handle_redirect, + callback_handler=callback_handler.handle_callback, + ) + + # Connect using streamable HTTP transport with OAuth + async with streamablehttp_client( + url=server_url, + auth=oauth_auth, + timeout=timedelta(seconds=30), + sse_read_timeout=timedelta(seconds=60), + ) as (read_stream, write_stream, _): + async with ClientSession(read_stream, write_stream) as session: + # Initialize the session + await session.initialize() + logger.debug("Successfully connected and initialized MCP session") + + # List tools + tools_result = await session.list_tools() + logger.debug(f"Listed tools: {[t.name for t in tools_result.tools]}") + + # Call test tool (expected by conformance tests) + try: + result = await session.call_tool("test-tool", {}) + logger.debug(f"Called test-tool, result: {result}") + except Exception as e: + logger.debug(f"Tool call result/error: {e}") + + logger.debug("Connection closed successfully") + + +def main() -> None: + """Main entry point for the conformance auth client.""" + if len(sys.argv) != 2: + print(f"Usage: {sys.argv[0]} ", file=sys.stderr) + sys.exit(1) + + server_url = sys.argv[1] + + try: + asyncio.run(run_client(server_url)) + except Exception: + logger.exception("Client failed") + sys.exit(1) + + +if __name__ == "__main__": + main() diff --git a/examples/clients/conformance-auth-client/mcp_conformance_auth_client/__main__.py b/examples/clients/conformance-auth-client/mcp_conformance_auth_client/__main__.py new file mode 100644 index 000000000..1b8f8acb0 --- /dev/null +++ b/examples/clients/conformance-auth-client/mcp_conformance_auth_client/__main__.py @@ -0,0 +1,6 @@ +"""Allow running the module with python -m.""" + +from . import main + +if __name__ == "__main__": + main() diff --git a/examples/clients/conformance-auth-client/pyproject.toml b/examples/clients/conformance-auth-client/pyproject.toml new file mode 100644 index 000000000..3d03b4d4a --- /dev/null +++ b/examples/clients/conformance-auth-client/pyproject.toml @@ -0,0 +1,43 @@ +[project] +name = "mcp-conformance-auth-client" +version = "0.1.0" +description = "OAuth conformance test client for MCP" +readme = "README.md" +requires-python = ">=3.10" +authors = [{ name = "Anthropic" }] +keywords = ["mcp", "oauth", "client", "auth", "conformance", "testing"] +license = { text = "MIT" } +classifiers = [ + "Development Status :: 4 - Beta", + "Intended Audience :: Developers", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.10", +] +dependencies = ["mcp", "httpx>=0.28.1"] + +[project.scripts] +mcp-conformance-auth-client = "mcp_conformance_auth_client:main" + +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[tool.hatch.build.targets.wheel] +packages = ["mcp_conformance_auth_client"] + +[tool.pyright] +include = ["mcp_conformance_auth_client"] +venvPath = "." +venv = ".venv" + +[tool.ruff.lint] +select = ["E", "F", "I"] +ignore = [] + +[tool.ruff] +line-length = 120 +target-version = "py310" + +[dependency-groups] +dev = ["pyright>=1.1.379", "pytest>=8.3.3", "ruff>=0.6.9"] diff --git a/uv.lock b/uv.lock index 5cc1c2619..d1363aef4 100644 --- a/uv.lock +++ b/uv.lock @@ -5,6 +5,7 @@ requires-python = ">=3.10" [manifest] members = [ "mcp", + "mcp-conformance-auth-client", "mcp-everything-server", "mcp-simple-auth", "mcp-simple-auth-client", @@ -853,6 +854,35 @@ docs = [ { name = "mkdocstrings-python", specifier = ">=1.12.2" }, ] +[[package]] +name = "mcp-conformance-auth-client" +version = "0.1.0" +source = { editable = "examples/clients/conformance-auth-client" } +dependencies = [ + { name = "httpx" }, + { name = "mcp" }, +] + +[package.dev-dependencies] +dev = [ + { name = "pyright" }, + { name = "pytest" }, + { name = "ruff" }, +] + +[package.metadata] +requires-dist = [ + { name = "httpx", specifier = ">=0.28.1" }, + { name = "mcp", editable = "." }, +] + +[package.metadata.requires-dev] +dev = [ + { name = "pyright", specifier = ">=1.1.379" }, + { name = "pytest", specifier = ">=8.3.3" }, + { name = "ruff", specifier = ">=0.6.9" }, +] + [[package]] name = "mcp-everything-server" version = "0.1.0"