-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Add ToolAnnotations support in FastMCP and lowlevel servers #482
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 4 commits
3ea2738
452278e
dd10fa1
fcf1051
72762a7
60c1566
343998c
a1b2ed5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,7 @@ | |
|
||
from mcp.server.fastmcp.exceptions import ToolError | ||
from mcp.server.fastmcp.utilities.func_metadata import FuncMetadata, func_metadata | ||
from mcp.types import ToolAnnotations | ||
|
||
if TYPE_CHECKING: | ||
from mcp.server.fastmcp.server import Context | ||
|
@@ -30,6 +31,9 @@ class Tool(BaseModel): | |
context_kwarg: str | None = Field( | ||
None, description="Name of the kwarg that should receive context" | ||
) | ||
annotations: ToolAnnotations | None = Field( | ||
None, description="Optional annotations for the tool" | ||
) | ||
|
||
@classmethod | ||
def from_function( | ||
|
@@ -38,9 +42,10 @@ def from_function( | |
name: str | None = None, | ||
description: str | None = None, | ||
context_kwarg: str | None = None, | ||
annotations: ToolAnnotations | None = None, | ||
) -> Tool: | ||
"""Create a Tool from a function.""" | ||
from mcp.server.fastmcp import Context | ||
from mcp.server.fastmcp.server import Context | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. what do we need to change this? I see the problem, but why do we even need it here?
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There's this a little further down in the function:
(and having it up at the top introduces a circular dependency) |
||
|
||
func_name = name or fn.__name__ | ||
|
||
|
@@ -73,6 +78,7 @@ def from_function( | |
fn_metadata=func_arg_metadata, | ||
is_async=is_async, | ||
context_kwarg=context_kwarg, | ||
annotations=annotations, | ||
) | ||
|
||
async def run( | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,111 @@ | ||
"""Tests for tool annotations in low-level server.""" | ||
|
||
import anyio | ||
import pytest | ||
|
||
from mcp.client.session import ClientSession | ||
from mcp.server import Server | ||
from mcp.server.lowlevel import NotificationOptions | ||
from mcp.server.models import InitializationOptions | ||
from mcp.server.session import ServerSession | ||
from mcp.shared.session import RequestResponder | ||
from mcp.types import ( | ||
ClientResult, | ||
JSONRPCMessage, | ||
ServerNotification, | ||
ServerRequest, | ||
Tool, | ||
ToolAnnotations, | ||
) | ||
|
||
|
||
@pytest.mark.anyio | ||
async def test_lowlevel_server_tool_annotations(): | ||
"""Test that tool annotations work in low-level server.""" | ||
server = Server("test") | ||
|
||
# Create a tool with annotations | ||
@server.list_tools() | ||
async def list_tools(): | ||
return [ | ||
Tool( | ||
name="echo", | ||
description="Echo a message back", | ||
inputSchema={ | ||
"type": "object", | ||
"properties": { | ||
"message": {"type": "string"}, | ||
}, | ||
"required": ["message"], | ||
}, | ||
annotations=ToolAnnotations( | ||
title="Echo Tool", | ||
readOnlyHint=True, | ||
), | ||
) | ||
] | ||
|
||
server_to_client_send, server_to_client_receive = anyio.create_memory_object_stream[ | ||
JSONRPCMessage | ||
](10) | ||
client_to_server_send, client_to_server_receive = anyio.create_memory_object_stream[ | ||
JSONRPCMessage | ||
](10) | ||
|
||
# Message handler for client | ||
async def message_handler( | ||
message: RequestResponder[ServerRequest, ClientResult] | ||
| ServerNotification | ||
| Exception, | ||
) -> None: | ||
if isinstance(message, Exception): | ||
raise message | ||
|
||
# Server task | ||
async def run_server(): | ||
async with ServerSession( | ||
client_to_server_receive, | ||
server_to_client_send, | ||
InitializationOptions( | ||
server_name="test-server", | ||
server_version="1.0.0", | ||
capabilities=server.get_capabilities( | ||
notification_options=NotificationOptions(), | ||
experimental_capabilities={}, | ||
), | ||
), | ||
) as server_session: | ||
async with anyio.create_task_group() as tg: | ||
|
||
async def handle_messages(): | ||
async for message in server_session.incoming_messages: | ||
await server._handle_message(message, server_session, {}, False) | ||
|
||
tg.start_soon(handle_messages) | ||
await anyio.sleep_forever() | ||
|
||
# Run the test | ||
async with anyio.create_task_group() as tg: | ||
tg.start_soon(run_server) | ||
|
||
async with ClientSession( | ||
server_to_client_receive, | ||
client_to_server_send, | ||
message_handler=message_handler, | ||
) as client_session: | ||
# Initialize the session | ||
await client_session.initialize() | ||
|
||
# List tools | ||
tools_result = await client_session.list_tools() | ||
|
||
# Cancel the server task | ||
tg.cancel_scope.cancel() | ||
|
||
# Verify results | ||
assert tools_result is not None | ||
assert len(tools_result.tools) == 1 | ||
assert tools_result.tools[0].name == "echo" | ||
assert tools_result.tools[0].annotations is not None | ||
assert tools_result.tools[0].annotations.title == "Echo Tool" | ||
assert tools_result.tools[0].annotations.readOnlyHint is True |
Uh oh!
There was an error while loading. Please reload this page.