Skip to content

vllm.entrypoints.tool_server

logger module-attribute 

logger = init_logger(__name__)

DemoToolServer

Bases: ToolServer

Source code in vllm/entrypoints/tool_server.py 
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
class DemoToolServer(ToolServer):
    def __init__(self):
        self.tools: dict[str, Tool] = {}

    async def init_and_validate(self):
        browser_tool = HarmonyBrowserTool()
        python_tool = HarmonyPythonTool()
        await python_tool.validate()
        if browser_tool.enabled:
            self.tools["browser"] = browser_tool
        if python_tool.enabled:
            self.tools["python"] = python_tool
        logger.info(
            "DemoToolServer initialized with tools: %s", list(self.tools.keys())
        )

    def has_tool(self, tool_name: str) -> bool:
        return tool_name in self.tools

    def get_tool_description(self, tool_name: str) -> ToolNamespaceConfig | None:
        if tool_name not in self.tools:
            return None
        if tool_name == "browser":
            return ToolNamespaceConfig.browser()
        elif tool_name == "python":
            return ToolNamespaceConfig.python()
        else:
            raise ValueError(f"Unknown tool {tool_name}")

    @asynccontextmanager
    async def new_session(
        self, tool_name: str, session_id: str, headers: dict[str, str] | None = None
    ):
        if tool_name not in self.tools:
            raise KeyError(f"Tool '{tool_name}' is not supported")
        yield self.tools[tool_name]

tools instance-attribute 

tools: dict[str, Tool] = {}

__init__ 

__init__()
Source code in vllm/entrypoints/tool_server.py 
175
176
def __init__(self):
    self.tools: dict[str, Tool] = {}

get_tool_description 

get_tool_description(
    tool_name: str,
) -> ToolNamespaceConfig | None
Source code in vllm/entrypoints/tool_server.py 
193
194
195
196
197
198
199
200
201
def get_tool_description(self, tool_name: str) -> ToolNamespaceConfig | None:
    if tool_name not in self.tools:
        return None
    if tool_name == "browser":
        return ToolNamespaceConfig.browser()
    elif tool_name == "python":
        return ToolNamespaceConfig.python()
    else:
        raise ValueError(f"Unknown tool {tool_name}")

has_tool 

has_tool(tool_name: str) -> bool
Source code in vllm/entrypoints/tool_server.py 
190
191
def has_tool(self, tool_name: str) -> bool:
    return tool_name in self.tools

init_and_validate async 

init_and_validate()
Source code in vllm/entrypoints/tool_server.py 
178
179
180
181
182
183
184
185
186
187
188
async def init_and_validate(self):
    browser_tool = HarmonyBrowserTool()
    python_tool = HarmonyPythonTool()
    await python_tool.validate()
    if browser_tool.enabled:
        self.tools["browser"] = browser_tool
    if python_tool.enabled:
        self.tools["python"] = python_tool
    logger.info(
        "DemoToolServer initialized with tools: %s", list(self.tools.keys())
    )

new_session async 

new_session(
    tool_name: str,
    session_id: str,
    headers: dict[str, str] | None = None,
)
Source code in vllm/entrypoints/tool_server.py 
203
204
205
206
207
208
209
@asynccontextmanager
async def new_session(
    self, tool_name: str, session_id: str, headers: dict[str, str] | None = None
):
    if tool_name not in self.tools:
        raise KeyError(f"Tool '{tool_name}' is not supported")
    yield self.tools[tool_name]

MCPToolServer

Bases: ToolServer

Source code in vllm/entrypoints/tool_server.py 
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
class MCPToolServer(ToolServer):
    def __init__(self):
        try:
            import mcp  # noqa: F401
        except ImportError:
            raise ImportError(
                "mcp is not installed. Please run `pip install mcp` to use "
                "MCPToolServer."
            ) from None
        self.harmony_tool_descriptions = {}

    async def add_tool_server(self, server_url: str):
        tool_urls = server_url.split(",")
        self.harmony_tool_descriptions = {}
        self.urls: dict[str, str] = {}
        for url in tool_urls:
            url = f"http://{url}/sse"
            initialize_response, list_tools_response = await list_server_and_tools(url)

            list_tools_response = post_process_tools_description(list_tools_response)

            tool_from_mcp = ToolNamespaceConfig(
                name=initialize_response.serverInfo.name,
                description=initialize_response.instructions,
                tools=[
                    ToolDescription.new(
                        name=tool.name,
                        description=tool.description,
                        parameters=tool.inputSchema,
                    )
                    for tool in list_tools_response.tools
                ],
            )
            self.harmony_tool_descriptions[tool_from_mcp.name] = tool_from_mcp
            if tool_from_mcp.name not in self.urls:
                self.urls[tool_from_mcp.name] = url
            else:
                logger.warning(
                    "Tool %s already exists. Ignoring duplicate tool server %s",
                    tool_from_mcp.name,
                    url,
                )
        logger.info(
            "MCPToolServer initialized with tools: %s",
            list(self.harmony_tool_descriptions.keys()),
        )

    def has_tool(self, tool_name: str):
        return tool_name in self.harmony_tool_descriptions

    def get_tool_description(self, tool_name: str):
        return self.harmony_tool_descriptions.get(tool_name)

    @asynccontextmanager
    async def new_session(
        self, tool_name: str, session_id: str, headers: dict[str, str] | None = None
    ):
        from mcp import ClientSession
        from mcp.client.sse import sse_client

        url = self.urls.get(tool_name)
        request_headers = {"x-session-id": session_id}
        if headers is not None:
            request_headers.update(headers)
        if not url:
            raise KeyError(f"Tool '{tool_name}' is not supported")
        async with (
            sse_client(url=url, headers=request_headers) as streams,
            ClientSession(*streams) as session,
        ):
            await session.initialize()
            yield session

harmony_tool_descriptions instance-attribute 

harmony_tool_descriptions = {}

__init__ 

__init__()
Source code in vllm/entrypoints/tool_server.py 
101
102
103
104
105
106
107
108
109
def __init__(self):
    try:
        import mcp  # noqa: F401
    except ImportError:
        raise ImportError(
            "mcp is not installed. Please run `pip install mcp` to use "
            "MCPToolServer."
        ) from None
    self.harmony_tool_descriptions = {}

add_tool_server async 

add_tool_server(server_url: str)
Source code in vllm/entrypoints/tool_server.py 
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
async def add_tool_server(self, server_url: str):
    tool_urls = server_url.split(",")
    self.harmony_tool_descriptions = {}
    self.urls: dict[str, str] = {}
    for url in tool_urls:
        url = f"http://{url}/sse"
        initialize_response, list_tools_response = await list_server_and_tools(url)

        list_tools_response = post_process_tools_description(list_tools_response)

        tool_from_mcp = ToolNamespaceConfig(
            name=initialize_response.serverInfo.name,
            description=initialize_response.instructions,
            tools=[
                ToolDescription.new(
                    name=tool.name,
                    description=tool.description,
                    parameters=tool.inputSchema,
                )
                for tool in list_tools_response.tools
            ],
        )
        self.harmony_tool_descriptions[tool_from_mcp.name] = tool_from_mcp
        if tool_from_mcp.name not in self.urls:
            self.urls[tool_from_mcp.name] = url
        else:
            logger.warning(
                "Tool %s already exists. Ignoring duplicate tool server %s",
                tool_from_mcp.name,
                url,
            )
    logger.info(
        "MCPToolServer initialized with tools: %s",
        list(self.harmony_tool_descriptions.keys()),
    )

get_tool_description 

get_tool_description(tool_name: str)
Source code in vllm/entrypoints/tool_server.py 
150
151
def get_tool_description(self, tool_name: str):
    return self.harmony_tool_descriptions.get(tool_name)

has_tool 

has_tool(tool_name: str)
Source code in vllm/entrypoints/tool_server.py 
147
148
def has_tool(self, tool_name: str):
    return tool_name in self.harmony_tool_descriptions

new_session async 

new_session(
    tool_name: str,
    session_id: str,
    headers: dict[str, str] | None = None,
)
Source code in vllm/entrypoints/tool_server.py 
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
@asynccontextmanager
async def new_session(
    self, tool_name: str, session_id: str, headers: dict[str, str] | None = None
):
    from mcp import ClientSession
    from mcp.client.sse import sse_client

    url = self.urls.get(tool_name)
    request_headers = {"x-session-id": session_id}
    if headers is not None:
        request_headers.update(headers)
    if not url:
        raise KeyError(f"Tool '{tool_name}' is not supported")
    async with (
        sse_client(url=url, headers=request_headers) as streams,
        ClientSession(*streams) as session,
    ):
        await session.initialize()
        yield session

ToolServer

Bases: ABC

Source code in vllm/entrypoints/tool_server.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
class ToolServer(ABC):
    @abstractmethod
    def has_tool(self, tool_name: str) -> bool:
        """
        Return True if the tool is supported, False otherwise.
        """
        pass

    @abstractmethod
    def get_tool_description(self, tool_name: str) -> ToolNamespaceConfig | None:
        """
        Return the tool description for the given tool name.
        If the tool is not supported, return None.
        """
        pass

    @abstractmethod
    def new_session(
        self, tool_name: str, session_id: str, headers: dict[str, str] | None = None
    ) -> AbstractAsyncContextManager[Any]:
        """
        Create a session for the tool.
        """
        ...

get_tool_description abstractmethod 

get_tool_description(
    tool_name: str,
) -> ToolNamespaceConfig | None

Return the tool description for the given tool name. If the tool is not supported, return None.

Source code in vllm/entrypoints/tool_server.py 
82
83
84
85
86
87
88
@abstractmethod
def get_tool_description(self, tool_name: str) -> ToolNamespaceConfig | None:
    """
    Return the tool description for the given tool name.
    If the tool is not supported, return None.
    """
    pass

has_tool abstractmethod 

has_tool(tool_name: str) -> bool

Return True if the tool is supported, False otherwise.

Source code in vllm/entrypoints/tool_server.py 
75
76
77
78
79
80
@abstractmethod
def has_tool(self, tool_name: str) -> bool:
    """
    Return True if the tool is supported, False otherwise.
    """
    pass

new_session abstractmethod 

new_session(
    tool_name: str,
    session_id: str,
    headers: dict[str, str] | None = None,
) -> AbstractAsyncContextManager[Any]

Create a session for the tool.

Source code in vllm/entrypoints/tool_server.py 
90
91
92
93
94
95
96
97
@abstractmethod
def new_session(
    self, tool_name: str, session_id: str, headers: dict[str, str] | None = None
) -> AbstractAsyncContextManager[Any]:
    """
    Create a session for the tool.
    """
    ...

list_server_and_tools async 

list_server_and_tools(server_url: str)
Source code in vllm/entrypoints/tool_server.py 
18
19
20
21
22
23
24
25
26
27
28
async def list_server_and_tools(server_url: str):
    from mcp import ClientSession
    from mcp.client.sse import sse_client

    async with (
        sse_client(url=server_url) as streams,
        ClientSession(*streams) as session,
    ):
        initialize_response = await session.initialize()
        list_tools_response = await session.list_tools()
        return initialize_response, list_tools_response

post_process_tools_description 

post_process_tools_description(
    list_tools_result: ListToolsResult,
) -> ListToolsResult
Source code in vllm/entrypoints/tool_server.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
def post_process_tools_description(
    list_tools_result: "ListToolsResult",
) -> "ListToolsResult":
    # Adapt the MCP tool result for Harmony
    for tool in list_tools_result.tools:
        tool.inputSchema = trim_schema(tool.inputSchema)

    # Some tools schema don't need to be part of the prompt (e.g. simple text
    # in text out for Python)
    list_tools_result.tools = [
        tool
        for tool in list_tools_result.tools
        if getattr(tool.annotations, "include_in_prompt", True)
    ]

    return list_tools_result

trim_schema 

trim_schema(schema: dict) -> dict
Source code in vllm/entrypoints/tool_server.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
def trim_schema(schema: dict) -> dict:
    # Turn JSON Schema from MCP generated into Harmony's variant.
    if "title" in schema:
        del schema["title"]
    if "default" in schema and schema["default"] is None:
        del schema["default"]
    if "anyOf" in schema:
        # Turn "anyOf": [{"type": "type-1"}, {"type": "type-2"}]
        # into "type": ["type-1", "type-2"]
        # if there's more than 1 types, also remove "null" type as Harmony will
        # just ignore it
        types = [
            type_dict["type"]
            for type_dict in schema["anyOf"]
            if type_dict["type"] != "null"
        ]
        schema["type"] = types
        del schema["anyOf"]
    if "properties" in schema:
        schema["properties"] = {
            k: trim_schema(v) for k, v in schema["properties"].items()
        }
    return schema