|
| 1 | +"""Tests for _meta attribute support in resources.""" |
| 2 | + |
| 3 | +from collections.abc import Iterable |
| 4 | +from pathlib import Path |
| 5 | +from tempfile import NamedTemporaryFile |
| 6 | + |
| 7 | +import pytest |
| 8 | +from pydantic import AnyUrl, FileUrl |
| 9 | + |
| 10 | +import mcp.types as types |
| 11 | +from mcp.server.lowlevel.server import ReadResourceContents, Server |
| 12 | + |
| 13 | + |
| 14 | +@pytest.fixture |
| 15 | +def temp_file(): |
| 16 | + """Create a temporary file for testing.""" |
| 17 | + with NamedTemporaryFile(mode="w", delete=False) as f: |
| 18 | + f.write("test content") |
| 19 | + path = Path(f.name).resolve() |
| 20 | + yield path |
| 21 | + try: |
| 22 | + path.unlink() |
| 23 | + except FileNotFoundError: # pragma: no cover |
| 24 | + pass |
| 25 | + |
| 26 | + |
| 27 | +@pytest.mark.anyio |
| 28 | +async def test_read_resource_text_with_meta(temp_file: Path): |
| 29 | + """Test that _meta attributes are passed through for text resources.""" |
| 30 | + server = Server("test") |
| 31 | + |
| 32 | + @server.read_resource() |
| 33 | + async def read_resource(uri: AnyUrl) -> Iterable[ReadResourceContents]: |
| 34 | + return [ |
| 35 | + ReadResourceContents( |
| 36 | + content="Hello World", |
| 37 | + mime_type="text/plain", |
| 38 | + meta={"widgetDomain": "example.com", "custom": "value"}, |
| 39 | + ) |
| 40 | + ] |
| 41 | + |
| 42 | + # Get the handler directly from the server |
| 43 | + handler = server.request_handlers[types.ReadResourceRequest] |
| 44 | + |
| 45 | + # Create a request |
| 46 | + request = types.ReadResourceRequest( |
| 47 | + params=types.ReadResourceRequestParams(uri=FileUrl(temp_file.as_uri())), |
| 48 | + ) |
| 49 | + |
| 50 | + # Call the handler |
| 51 | + result = await handler(request) |
| 52 | + assert isinstance(result.root, types.ReadResourceResult) |
| 53 | + assert len(result.root.contents) == 1 |
| 54 | + |
| 55 | + content = result.root.contents[0] |
| 56 | + assert isinstance(content, types.TextResourceContents) |
| 57 | + assert content.text == "Hello World" |
| 58 | + assert content.mimeType == "text/plain" |
| 59 | + assert content.meta is not None |
| 60 | + assert content.meta["widgetDomain"] == "example.com" |
| 61 | + assert content.meta["custom"] == "value" |
| 62 | + |
| 63 | + |
| 64 | +@pytest.mark.anyio |
| 65 | +async def test_read_resource_binary_with_meta(temp_file: Path): |
| 66 | + """Test that _meta attributes are passed through for binary resources.""" |
| 67 | + server = Server("test") |
| 68 | + |
| 69 | + @server.read_resource() |
| 70 | + async def read_resource(uri: AnyUrl) -> Iterable[ReadResourceContents]: |
| 71 | + return [ |
| 72 | + ReadResourceContents( |
| 73 | + content=b"Hello World", |
| 74 | + mime_type="application/octet-stream", |
| 75 | + meta={"encoding": "base64", "size": 11}, |
| 76 | + ) |
| 77 | + ] |
| 78 | + |
| 79 | + # Get the handler directly from the server |
| 80 | + handler = server.request_handlers[types.ReadResourceRequest] |
| 81 | + |
| 82 | + # Create a request |
| 83 | + request = types.ReadResourceRequest( |
| 84 | + params=types.ReadResourceRequestParams(uri=FileUrl(temp_file.as_uri())), |
| 85 | + ) |
| 86 | + |
| 87 | + # Call the handler |
| 88 | + result = await handler(request) |
| 89 | + assert isinstance(result.root, types.ReadResourceResult) |
| 90 | + assert len(result.root.contents) == 1 |
| 91 | + |
| 92 | + content = result.root.contents[0] |
| 93 | + assert isinstance(content, types.BlobResourceContents) |
| 94 | + assert content.mimeType == "application/octet-stream" |
| 95 | + assert content.meta is not None |
| 96 | + assert content.meta["encoding"] == "base64" |
| 97 | + assert content.meta["size"] == 11 |
| 98 | + |
| 99 | + |
| 100 | +@pytest.mark.anyio |
| 101 | +async def test_read_resource_without_meta(temp_file: Path): |
| 102 | + """Test that resources work correctly without _meta (backwards compatibility).""" |
| 103 | + server = Server("test") |
| 104 | + |
| 105 | + @server.read_resource() |
| 106 | + async def read_resource(uri: AnyUrl) -> Iterable[ReadResourceContents]: |
| 107 | + return [ReadResourceContents(content="Hello World", mime_type="text/plain")] |
| 108 | + |
| 109 | + # Get the handler directly from the server |
| 110 | + handler = server.request_handlers[types.ReadResourceRequest] |
| 111 | + |
| 112 | + # Create a request |
| 113 | + request = types.ReadResourceRequest( |
| 114 | + params=types.ReadResourceRequestParams(uri=FileUrl(temp_file.as_uri())), |
| 115 | + ) |
| 116 | + |
| 117 | + # Call the handler |
| 118 | + result = await handler(request) |
| 119 | + assert isinstance(result.root, types.ReadResourceResult) |
| 120 | + assert len(result.root.contents) == 1 |
| 121 | + |
| 122 | + content = result.root.contents[0] |
| 123 | + assert isinstance(content, types.TextResourceContents) |
| 124 | + assert content.text == "Hello World" |
| 125 | + assert content.mimeType == "text/plain" |
| 126 | + assert content.meta is None |
| 127 | + |
| 128 | + |
| 129 | +@pytest.mark.anyio |
| 130 | +async def test_read_resource_multiple_contents_with_meta(temp_file: Path): |
| 131 | + """Test multiple resource contents with different _meta values.""" |
| 132 | + server = Server("test") |
| 133 | + |
| 134 | + @server.read_resource() |
| 135 | + async def read_resource(uri: AnyUrl) -> Iterable[ReadResourceContents]: |
| 136 | + return [ |
| 137 | + ReadResourceContents( |
| 138 | + content="First content", |
| 139 | + mime_type="text/plain", |
| 140 | + meta={"index": 0, "type": "header"}, |
| 141 | + ), |
| 142 | + ReadResourceContents( |
| 143 | + content="Second content", |
| 144 | + mime_type="text/plain", |
| 145 | + meta={"index": 1, "type": "body"}, |
| 146 | + ), |
| 147 | + ] |
| 148 | + |
| 149 | + # Get the handler directly from the server |
| 150 | + handler = server.request_handlers[types.ReadResourceRequest] |
| 151 | + |
| 152 | + # Create a request |
| 153 | + request = types.ReadResourceRequest( |
| 154 | + params=types.ReadResourceRequestParams(uri=FileUrl(temp_file.as_uri())), |
| 155 | + ) |
| 156 | + |
| 157 | + # Call the handler |
| 158 | + result = await handler(request) |
| 159 | + assert isinstance(result.root, types.ReadResourceResult) |
| 160 | + assert len(result.root.contents) == 2 |
| 161 | + |
| 162 | + # Check first content |
| 163 | + content0 = result.root.contents[0] |
| 164 | + assert isinstance(content0, types.TextResourceContents) |
| 165 | + assert content0.text == "First content" |
| 166 | + assert content0.meta is not None |
| 167 | + assert content0.meta["index"] == 0 |
| 168 | + assert content0.meta["type"] == "header" |
| 169 | + |
| 170 | + # Check second content |
| 171 | + content1 = result.root.contents[1] |
| 172 | + assert isinstance(content1, types.TextResourceContents) |
| 173 | + assert content1.text == "Second content" |
| 174 | + assert content1.meta is not None |
| 175 | + assert content1.meta["index"] == 1 |
| 176 | + assert content1.meta["type"] == "body" |
0 commit comments