{{ message }}
Repository navigation
Expand file tree
/
Copy pathtest_types.py
More file actions
505 lines (426 loc) · 17.9 KB
/
Copy pathtest_types.py
File metadata and controls
505 lines (426 loc) · 17.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
import subprocess
import sys
from types import ModuleType
from typing import Any
import mcp_types
import mcp_types.jsonrpc
import mcp_types.methods
import mcp_types.version
import pytest
from inline_snapshot import snapshot
from mcp_types import (
LATEST_PROTOCOL_VERSION,
CallToolResult,
ClientCapabilities,
CompleteResult,
Completion,
CreateMessageRequestParams,
CreateMessageResult,
CreateMessageResultWithTools,
DiscoverResult,
EmptyResult,
GetPromptResult,
Implementation,
InitializeRequest,
InitializeRequestParams,
InputRequiredResult,
JSONRPCRequest,
ListPromptsResult,
ListResourcesResult,
ListResourceTemplatesResult,
ListToolsResult,
ReadResourceResult,
Result,
SamplingCapability,
SamplingMessage,
ServerCapabilities,
TextContent,
Tool,
ToolChoice,
ToolResultContent,
ToolUseContent,
client_request_adapter,
jsonrpc_message_adapter,
)
from pydantic import ValidationError
import mcp
import mcp.types
import mcp.types.jsonrpc
import mcp.types.methods
import mcp.types.version
@pytest.mark.anyio
async def test_jsonrpc_request():
json_data = {
"jsonrpc": "2.0",
"id": 1,
"method": "initialize",
"params": {
"protocolVersion": LATEST_PROTOCOL_VERSION,
"capabilities": {"batch": None, "sampling": None},
"clientInfo": {"name": "mcp", "version": "0.1.0"},
},
}
request = jsonrpc_message_adapter.validate_python(json_data)
assert isinstance(request, JSONRPCRequest)
client_request_adapter.validate_python(request.model_dump(by_alias=True, exclude_none=True))
assert request.jsonrpc == "2.0"
assert request.id == 1
assert request.method == "initialize"
assert request.params is not None
assert request.params["protocolVersion"] == LATEST_PROTOCOL_VERSION
@pytest.mark.anyio
async def test_method_initialization():
"""Test that the method is automatically set on object creation.
Testing just for InitializeRequest to keep the test simple, but should be set for other types as well.
"""
initialize_request = InitializeRequest(
params=InitializeRequestParams(
protocol_version=LATEST_PROTOCOL_VERSION,
capabilities=ClientCapabilities(),
client_info=Implementation(
name="mcp",
version="0.1.0",
),
)
)
assert initialize_request.method == "initialize", "method should be set to 'initialize'"
assert initialize_request.params is not None
assert initialize_request.params.protocol_version == LATEST_PROTOCOL_VERSION
@pytest.mark.anyio
async def test_tool_use_content():
"""Test ToolUseContent type for SEP-1577."""
tool_use_data = {
"type": "tool_use",
"name": "get_weather",
"id": "call_abc123",
"input": {"location": "San Francisco", "unit": "celsius"},
}
tool_use = ToolUseContent.model_validate(tool_use_data)
assert tool_use.type == "tool_use"
assert tool_use.name == "get_weather"
assert tool_use.id == "call_abc123"
assert tool_use.input == {"location": "San Francisco", "unit": "celsius"}
# Test serialization
serialized = tool_use.model_dump(by_alias=True, exclude_none=True)
assert serialized["type"] == "tool_use"
assert serialized["name"] == "get_weather"
@pytest.mark.anyio
async def test_tool_result_content():
"""Test ToolResultContent type for SEP-1577."""
tool_result_data = {
"type": "tool_result",
"toolUseId": "call_abc123",
"content": [{"type": "text", "text": "It's 72°F in San Francisco"}],
"isError": False,
}
tool_result = ToolResultContent.model_validate(tool_result_data)
assert tool_result.type == "tool_result"
assert tool_result.tool_use_id == "call_abc123"
assert len(tool_result.content) == 1
assert tool_result.is_error is False
# Test with empty content (should default to [])
minimal_result_data = {"type": "tool_result", "toolUseId": "call_xyz"}
minimal_result = ToolResultContent.model_validate(minimal_result_data)
assert minimal_result.content == []
@pytest.mark.anyio
async def test_tool_choice():
"""Test ToolChoice type for SEP-1577."""
# Test with mode
tool_choice_data = {"mode": "required"}
tool_choice = ToolChoice.model_validate(tool_choice_data)
assert tool_choice.mode == "required"
# Test with minimal data (all fields optional)
minimal_choice = ToolChoice.model_validate({})
assert minimal_choice.mode is None
# Test different modes
auto_choice = ToolChoice.model_validate({"mode": "auto"})
assert auto_choice.mode == "auto"
none_choice = ToolChoice.model_validate({"mode": "none"})
assert none_choice.mode == "none"
@pytest.mark.anyio
async def test_sampling_message_with_user_role():
"""Test SamplingMessage with user role for SEP-1577."""
# Test with single content
user_msg_data = {"role": "user", "content": {"type": "text", "text": "Hello"}}
user_msg = SamplingMessage.model_validate(user_msg_data)
assert user_msg.role == "user"
assert isinstance(user_msg.content, TextContent)
# Test with array of content including tool result
multi_content_data: dict[str, Any] = {
"role": "user",
"content": [
{"type": "text", "text": "Here's the result:"},
{"type": "tool_result", "toolUseId": "call_123", "content": []},
],
}
multi_msg = SamplingMessage.model_validate(multi_content_data)
assert multi_msg.role == "user"
assert isinstance(multi_msg.content, list)
assert len(multi_msg.content) == 2
@pytest.mark.anyio
async def test_sampling_message_with_assistant_role():
"""Test SamplingMessage with assistant role for SEP-1577."""
# Test with tool use content
assistant_msg_data = {
"role": "assistant",
"content": {
"type": "tool_use",
"name": "search",
"id": "call_456",
"input": {"query": "MCP protocol"},
},
}
assistant_msg = SamplingMessage.model_validate(assistant_msg_data)
assert assistant_msg.role == "assistant"
assert isinstance(assistant_msg.content, ToolUseContent)
# Test with array of mixed content
multi_content_data: dict[str, Any] = {
"role": "assistant",
"content": [
{"type": "text", "text": "Let me search for that..."},
{"type": "tool_use", "name": "search", "id": "call_789", "input": {}},
],
}
multi_msg = SamplingMessage.model_validate(multi_content_data)
assert isinstance(multi_msg.content, list)
assert len(multi_msg.content) == 2
@pytest.mark.anyio
async def test_sampling_message_backward_compatibility():
"""Test that SamplingMessage maintains backward compatibility."""
# Old-style message (single content, no tools)
old_style_data = {"role": "user", "content": {"type": "text", "text": "Hello"}}
old_msg = SamplingMessage.model_validate(old_style_data)
assert old_msg.role == "user"
assert isinstance(old_msg.content, TextContent)
# New-style message with tool content
new_style_data: dict[str, Any] = {
"role": "assistant",
"content": {"type": "tool_use", "name": "test", "id": "call_1", "input": {}},
}
new_msg = SamplingMessage.model_validate(new_style_data)
assert new_msg.role == "assistant"
assert isinstance(new_msg.content, ToolUseContent)
# Array content
array_style_data: dict[str, Any] = {
"role": "user",
"content": [{"type": "text", "text": "Result:"}, {"type": "tool_result", "toolUseId": "call_1", "content": []}],
}
array_msg = SamplingMessage.model_validate(array_style_data)
assert isinstance(array_msg.content, list)
@pytest.mark.anyio
async def test_create_message_request_params_with_tools():
"""Test CreateMessageRequestParams with tools for SEP-1577."""
tool = Tool(
name="get_weather",
description="Get weather information",
input_schema={"type": "object", "properties": {"location": {"type": "string"}}},
)
params = CreateMessageRequestParams(
messages=[SamplingMessage(role="user", content=TextContent(type="text", text="What's the weather?"))],
max_tokens=1000,
tools=[tool],
tool_choice=ToolChoice(mode="auto"),
)
assert params.tools is not None
assert len(params.tools) == 1
assert params.tools[0].name == "get_weather"
assert params.tool_choice is not None
assert params.tool_choice.mode == "auto"
@pytest.mark.anyio
async def test_create_message_result_with_tool_use():
"""Test CreateMessageResultWithTools with tool use content for SEP-1577."""
result_data = {
"role": "assistant",
"content": {"type": "tool_use", "name": "search", "id": "call_123", "input": {"query": "test"}},
"model": "claude-3",
"stopReason": "toolUse",
}
# Tool use content uses CreateMessageResultWithTools
result = CreateMessageResultWithTools.model_validate(result_data)
assert result.role == "assistant"
assert isinstance(result.content, ToolUseContent)
assert result.stop_reason == "toolUse"
assert result.model == "claude-3"
# Test content_as_list with single content (covers else branch)
content_list = result.content_as_list
assert len(content_list) == 1
assert content_list[0] == result.content
@pytest.mark.anyio
async def test_create_message_result_basic():
"""Test CreateMessageResult with basic text content (backwards compatible)."""
result_data = {
"role": "assistant",
"content": {"type": "text", "text": "Hello!"},
"model": "claude-3",
"stopReason": "endTurn",
}
# Basic content uses CreateMessageResult (single content, no arrays)
result = CreateMessageResult.model_validate(result_data)
assert result.role == "assistant"
assert isinstance(result.content, TextContent)
assert result.content.text == "Hello!"
assert result.stop_reason == "endTurn"
assert result.model == "claude-3"
@pytest.mark.anyio
async def test_client_capabilities_with_sampling_tools():
"""Test ClientCapabilities with nested sampling capabilities for SEP-1577."""
# New structured format
capabilities_data: dict[str, Any] = {
"sampling": {"tools": {}},
}
capabilities = ClientCapabilities.model_validate(capabilities_data)
assert capabilities.sampling is not None
assert isinstance(capabilities.sampling, SamplingCapability)
assert capabilities.sampling.tools is not None
# With both context and tools
full_capabilities_data: dict[str, Any] = {"sampling": {"context": {}, "tools": {}}}
full_caps = ClientCapabilities.model_validate(full_capabilities_data)
assert isinstance(full_caps.sampling, SamplingCapability)
assert full_caps.sampling.context is not None
assert full_caps.sampling.tools is not None
def test_tool_preserves_json_schema_2020_12_fields():
"""Verify that JSON Schema 2020-12 keywords are preserved in Tool.inputSchema.
SEP-1613 establishes JSON Schema 2020-12 as the default dialect for MCP.
This test ensures the SDK doesn't strip $schema, $defs, or additionalProperties.
"""
input_schema = {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"$defs": {
"address": {
"type": "object",
"properties": {"street": {"type": "string"}, "city": {"type": "string"}},
}
},
"properties": {
"name": {"type": "string"},
"address": {"$ref": "#/$defs/address"},
},
"additionalProperties": False,
}
tool = Tool(name="test_tool", description="A test tool", input_schema=input_schema)
# Verify fields are preserved in the model
assert tool.input_schema["$schema"] == "https://json-schema.org/draft/2020-12/schema"
assert "$defs" in tool.input_schema
assert "address" in tool.input_schema["$defs"]
assert tool.input_schema["additionalProperties"] is False
# Verify fields survive serialization round-trip
serialized = tool.model_dump(mode="json", by_alias=True)
assert serialized["inputSchema"]["$schema"] == "https://json-schema.org/draft/2020-12/schema"
assert "$defs" in serialized["inputSchema"]
assert serialized["inputSchema"]["additionalProperties"] is False
def test_list_tools_result_preserves_json_schema_2020_12_fields():
"""Verify JSON Schema 2020-12 fields survive ListToolsResult deserialization."""
raw_response = {
"tools": [
{
"name": "json_schema_tool",
"description": "Tool with JSON Schema 2020-12 features",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"$defs": {"item": {"type": "string"}},
"properties": {"items": {"type": "array", "items": {"$ref": "#/$defs/item"}}},
"additionalProperties": False,
},
}
]
}
result = ListToolsResult.model_validate(raw_response)
tool = result.tools[0]
assert tool.input_schema["$schema"] == "https://json-schema.org/draft/2020-12/schema"
assert "$defs" in tool.input_schema
assert tool.input_schema["additionalProperties"] is False
def _wire_dump(result: Result) -> dict[str, Any]:
return result.model_dump(by_alias=True, mode="json", exclude_none=True)
def test_concrete_wire_results_always_dump_result_type_complete():
"""Required by 2026-07-28; the runner's per-version sieve drops it for older peers."""
carriers: list[Result] = [
CompleteResult(completion=Completion(values=[])),
GetPromptResult(messages=[]),
CallToolResult(content=[]),
ReadResourceResult(contents=[]),
ListPromptsResult(prompts=[]),
ListResourcesResult(resources=[]),
ListResourceTemplatesResult(resource_templates=[]),
ListToolsResult(tools=[]),
DiscoverResult(
supported_versions=["2026-07-28"],
capabilities=ServerCapabilities(),
),
]
for result in carriers:
assert _wire_dump(result)["resultType"] == "complete", type(result).__name__
def test_cacheable_results_default_to_immediately_stale_private():
"""`ttl_ms`/`cache_scope` default to 0/"private" so list-results validate at
2026-07-28 without the handler setting them, and never accidentally enable
shared caching."""
cacheable: list[Result] = [
ReadResourceResult(contents=[]),
ListPromptsResult(prompts=[]),
ListResourceTemplatesResult(resource_templates=[]),
ListResourcesResult(resources=[]),
ListToolsResult(tools=[]),
DiscoverResult(
supported_versions=["2026-07-28"],
capabilities=ServerCapabilities(),
),
]
for result in cacheable:
dumped = _wire_dump(result)
assert dumped["ttlMs"] == 0, type(result).__name__
assert dumped["cacheScope"] == "private", type(result).__name__
explicit = _wire_dump(ListToolsResult(tools=[], ttl_ms=5, cache_scope="public"))
assert explicit["ttlMs"] == 5
assert explicit["cacheScope"] == "public"
def test_empty_result_dumps_no_fields_by_default():
"""Deployed peers reject extra keys on empty results, so resultType is never volunteered."""
assert _wire_dump(EmptyResult()) == snapshot({})
def test_empty_result_dumps_result_type_only_when_explicitly_tagged():
assert _wire_dump(EmptyResult(result_type="complete")) == snapshot({"resultType": "complete"})
def test_input_required_result_dumps_its_discriminating_tag():
assert _wire_dump(InputRequiredResult(request_state="s")) == snapshot(
{"resultType": "input_required", "requestState": "s"}
)
def test_input_required_result_requires_at_least_one_of_input_requests_or_request_state():
with pytest.raises(ValidationError):
InputRequiredResult()
with pytest.raises(ValidationError):
InputRequiredResult(input_requests={})
assert InputRequiredResult(request_state="s").input_requests is None
def _assert_mirrors(mirror: ModuleType, source: ModuleType) -> None:
# The mirror shares the source's `__all__` list object by construction (`from source import
# __all__`), so the meaningful proof is that every exported name is the identical object.
assert all(getattr(mirror, name) is getattr(source, name) for name in source.__all__)
def test_mcp_types_namespace_mirrors_mcp_types_exactly():
"""SDK-defined: `mcp.types` is a permanent alias whose every name is the `mcp_types` object."""
_assert_mirrors(mcp.types, mcp_types)
@pytest.mark.parametrize(
("mirror", "source"),
[
(mcp.types.jsonrpc, mcp_types.jsonrpc),
(mcp.types.methods, mcp_types.methods),
(mcp.types.version, mcp_types.version),
],
ids=["jsonrpc", "methods", "version"],
)
def test_mcp_types_submodules_mirror_mcp_types_submodules_exactly(mirror: ModuleType, source: ModuleType):
"""SDK-defined: every supported `mcp_types` submodule has an `mcp.types` mirror, name for name."""
_assert_mirrors(mirror, source)
def test_bare_import_mcp_binds_the_types_submodule():
"""SDK-defined: `import mcp` alone binds `mcp.types`, so v1's `mcp.types.Tool` idiom works.
A fresh interpreter is required to observe `import mcp` in isolation: this test process
has already imported `mcp.types`, and reloading `mcp` here would rebind classes that other
tests hold references to.
"""
# A regression hangs forever, so the bound only has to beat never (matches the suite's
# other subprocess.run calls).
result = subprocess.run(
[sys.executable, "-X", "utf8", "-c", "import mcp; print(mcp.types.Tool.__name__)"],
capture_output=True,
encoding="utf-8",
check=False,
timeout=20,
)
assert result.returncode == 0, result.stderr
assert result.stdout == snapshot("Tool\n")
You can’t perform that action at this time.