mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-09 15:19:10 +02:00
219 lines
7 KiB
Python
219 lines
7 KiB
Python
from typing import Any
|
|
|
|
from mcp.types import TextContent, ToolAnnotations
|
|
|
|
from fastmcp import Client, FastMCP
|
|
|
|
|
|
async def test_tool_annotations_in_tool_manager():
|
|
"""Test that tool annotations are correctly stored in the tool manager."""
|
|
mcp = FastMCP("Test Server")
|
|
|
|
@mcp.tool(
|
|
annotations=ToolAnnotations(
|
|
title="Echo Tool",
|
|
readOnlyHint=True,
|
|
openWorldHint=False,
|
|
)
|
|
)
|
|
def echo(message: str) -> str:
|
|
"""Echo back the message provided."""
|
|
return message
|
|
|
|
# Check internal tool objects directly
|
|
tools = mcp._tool_manager.list_tools()
|
|
assert len(tools) == 1
|
|
assert tools[0].annotations is not None
|
|
assert tools[0].annotations.title == "Echo Tool"
|
|
assert tools[0].annotations.readOnlyHint is True
|
|
assert tools[0].annotations.openWorldHint is False
|
|
|
|
|
|
async def test_tool_annotations_in_mcp_protocol():
|
|
"""Test that tool annotations are correctly propagated to MCP tools list."""
|
|
mcp = FastMCP("Test Server")
|
|
|
|
@mcp.tool(
|
|
annotations=ToolAnnotations(
|
|
title="Echo Tool",
|
|
readOnlyHint=True,
|
|
openWorldHint=False,
|
|
)
|
|
)
|
|
def echo(message: str) -> str:
|
|
"""Echo back the message provided."""
|
|
return message
|
|
|
|
# Check via MCP protocol
|
|
mcp_tools = await mcp._mcp_list_tools()
|
|
assert len(mcp_tools) == 1
|
|
assert mcp_tools[0].annotations is not None
|
|
assert mcp_tools[0].annotations.title == "Echo Tool"
|
|
assert mcp_tools[0].annotations.readOnlyHint is True
|
|
assert mcp_tools[0].annotations.openWorldHint is False
|
|
|
|
|
|
async def test_tool_annotations_in_client_api():
|
|
"""Test that tool annotations are correctly accessible via client API."""
|
|
mcp = FastMCP("Test Server")
|
|
|
|
@mcp.tool(
|
|
annotations=ToolAnnotations(
|
|
title="Echo Tool",
|
|
readOnlyHint=True,
|
|
openWorldHint=False,
|
|
)
|
|
)
|
|
def echo(message: str) -> str:
|
|
"""Echo back the message provided."""
|
|
return message
|
|
|
|
# Check via client API
|
|
async with Client(mcp) as client:
|
|
tools_result = await client.list_tools()
|
|
assert len(tools_result) == 1
|
|
assert tools_result[0].name == "echo"
|
|
assert tools_result[0].annotations is not None
|
|
assert tools_result[0].annotations.title == "Echo Tool"
|
|
assert tools_result[0].annotations.readOnlyHint is True
|
|
assert tools_result[0].annotations.openWorldHint is False
|
|
|
|
|
|
async def test_provide_tool_annotations_as_dict_to_decorator():
|
|
"""Test that tool annotations are correctly accessible via client API."""
|
|
mcp = FastMCP("Test Server")
|
|
|
|
@mcp.tool(
|
|
annotations={
|
|
"title": "Echo Tool",
|
|
"readOnlyHint": True,
|
|
"openWorldHint": False,
|
|
}
|
|
)
|
|
def echo(message: str) -> str:
|
|
"""Echo back the message provided."""
|
|
return message
|
|
|
|
# Check via client API
|
|
async with Client(mcp) as client:
|
|
tools_result = await client.list_tools()
|
|
assert len(tools_result) == 1
|
|
assert tools_result[0].name == "echo"
|
|
assert tools_result[0].annotations is not None
|
|
assert tools_result[0].annotations.title == "Echo Tool"
|
|
assert tools_result[0].annotations.readOnlyHint is True
|
|
assert tools_result[0].annotations.openWorldHint is False
|
|
|
|
|
|
async def test_direct_tool_annotations_in_tool_manager():
|
|
"""Test direct ToolAnnotations object is correctly stored in tool manager."""
|
|
mcp = FastMCP("Test Server")
|
|
|
|
annotations = ToolAnnotations(
|
|
title="Direct Tool",
|
|
readOnlyHint=False,
|
|
destructiveHint=True,
|
|
idempotentHint=False,
|
|
openWorldHint=True,
|
|
)
|
|
|
|
@mcp.tool(annotations=annotations)
|
|
def modify(data: dict[str, Any]) -> dict[str, Any]:
|
|
"""Modify the data provided."""
|
|
return {"modified": True, **data}
|
|
|
|
# Check internal tool objects directly
|
|
tools = mcp._tool_manager.list_tools()
|
|
assert len(tools) == 1
|
|
assert tools[0].annotations is not None
|
|
assert tools[0].annotations.title == "Direct Tool"
|
|
assert tools[0].annotations.readOnlyHint is False
|
|
assert tools[0].annotations.destructiveHint is True
|
|
assert tools[0].annotations.idempotentHint is False
|
|
assert tools[0].annotations.openWorldHint is True
|
|
|
|
|
|
async def test_direct_tool_annotations_in_client_api():
|
|
"""Test direct ToolAnnotations object is correctly accessible via client API."""
|
|
mcp = FastMCP("Test Server")
|
|
|
|
annotations = ToolAnnotations(
|
|
title="Direct Tool",
|
|
readOnlyHint=False,
|
|
destructiveHint=True,
|
|
idempotentHint=False,
|
|
openWorldHint=True,
|
|
)
|
|
|
|
@mcp.tool(annotations=annotations)
|
|
def modify(data: dict[str, Any]) -> dict[str, Any]:
|
|
"""Modify the data provided."""
|
|
return {"modified": True, **data}
|
|
|
|
# Check via client API
|
|
async with Client(mcp) as client:
|
|
tools_result = await client.list_tools()
|
|
assert len(tools_result) == 1
|
|
assert tools_result[0].name == "modify"
|
|
assert tools_result[0].annotations is not None
|
|
assert tools_result[0].annotations.title == "Direct Tool"
|
|
assert tools_result[0].annotations.readOnlyHint is False
|
|
assert tools_result[0].annotations.destructiveHint is True
|
|
|
|
|
|
async def test_add_tool_method_annotations():
|
|
"""Test that tool annotations work with add_tool method."""
|
|
mcp = FastMCP("Test Server")
|
|
|
|
def create_item(name: str, value: int) -> dict[str, Any]:
|
|
"""Create a new item."""
|
|
return {"name": name, "value": value}
|
|
|
|
mcp.add_tool(
|
|
create_item,
|
|
name="create_item",
|
|
annotations=ToolAnnotations(
|
|
title="Create Item",
|
|
readOnlyHint=False,
|
|
destructiveHint=False,
|
|
),
|
|
)
|
|
|
|
# Check internal tool objects directly
|
|
tools = mcp._tool_manager.list_tools()
|
|
assert len(tools) == 1
|
|
assert tools[0].annotations is not None
|
|
assert tools[0].annotations.title == "Create Item"
|
|
assert tools[0].annotations.readOnlyHint is False
|
|
assert tools[0].annotations.destructiveHint is False
|
|
|
|
|
|
async def test_tool_functionality_with_annotations():
|
|
"""Test that tool functionality is preserved when using annotations."""
|
|
mcp = FastMCP("Test Server")
|
|
|
|
def create_item(name: str, value: int) -> dict[str, Any]:
|
|
"""Create a new item."""
|
|
return {"name": name, "value": value}
|
|
|
|
mcp.add_tool(
|
|
create_item,
|
|
name="create_item",
|
|
annotations=ToolAnnotations(
|
|
title="Create Item",
|
|
readOnlyHint=False,
|
|
destructiveHint=False,
|
|
),
|
|
)
|
|
|
|
# Use the tool to verify functionality is preserved
|
|
async with Client(mcp) as client:
|
|
result = await client.call_tool(
|
|
"create_item", {"name": "test_item", "value": 42}
|
|
)
|
|
assert len(result) == 1
|
|
assert isinstance(result[0], TextContent)
|
|
|
|
# The result should contain the expected JSON
|
|
assert '"name": "test_item"' in result[0].text
|
|
assert '"value": 42' in result[0].text
|