Spaces:
Running
Running
Jeremiah Lowin commited on
Commit ·
cdb0274
1
Parent(s): e996026
Remove customizable separators; improve resource separator
Browse files- docs/servers/composition.mdx +7 -37
- src/fastmcp/server/server.py +201 -89
- tests/deprecated/__init__.py +0 -0
- tests/{test_deprecated.py → deprecated/test_deprecated.py} +80 -0
- tests/deprecated/test_mount_separators.py +85 -0
- tests/server/test_import_server.py +19 -23
- tests/server/test_mount.py +37 -38
- tests/server/test_openapi.py +1 -23
- tests/server/test_server.py +290 -0
docs/servers/composition.mdx
CHANGED
|
@@ -65,7 +65,7 @@ async def setup():
|
|
| 65 |
|
| 66 |
# Result: main_mcp now contains prefixed components:
|
| 67 |
# - Tool: "weather_get_forecast"
|
| 68 |
-
# - Resource: "
|
| 69 |
|
| 70 |
if __name__ == "__main__":
|
| 71 |
asyncio.run(setup())
|
|
@@ -78,11 +78,11 @@ When you call `await main_mcp.import_server(prefix, subserver)`:
|
|
| 78 |
|
| 79 |
1. **Tools**: All tools from `subserver` are added to `main_mcp` with names prefixed using `{prefix}_`.
|
| 80 |
- `subserver.tool(name="my_tool")` becomes `main_mcp.tool(name="{prefix}_my_tool")`.
|
| 81 |
-
2. **Resources**: All resources are added with URIs prefixed
|
| 82 |
-
- `subserver.resource(uri="data://info")` becomes `main_mcp.resource(uri="
|
| 83 |
3. **Resource Templates**: Templates are prefixed similarly to resources.
|
| 84 |
-
- `subserver.resource(uri="data://{id}")` becomes `main_mcp.resource(uri="
|
| 85 |
-
4. **Prompts**: All prompts are added with names prefixed
|
| 86 |
- `subserver.prompt(name="my_prompt")` becomes `main_mcp.prompt(name="{prefix}_my_prompt")`.
|
| 87 |
|
| 88 |
Note that `import_server` performs a **one-time copy** of components. Changes made to the `subserver` *after* importing **will not** be reflected in `main_mcp`. The `subserver`'s `lifespan` context is also **not** executed by the main server.
|
|
@@ -177,36 +177,6 @@ remote_proxy = FastMCP.as_proxy(Client("http://example.com/mcp"))
|
|
| 177 |
main_server.mount("remote", remote_proxy)
|
| 178 |
```
|
| 179 |
|
| 180 |
-
## Customizing Separators
|
| 181 |
-
|
| 182 |
-
Both `import_server()` and `mount()` allow you to customize the separators used for prefixing components. The defaults are `_` for tools and prompts, and `+` for resources.
|
| 183 |
-
|
| 184 |
-
<CodeGroup>
|
| 185 |
-
|
| 186 |
-
```python import_server
|
| 187 |
-
await main_mcp.import_server(
|
| 188 |
-
prefix="api",
|
| 189 |
-
app=some_subserver,
|
| 190 |
-
tool_separator="_", # Tool name becomes: "api_sub_tool_name"
|
| 191 |
-
resource_separator="+", # Resource URI becomes: "api+data://sub_resource"
|
| 192 |
-
prompt_separator="_" # Prompt name becomes: "api_sub_prompt_name"
|
| 193 |
-
)
|
| 194 |
-
```
|
| 195 |
-
|
| 196 |
-
```python mount
|
| 197 |
-
main_mcp.mount(
|
| 198 |
-
prefix="api",
|
| 199 |
-
app=some_subserver,
|
| 200 |
-
tool_separator="_", # Tool name becomes: "api_sub_tool_name"
|
| 201 |
-
resource_separator="+", # Resource URI becomes: "api+data://sub_resource"
|
| 202 |
-
prompt_separator="_" # Prompt name becomes: "api_sub_prompt_name"
|
| 203 |
-
)
|
| 204 |
-
```
|
| 205 |
-
</CodeGroup>
|
| 206 |
<Warning>
|
| 207 |
-
|
| 208 |
-
</Warning>
|
| 209 |
-
|
| 210 |
-
<Tip>
|
| 211 |
-
To "cleanly" import or mount a server, set the prefix and all separators to `""` (empty string). This is generally unecessary but could save a couple tokens at the risk of a name collision!
|
| 212 |
-
</Tip>
|
|
|
|
| 65 |
|
| 66 |
# Result: main_mcp now contains prefixed components:
|
| 67 |
# - Tool: "weather_get_forecast"
|
| 68 |
+
# - Resource: "data://weather/cities/supported"
|
| 69 |
|
| 70 |
if __name__ == "__main__":
|
| 71 |
asyncio.run(setup())
|
|
|
|
| 78 |
|
| 79 |
1. **Tools**: All tools from `subserver` are added to `main_mcp` with names prefixed using `{prefix}_`.
|
| 80 |
- `subserver.tool(name="my_tool")` becomes `main_mcp.tool(name="{prefix}_my_tool")`.
|
| 81 |
+
2. **Resources**: All resources are added with URIs prefixed in the format `protocol://{prefix}/path`.
|
| 82 |
+
- `subserver.resource(uri="data://info")` becomes `main_mcp.resource(uri="data://{prefix}/info")`.
|
| 83 |
3. **Resource Templates**: Templates are prefixed similarly to resources.
|
| 84 |
+
- `subserver.resource(uri="data://{id}")` becomes `main_mcp.resource(uri="data://{prefix}/{id}")`.
|
| 85 |
+
4. **Prompts**: All prompts are added with names prefixed using `{prefix}_`.
|
| 86 |
- `subserver.prompt(name="my_prompt")` becomes `main_mcp.prompt(name="{prefix}_my_prompt")`.
|
| 87 |
|
| 88 |
Note that `import_server` performs a **one-time copy** of components. Changes made to the `subserver` *after* importing **will not** be reflected in `main_mcp`. The `subserver`'s `lifespan` context is also **not** executed by the main server.
|
|
|
|
| 177 |
main_server.mount("remote", remote_proxy)
|
| 178 |
```
|
| 179 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 180 |
<Warning>
|
| 181 |
+
Some MCP clients (like Claude Desktop) might have restrictions on characters allowed in tool names. FastMCP uses standard naming conventions: tools and prompts are prefixed with `{prefix}_` (e.g., "weather_forecast"), and resources use the format `protocol://{prefix}/path` (e.g., "data://weather/forecast").
|
| 182 |
+
</Warning>
|
|
|
|
|
|
|
|
|
|
|
|
src/fastmcp/server/server.py
CHANGED
|
@@ -3,6 +3,7 @@
|
|
| 3 |
from __future__ import annotations
|
| 4 |
|
| 5 |
import datetime
|
|
|
|
| 6 |
import warnings
|
| 7 |
from collections.abc import AsyncIterator, Awaitable, Callable
|
| 8 |
from contextlib import (
|
|
@@ -16,7 +17,6 @@ from typing import TYPE_CHECKING, Any, Generic, Literal
|
|
| 16 |
|
| 17 |
import anyio
|
| 18 |
import httpx
|
| 19 |
-
import pydantic
|
| 20 |
import uvicorn
|
| 21 |
from mcp.server.auth.provider import OAuthAuthorizationServerProvider
|
| 22 |
from mcp.server.lowlevel.helper_types import ReadResourceContents
|
|
@@ -935,10 +935,11 @@ class FastMCP(Generic[LifespanResultT]):
|
|
| 935 |
self,
|
| 936 |
prefix: str,
|
| 937 |
server: FastMCP[LifespanResultT],
|
|
|
|
|
|
|
| 938 |
tool_separator: str | None = None,
|
| 939 |
resource_separator: str | None = None,
|
| 940 |
prompt_separator: str | None = None,
|
| 941 |
-
as_proxy: bool | None = None,
|
| 942 |
) -> None:
|
| 943 |
"""Mount another FastMCP server on this server with the given prefix.
|
| 944 |
|
|
@@ -949,15 +950,15 @@ class FastMCP(Generic[LifespanResultT]):
|
|
| 949 |
through the parent.
|
| 950 |
|
| 951 |
When a server is mounted:
|
| 952 |
-
- Tools from the mounted server are accessible with prefixed names
|
| 953 |
Example: If server has a tool named "get_weather", it will be available as "prefix_get_weather".
|
| 954 |
-
- Resources are accessible with prefixed URIs
|
| 955 |
Example: If server has a resource with URI "weather://forecast", it will be available as
|
| 956 |
-
"
|
| 957 |
-
- Templates are accessible with prefixed URI templates
|
| 958 |
Example: If server has a template with URI "weather://location/{id}", it will be available
|
| 959 |
-
as "
|
| 960 |
-
- Prompts are accessible with prefixed names
|
| 961 |
Example: If server has a prompt named "weather_prompt", it will be available as
|
| 962 |
"prefix_weather_prompt".
|
| 963 |
|
|
@@ -975,17 +976,41 @@ class FastMCP(Generic[LifespanResultT]):
|
|
| 975 |
Args:
|
| 976 |
prefix: Prefix to use for the mounted server's objects.
|
| 977 |
server: The FastMCP server to mount.
|
| 978 |
-
tool_separator: Separator character for tool names (defaults to "_").
|
| 979 |
-
resource_separator: Separator character for resource URIs (defaults to "+").
|
| 980 |
-
prompt_separator: Separator character for prompt names (defaults to "_").
|
| 981 |
as_proxy: Whether to treat the mounted server as a proxy. If None (default),
|
| 982 |
automatically determined based on whether the server has a custom lifespan
|
| 983 |
(True if it has a custom lifespan, False otherwise).
|
|
|
|
|
|
|
|
|
|
| 984 |
"""
|
| 985 |
from fastmcp import Client
|
| 986 |
from fastmcp.client.transports import FastMCPTransport
|
| 987 |
from fastmcp.server.proxy import FastMCPProxy
|
| 988 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 989 |
# if as_proxy is not specified and the server has a custom lifespan,
|
| 990 |
# we should treat it as a proxy
|
| 991 |
if as_proxy is None:
|
|
@@ -997,9 +1022,6 @@ class FastMCP(Generic[LifespanResultT]):
|
|
| 997 |
mounted_server = MountedServer(
|
| 998 |
server=server,
|
| 999 |
prefix=prefix,
|
| 1000 |
-
tool_separator=tool_separator,
|
| 1001 |
-
resource_separator=resource_separator,
|
| 1002 |
-
prompt_separator=prompt_separator,
|
| 1003 |
)
|
| 1004 |
self._mounted_servers[prefix] = mounted_server
|
| 1005 |
self._cache.clear()
|
|
@@ -1025,57 +1047,74 @@ class FastMCP(Generic[LifespanResultT]):
|
|
| 1025 |
future changes to the imported server will not be reflected in the
|
| 1026 |
importing server. Server-level configurations and lifespans are not imported.
|
| 1027 |
|
| 1028 |
-
When a server is
|
| 1029 |
-
|
| 1030 |
Example: If server has a tool named "get_weather", it will be
|
| 1031 |
-
available as "
|
| 1032 |
-
- The resources are imported with prefixed URIs using the
|
| 1033 |
-
|
| 1034 |
-
"weather://forecast"
|
| 1035 |
-
|
| 1036 |
-
|
| 1037 |
-
|
| 1038 |
-
|
| 1039 |
-
|
| 1040 |
-
|
| 1041 |
-
prompt_separator Example: If server has a prompt named
|
| 1042 |
-
"weather_prompt", it will be available as "weather_weather_prompt"
|
| 1043 |
|
| 1044 |
Args:
|
| 1045 |
-
prefix: The prefix to use for the
|
| 1046 |
-
server
|
| 1047 |
-
|
| 1048 |
-
|
|
|
|
|
|
|
| 1049 |
"""
|
| 1050 |
-
if tool_separator is None:
|
| 1051 |
-
|
| 1052 |
-
|
| 1053 |
-
|
| 1054 |
-
|
| 1055 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1056 |
|
| 1057 |
# Import tools from the mounted server
|
| 1058 |
-
tool_prefix = f"{prefix}
|
| 1059 |
for key, tool in (await server.get_tools()).items():
|
| 1060 |
self._tool_manager.add_tool(tool, key=f"{tool_prefix}{key}")
|
| 1061 |
|
| 1062 |
# Import resources and templates from the mounted server
|
| 1063 |
-
resource_prefix = f"{prefix}{resource_separator}"
|
| 1064 |
-
_validate_resource_prefix(resource_prefix)
|
| 1065 |
for key, resource in (await server.get_resources()).items():
|
| 1066 |
-
|
|
|
|
|
|
|
| 1067 |
for key, template in (await server.get_resource_templates()).items():
|
| 1068 |
-
|
|
|
|
| 1069 |
|
| 1070 |
# Import prompts from the mounted server
|
| 1071 |
-
prompt_prefix = f"{prefix}
|
| 1072 |
for key, prompt in (await server.get_prompts()).items():
|
| 1073 |
self._prompt_manager.add_prompt(prompt, key=f"{prompt_prefix}{key}")
|
| 1074 |
|
| 1075 |
logger.info(f"Imported server {server.name} with prefix '{prefix}'")
|
| 1076 |
logger.debug(f"Imported tools with prefix '{tool_prefix}'")
|
| 1077 |
-
logger.debug(f"Imported resources with prefix '{
|
| 1078 |
-
logger.debug(f"Imported templates with prefix '{resource_prefix}'")
|
| 1079 |
logger.debug(f"Imported prompts with prefix '{prompt_prefix}'")
|
| 1080 |
|
| 1081 |
self._cache.clear()
|
|
@@ -1194,84 +1233,157 @@ class FastMCP(Generic[LifespanResultT]):
|
|
| 1194 |
return cls.as_proxy(client, **settings)
|
| 1195 |
|
| 1196 |
|
| 1197 |
-
def _validate_resource_prefix(prefix: str) -> None:
|
| 1198 |
-
valid_resource = "resource://path/to/resource"
|
| 1199 |
-
test_case = f"{prefix}{valid_resource}"
|
| 1200 |
-
try:
|
| 1201 |
-
AnyUrl(test_case)
|
| 1202 |
-
except pydantic.ValidationError as e:
|
| 1203 |
-
raise ValueError(
|
| 1204 |
-
"Resource prefix or separator would result in an "
|
| 1205 |
-
f"invalid resource URI (test case was {test_case!r}): {e}"
|
| 1206 |
-
)
|
| 1207 |
-
|
| 1208 |
-
|
| 1209 |
class MountedServer:
|
| 1210 |
def __init__(
|
| 1211 |
self,
|
| 1212 |
prefix: str,
|
| 1213 |
server: FastMCP[LifespanResultT],
|
| 1214 |
-
tool_separator: str | None = None,
|
| 1215 |
-
resource_separator: str | None = None,
|
| 1216 |
-
prompt_separator: str | None = None,
|
| 1217 |
):
|
| 1218 |
-
if tool_separator is None:
|
| 1219 |
-
tool_separator = "_"
|
| 1220 |
-
if resource_separator is None:
|
| 1221 |
-
resource_separator = "+"
|
| 1222 |
-
if prompt_separator is None:
|
| 1223 |
-
prompt_separator = "_"
|
| 1224 |
-
|
| 1225 |
-
_validate_resource_prefix(f"{prefix}{resource_separator}")
|
| 1226 |
-
|
| 1227 |
self.server = server
|
| 1228 |
self.prefix = prefix
|
| 1229 |
-
self.tool_separator = tool_separator
|
| 1230 |
-
self.resource_separator = resource_separator
|
| 1231 |
-
self.prompt_separator = prompt_separator
|
| 1232 |
|
| 1233 |
async def get_tools(self) -> dict[str, Tool]:
|
| 1234 |
tools = await self.server.get_tools()
|
| 1235 |
-
return {
|
| 1236 |
-
f"{self.prefix}{self.tool_separator}{key}": tool
|
| 1237 |
-
for key, tool in tools.items()
|
| 1238 |
-
}
|
| 1239 |
|
| 1240 |
async def get_resources(self) -> dict[str, Resource]:
|
| 1241 |
resources = await self.server.get_resources()
|
| 1242 |
return {
|
| 1243 |
-
|
| 1244 |
for key, resource in resources.items()
|
| 1245 |
}
|
| 1246 |
|
| 1247 |
async def get_resource_templates(self) -> dict[str, ResourceTemplate]:
|
| 1248 |
templates = await self.server.get_resource_templates()
|
| 1249 |
return {
|
| 1250 |
-
|
| 1251 |
for key, template in templates.items()
|
| 1252 |
}
|
| 1253 |
|
| 1254 |
async def get_prompts(self) -> dict[str, Prompt]:
|
| 1255 |
prompts = await self.server.get_prompts()
|
| 1256 |
-
return {
|
| 1257 |
-
f"{self.prefix}{self.prompt_separator}{key}": prompt
|
| 1258 |
-
for key, prompt in prompts.items()
|
| 1259 |
-
}
|
| 1260 |
|
| 1261 |
def match_tool(self, key: str) -> bool:
|
| 1262 |
-
return key.startswith(f"{self.prefix}
|
| 1263 |
|
| 1264 |
def strip_tool_prefix(self, key: str) -> str:
|
| 1265 |
-
return key.removeprefix(f"{self.prefix}
|
| 1266 |
|
| 1267 |
def match_resource(self, key: str) -> bool:
|
| 1268 |
-
return
|
| 1269 |
|
| 1270 |
def strip_resource_prefix(self, key: str) -> str:
|
| 1271 |
-
return
|
| 1272 |
|
| 1273 |
def match_prompt(self, key: str) -> bool:
|
| 1274 |
-
return key.startswith(f"{self.prefix}
|
| 1275 |
|
| 1276 |
def strip_prompt_prefix(self, key: str) -> str:
|
| 1277 |
-
return key.removeprefix(f"{self.prefix}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
from __future__ import annotations
|
| 4 |
|
| 5 |
import datetime
|
| 6 |
+
import re
|
| 7 |
import warnings
|
| 8 |
from collections.abc import AsyncIterator, Awaitable, Callable
|
| 9 |
from contextlib import (
|
|
|
|
| 17 |
|
| 18 |
import anyio
|
| 19 |
import httpx
|
|
|
|
| 20 |
import uvicorn
|
| 21 |
from mcp.server.auth.provider import OAuthAuthorizationServerProvider
|
| 22 |
from mcp.server.lowlevel.helper_types import ReadResourceContents
|
|
|
|
| 935 |
self,
|
| 936 |
prefix: str,
|
| 937 |
server: FastMCP[LifespanResultT],
|
| 938 |
+
as_proxy: bool | None = None,
|
| 939 |
+
*,
|
| 940 |
tool_separator: str | None = None,
|
| 941 |
resource_separator: str | None = None,
|
| 942 |
prompt_separator: str | None = None,
|
|
|
|
| 943 |
) -> None:
|
| 944 |
"""Mount another FastMCP server on this server with the given prefix.
|
| 945 |
|
|
|
|
| 950 |
through the parent.
|
| 951 |
|
| 952 |
When a server is mounted:
|
| 953 |
+
- Tools from the mounted server are accessible with prefixed names.
|
| 954 |
Example: If server has a tool named "get_weather", it will be available as "prefix_get_weather".
|
| 955 |
+
- Resources are accessible with prefixed URIs.
|
| 956 |
Example: If server has a resource with URI "weather://forecast", it will be available as
|
| 957 |
+
"weather://prefix/forecast".
|
| 958 |
+
- Templates are accessible with prefixed URI templates.
|
| 959 |
Example: If server has a template with URI "weather://location/{id}", it will be available
|
| 960 |
+
as "weather://prefix/location/{id}".
|
| 961 |
+
- Prompts are accessible with prefixed names.
|
| 962 |
Example: If server has a prompt named "weather_prompt", it will be available as
|
| 963 |
"prefix_weather_prompt".
|
| 964 |
|
|
|
|
| 976 |
Args:
|
| 977 |
prefix: Prefix to use for the mounted server's objects.
|
| 978 |
server: The FastMCP server to mount.
|
|
|
|
|
|
|
|
|
|
| 979 |
as_proxy: Whether to treat the mounted server as a proxy. If None (default),
|
| 980 |
automatically determined based on whether the server has a custom lifespan
|
| 981 |
(True if it has a custom lifespan, False otherwise).
|
| 982 |
+
tool_separator: Deprecated. Separator character for tool names.
|
| 983 |
+
resource_separator: Deprecated. Separator character for resource URIs.
|
| 984 |
+
prompt_separator: Deprecated. Separator character for prompt names.
|
| 985 |
"""
|
| 986 |
from fastmcp import Client
|
| 987 |
from fastmcp.client.transports import FastMCPTransport
|
| 988 |
from fastmcp.server.proxy import FastMCPProxy
|
| 989 |
|
| 990 |
+
if tool_separator is not None:
|
| 991 |
+
warnings.warn(
|
| 992 |
+
"The tool_separator parameter is deprecated and will be removed in a future version. "
|
| 993 |
+
"Tools are now prefixed using 'prefix_toolname' format.",
|
| 994 |
+
DeprecationWarning,
|
| 995 |
+
stacklevel=2,
|
| 996 |
+
)
|
| 997 |
+
|
| 998 |
+
if resource_separator is not None:
|
| 999 |
+
warnings.warn(
|
| 1000 |
+
"The resource_separator parameter is deprecated and ignored. "
|
| 1001 |
+
"Resource prefixes are now added using the protocol://prefix/path format.",
|
| 1002 |
+
DeprecationWarning,
|
| 1003 |
+
stacklevel=2,
|
| 1004 |
+
)
|
| 1005 |
+
|
| 1006 |
+
if prompt_separator is not None:
|
| 1007 |
+
warnings.warn(
|
| 1008 |
+
"The prompt_separator parameter is deprecated and will be removed in a future version. "
|
| 1009 |
+
"Prompts are now prefixed using 'prefix_promptname' format.",
|
| 1010 |
+
DeprecationWarning,
|
| 1011 |
+
stacklevel=2,
|
| 1012 |
+
)
|
| 1013 |
+
|
| 1014 |
# if as_proxy is not specified and the server has a custom lifespan,
|
| 1015 |
# we should treat it as a proxy
|
| 1016 |
if as_proxy is None:
|
|
|
|
| 1022 |
mounted_server = MountedServer(
|
| 1023 |
server=server,
|
| 1024 |
prefix=prefix,
|
|
|
|
|
|
|
|
|
|
| 1025 |
)
|
| 1026 |
self._mounted_servers[prefix] = mounted_server
|
| 1027 |
self._cache.clear()
|
|
|
|
| 1047 |
future changes to the imported server will not be reflected in the
|
| 1048 |
importing server. Server-level configurations and lifespans are not imported.
|
| 1049 |
|
| 1050 |
+
When a server is imported:
|
| 1051 |
+
- The tools are imported with prefixed names
|
| 1052 |
Example: If server has a tool named "get_weather", it will be
|
| 1053 |
+
available as "prefix_get_weather"
|
| 1054 |
+
- The resources are imported with prefixed URIs using the new format
|
| 1055 |
+
Example: If server has a resource with URI "weather://forecast", it will
|
| 1056 |
+
be available as "weather://prefix/forecast"
|
| 1057 |
+
- The templates are imported with prefixed URI templates using the new format
|
| 1058 |
+
Example: If server has a template with URI "weather://location/{id}", it will
|
| 1059 |
+
be available as "weather://prefix/location/{id}"
|
| 1060 |
+
- The prompts are imported with prefixed names
|
| 1061 |
+
Example: If server has a prompt named "weather_prompt", it will be available as
|
| 1062 |
+
"prefix_weather_prompt"
|
|
|
|
|
|
|
| 1063 |
|
| 1064 |
Args:
|
| 1065 |
+
prefix: The prefix to use for the imported server
|
| 1066 |
+
server: The FastMCP server to import
|
| 1067 |
+
tool_separator: Deprecated. Separator for tool names.
|
| 1068 |
+
resource_separator: Deprecated and ignored. Prefix is now
|
| 1069 |
+
applied using the protocol://prefix/path format
|
| 1070 |
+
prompt_separator: Deprecated. Separator for prompt names.
|
| 1071 |
"""
|
| 1072 |
+
if tool_separator is not None:
|
| 1073 |
+
warnings.warn(
|
| 1074 |
+
"The tool_separator parameter is deprecated and will be removed in a future version. "
|
| 1075 |
+
"Tools are now prefixed using 'prefix_toolname' format.",
|
| 1076 |
+
DeprecationWarning,
|
| 1077 |
+
stacklevel=2,
|
| 1078 |
+
)
|
| 1079 |
+
|
| 1080 |
+
if resource_separator is not None:
|
| 1081 |
+
warnings.warn(
|
| 1082 |
+
"The resource_separator parameter is deprecated and ignored. "
|
| 1083 |
+
"Resource prefixes are now added using the protocol://prefix/path format.",
|
| 1084 |
+
DeprecationWarning,
|
| 1085 |
+
stacklevel=2,
|
| 1086 |
+
)
|
| 1087 |
+
|
| 1088 |
+
if prompt_separator is not None:
|
| 1089 |
+
warnings.warn(
|
| 1090 |
+
"The prompt_separator parameter is deprecated and will be removed in a future version. "
|
| 1091 |
+
"Prompts are now prefixed using 'prefix_promptname' format.",
|
| 1092 |
+
DeprecationWarning,
|
| 1093 |
+
stacklevel=2,
|
| 1094 |
+
)
|
| 1095 |
|
| 1096 |
# Import tools from the mounted server
|
| 1097 |
+
tool_prefix = f"{prefix}_"
|
| 1098 |
for key, tool in (await server.get_tools()).items():
|
| 1099 |
self._tool_manager.add_tool(tool, key=f"{tool_prefix}{key}")
|
| 1100 |
|
| 1101 |
# Import resources and templates from the mounted server
|
|
|
|
|
|
|
| 1102 |
for key, resource in (await server.get_resources()).items():
|
| 1103 |
+
prefixed_key = add_resource_prefix(key, prefix)
|
| 1104 |
+
self._resource_manager.add_resource(resource, key=prefixed_key)
|
| 1105 |
+
|
| 1106 |
for key, template in (await server.get_resource_templates()).items():
|
| 1107 |
+
prefixed_key = add_resource_prefix(key, prefix)
|
| 1108 |
+
self._resource_manager.add_template(template, key=prefixed_key)
|
| 1109 |
|
| 1110 |
# Import prompts from the mounted server
|
| 1111 |
+
prompt_prefix = f"{prefix}_"
|
| 1112 |
for key, prompt in (await server.get_prompts()).items():
|
| 1113 |
self._prompt_manager.add_prompt(prompt, key=f"{prompt_prefix}{key}")
|
| 1114 |
|
| 1115 |
logger.info(f"Imported server {server.name} with prefix '{prefix}'")
|
| 1116 |
logger.debug(f"Imported tools with prefix '{tool_prefix}'")
|
| 1117 |
+
logger.debug(f"Imported resources and templates with prefix '{prefix}/'")
|
|
|
|
| 1118 |
logger.debug(f"Imported prompts with prefix '{prompt_prefix}'")
|
| 1119 |
|
| 1120 |
self._cache.clear()
|
|
|
|
| 1233 |
return cls.as_proxy(client, **settings)
|
| 1234 |
|
| 1235 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1236 |
class MountedServer:
|
| 1237 |
def __init__(
|
| 1238 |
self,
|
| 1239 |
prefix: str,
|
| 1240 |
server: FastMCP[LifespanResultT],
|
|
|
|
|
|
|
|
|
|
| 1241 |
):
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1242 |
self.server = server
|
| 1243 |
self.prefix = prefix
|
|
|
|
|
|
|
|
|
|
| 1244 |
|
| 1245 |
async def get_tools(self) -> dict[str, Tool]:
|
| 1246 |
tools = await self.server.get_tools()
|
| 1247 |
+
return {f"{self.prefix}_{key}": tool for key, tool in tools.items()}
|
|
|
|
|
|
|
|
|
|
| 1248 |
|
| 1249 |
async def get_resources(self) -> dict[str, Resource]:
|
| 1250 |
resources = await self.server.get_resources()
|
| 1251 |
return {
|
| 1252 |
+
add_resource_prefix(key, self.prefix): resource
|
| 1253 |
for key, resource in resources.items()
|
| 1254 |
}
|
| 1255 |
|
| 1256 |
async def get_resource_templates(self) -> dict[str, ResourceTemplate]:
|
| 1257 |
templates = await self.server.get_resource_templates()
|
| 1258 |
return {
|
| 1259 |
+
add_resource_prefix(key, self.prefix): template
|
| 1260 |
for key, template in templates.items()
|
| 1261 |
}
|
| 1262 |
|
| 1263 |
async def get_prompts(self) -> dict[str, Prompt]:
|
| 1264 |
prompts = await self.server.get_prompts()
|
| 1265 |
+
return {f"{self.prefix}_{key}": prompt for key, prompt in prompts.items()}
|
|
|
|
|
|
|
|
|
|
| 1266 |
|
| 1267 |
def match_tool(self, key: str) -> bool:
|
| 1268 |
+
return key.startswith(f"{self.prefix}_")
|
| 1269 |
|
| 1270 |
def strip_tool_prefix(self, key: str) -> str:
|
| 1271 |
+
return key.removeprefix(f"{self.prefix}_")
|
| 1272 |
|
| 1273 |
def match_resource(self, key: str) -> bool:
|
| 1274 |
+
return has_resource_prefix(key, self.prefix)
|
| 1275 |
|
| 1276 |
def strip_resource_prefix(self, key: str) -> str:
|
| 1277 |
+
return remove_resource_prefix(key, self.prefix)
|
| 1278 |
|
| 1279 |
def match_prompt(self, key: str) -> bool:
|
| 1280 |
+
return key.startswith(f"{self.prefix}_")
|
| 1281 |
|
| 1282 |
def strip_prompt_prefix(self, key: str) -> str:
|
| 1283 |
+
return key.removeprefix(f"{self.prefix}_")
|
| 1284 |
+
|
| 1285 |
+
|
| 1286 |
+
def add_resource_prefix(uri: str, prefix: str) -> str:
|
| 1287 |
+
"""Add a prefix to a resource URI.
|
| 1288 |
+
|
| 1289 |
+
Args:
|
| 1290 |
+
uri: The original resource URI
|
| 1291 |
+
prefix: The prefix to add
|
| 1292 |
+
|
| 1293 |
+
Returns:
|
| 1294 |
+
The resource URI with the prefix added
|
| 1295 |
+
|
| 1296 |
+
Examples:
|
| 1297 |
+
>>> add_resource_prefix("resource://path/to/resource", "prefix")
|
| 1298 |
+
"resource://prefix/path/to/resource"
|
| 1299 |
+
>>> add_resource_prefix("resource:///absolute/path", "prefix")
|
| 1300 |
+
"resource://prefix//absolute/path"
|
| 1301 |
+
|
| 1302 |
+
Raises:
|
| 1303 |
+
ValueError: If the URI doesn't match the expected protocol://path format
|
| 1304 |
+
"""
|
| 1305 |
+
if not prefix:
|
| 1306 |
+
return uri
|
| 1307 |
+
|
| 1308 |
+
# Split the URI into protocol and path
|
| 1309 |
+
match = re.match(r"^([^:]+://)(.*?)$", uri)
|
| 1310 |
+
if not match:
|
| 1311 |
+
raise ValueError(f"Invalid URI format: {uri}. Expected protocol://path format.")
|
| 1312 |
+
|
| 1313 |
+
protocol, path = match.groups()
|
| 1314 |
+
|
| 1315 |
+
# Add the prefix to the path
|
| 1316 |
+
return f"{protocol}{prefix}/{path}"
|
| 1317 |
+
|
| 1318 |
+
|
| 1319 |
+
def remove_resource_prefix(uri: str, prefix: str) -> str:
|
| 1320 |
+
"""Remove a prefix from a resource URI.
|
| 1321 |
+
|
| 1322 |
+
Args:
|
| 1323 |
+
uri: The resource URI with a prefix
|
| 1324 |
+
prefix: The prefix to remove
|
| 1325 |
+
|
| 1326 |
+
Returns:
|
| 1327 |
+
The resource URI with the prefix removed
|
| 1328 |
+
|
| 1329 |
+
Examples:
|
| 1330 |
+
>>> remove_resource_prefix("resource://prefix/path/to/resource", "prefix")
|
| 1331 |
+
"resource://path/to/resource"
|
| 1332 |
+
>>> remove_resource_prefix("resource://prefix//absolute/path", "prefix")
|
| 1333 |
+
"resource:///absolute/path"
|
| 1334 |
+
|
| 1335 |
+
Raises:
|
| 1336 |
+
ValueError: If the URI doesn't match the expected protocol://path format
|
| 1337 |
+
"""
|
| 1338 |
+
if not prefix:
|
| 1339 |
+
return uri
|
| 1340 |
+
|
| 1341 |
+
# Split the URI into protocol and path
|
| 1342 |
+
match = re.match(r"^([^:]+://)(.*?)$", uri)
|
| 1343 |
+
if not match:
|
| 1344 |
+
raise ValueError(f"Invalid URI format: {uri}. Expected protocol://path format.")
|
| 1345 |
+
|
| 1346 |
+
protocol, path = match.groups()
|
| 1347 |
+
|
| 1348 |
+
# Check if the path starts with the prefix followed by a /
|
| 1349 |
+
prefix_pattern = f"^{re.escape(prefix)}/(.*?)$"
|
| 1350 |
+
path_match = re.match(prefix_pattern, path)
|
| 1351 |
+
if not path_match:
|
| 1352 |
+
return uri
|
| 1353 |
+
|
| 1354 |
+
# Return the URI without the prefix
|
| 1355 |
+
return f"{protocol}{path_match.group(1)}"
|
| 1356 |
+
|
| 1357 |
+
|
| 1358 |
+
def has_resource_prefix(uri: str, prefix: str) -> bool:
|
| 1359 |
+
"""Check if a resource URI has a specific prefix.
|
| 1360 |
+
|
| 1361 |
+
Args:
|
| 1362 |
+
uri: The resource URI to check
|
| 1363 |
+
prefix: The prefix to look for
|
| 1364 |
+
|
| 1365 |
+
Returns:
|
| 1366 |
+
True if the URI has the specified prefix, False otherwise
|
| 1367 |
+
|
| 1368 |
+
Examples:
|
| 1369 |
+
>>> has_resource_prefix("resource://prefix/path/to/resource", "prefix")
|
| 1370 |
+
True
|
| 1371 |
+
>>> has_resource_prefix("resource://other/path/to/resource", "prefix")
|
| 1372 |
+
False
|
| 1373 |
+
|
| 1374 |
+
Raises:
|
| 1375 |
+
ValueError: If the URI doesn't match the expected protocol://path format
|
| 1376 |
+
"""
|
| 1377 |
+
if not prefix:
|
| 1378 |
+
return False
|
| 1379 |
+
|
| 1380 |
+
# Split the URI into protocol and path
|
| 1381 |
+
match = re.match(r"^([^:]+://)(.*?)$", uri)
|
| 1382 |
+
if not match:
|
| 1383 |
+
raise ValueError(f"Invalid URI format: {uri}. Expected protocol://path format.")
|
| 1384 |
+
|
| 1385 |
+
_, path = match.groups()
|
| 1386 |
+
|
| 1387 |
+
# Check if the path starts with the prefix followed by a /
|
| 1388 |
+
prefix_pattern = f"^{re.escape(prefix)}/"
|
| 1389 |
+
return bool(re.match(prefix_pattern, path))
|
tests/deprecated/__init__.py
ADDED
|
File without changes
|
tests/{test_deprecated.py → deprecated/test_deprecated.py}
RENAMED
|
@@ -96,3 +96,83 @@ def test_from_client_deprecation_warning():
|
|
| 96 |
server = FastMCP("TestServer")
|
| 97 |
with pytest.warns(DeprecationWarning, match="from_client"):
|
| 98 |
FastMCP.from_client(Client(server))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 96 |
server = FastMCP("TestServer")
|
| 97 |
with pytest.warns(DeprecationWarning, match="from_client"):
|
| 98 |
FastMCP.from_client(Client(server))
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
def test_mount_tool_separator_deprecation_warning():
|
| 102 |
+
"""Test that using tool_separator in mount() raises a deprecation warning."""
|
| 103 |
+
main_app = FastMCP("MainApp")
|
| 104 |
+
sub_app = FastMCP("SubApp")
|
| 105 |
+
|
| 106 |
+
with pytest.warns(
|
| 107 |
+
DeprecationWarning,
|
| 108 |
+
match="The tool_separator parameter is deprecated and will be removed in a future version",
|
| 109 |
+
):
|
| 110 |
+
main_app.mount("sub", sub_app, tool_separator="-")
|
| 111 |
+
|
| 112 |
+
# Verify the separator is ignored and the default is used
|
| 113 |
+
@sub_app.tool()
|
| 114 |
+
def test_tool():
|
| 115 |
+
return "test"
|
| 116 |
+
|
| 117 |
+
mounted_server = main_app._mounted_servers["sub"]
|
| 118 |
+
assert mounted_server.match_tool("sub_test_tool")
|
| 119 |
+
assert not mounted_server.match_tool("sub-test_tool")
|
| 120 |
+
|
| 121 |
+
|
| 122 |
+
def test_mount_resource_separator_deprecation_warning():
|
| 123 |
+
"""Test that using resource_separator in mount() raises a deprecation warning."""
|
| 124 |
+
main_app = FastMCP("MainApp")
|
| 125 |
+
sub_app = FastMCP("SubApp")
|
| 126 |
+
|
| 127 |
+
with pytest.warns(
|
| 128 |
+
DeprecationWarning,
|
| 129 |
+
match="The resource_separator parameter is deprecated and ignored",
|
| 130 |
+
):
|
| 131 |
+
main_app.mount("sub", sub_app, resource_separator="+")
|
| 132 |
+
|
| 133 |
+
|
| 134 |
+
def test_mount_prompt_separator_deprecation_warning():
|
| 135 |
+
"""Test that using prompt_separator in mount() raises a deprecation warning."""
|
| 136 |
+
main_app = FastMCP("MainApp")
|
| 137 |
+
sub_app = FastMCP("SubApp")
|
| 138 |
+
|
| 139 |
+
with pytest.warns(
|
| 140 |
+
DeprecationWarning,
|
| 141 |
+
match="The prompt_separator parameter is deprecated and will be removed in a future version",
|
| 142 |
+
):
|
| 143 |
+
main_app.mount("sub", sub_app, prompt_separator="-")
|
| 144 |
+
|
| 145 |
+
# Verify the separator is ignored and the default is used
|
| 146 |
+
@sub_app.prompt()
|
| 147 |
+
def test_prompt():
|
| 148 |
+
return "test"
|
| 149 |
+
|
| 150 |
+
mounted_server = main_app._mounted_servers["sub"]
|
| 151 |
+
assert mounted_server.match_prompt("sub_test_prompt")
|
| 152 |
+
assert not mounted_server.match_prompt("sub-test_prompt")
|
| 153 |
+
|
| 154 |
+
|
| 155 |
+
async def test_import_server_separator_deprecation_warnings():
|
| 156 |
+
"""Test that using separators in import_server() raises deprecation warnings."""
|
| 157 |
+
main_app = FastMCP("MainApp")
|
| 158 |
+
sub_app = FastMCP("SubApp")
|
| 159 |
+
|
| 160 |
+
with pytest.warns(
|
| 161 |
+
DeprecationWarning,
|
| 162 |
+
match="The tool_separator parameter is deprecated and will be removed in a future version",
|
| 163 |
+
):
|
| 164 |
+
await main_app.import_server("sub", sub_app, tool_separator="-")
|
| 165 |
+
|
| 166 |
+
main_app = FastMCP("MainApp")
|
| 167 |
+
with pytest.warns(
|
| 168 |
+
DeprecationWarning,
|
| 169 |
+
match="The resource_separator parameter is deprecated and ignored",
|
| 170 |
+
):
|
| 171 |
+
await main_app.import_server("sub", sub_app, resource_separator="+")
|
| 172 |
+
|
| 173 |
+
main_app = FastMCP("MainApp")
|
| 174 |
+
with pytest.warns(
|
| 175 |
+
DeprecationWarning,
|
| 176 |
+
match="The prompt_separator parameter is deprecated and will be removed in a future version",
|
| 177 |
+
):
|
| 178 |
+
await main_app.import_server("sub", sub_app, prompt_separator="-")
|
tests/deprecated/test_mount_separators.py
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
"""Tests for the deprecated separator parameters in mount() and import_server() methods."""
|
| 2 |
+
|
| 3 |
+
import pytest
|
| 4 |
+
|
| 5 |
+
from fastmcp import FastMCP
|
| 6 |
+
|
| 7 |
+
|
| 8 |
+
def test_mount_tool_separator_deprecation_warning():
|
| 9 |
+
"""Test that using tool_separator in mount() raises a deprecation warning."""
|
| 10 |
+
main_app = FastMCP("MainApp")
|
| 11 |
+
sub_app = FastMCP("SubApp")
|
| 12 |
+
|
| 13 |
+
with pytest.warns(
|
| 14 |
+
DeprecationWarning,
|
| 15 |
+
match="The tool_separator parameter is deprecated and will be removed in a future version",
|
| 16 |
+
):
|
| 17 |
+
main_app.mount("sub", sub_app, tool_separator="-")
|
| 18 |
+
|
| 19 |
+
# Verify the separator is ignored and the default is used
|
| 20 |
+
@sub_app.tool()
|
| 21 |
+
def test_tool():
|
| 22 |
+
return "test"
|
| 23 |
+
|
| 24 |
+
mounted_server = main_app._mounted_servers["sub"]
|
| 25 |
+
assert mounted_server.match_tool("sub_test_tool")
|
| 26 |
+
assert not mounted_server.match_tool("sub-test_tool")
|
| 27 |
+
|
| 28 |
+
|
| 29 |
+
def test_mount_resource_separator_deprecation_warning():
|
| 30 |
+
"""Test that using resource_separator in mount() raises a deprecation warning."""
|
| 31 |
+
main_app = FastMCP("MainApp")
|
| 32 |
+
sub_app = FastMCP("SubApp")
|
| 33 |
+
|
| 34 |
+
with pytest.warns(
|
| 35 |
+
DeprecationWarning,
|
| 36 |
+
match="The resource_separator parameter is deprecated and ignored",
|
| 37 |
+
):
|
| 38 |
+
main_app.mount("sub", sub_app, resource_separator="+")
|
| 39 |
+
|
| 40 |
+
|
| 41 |
+
def test_mount_prompt_separator_deprecation_warning():
|
| 42 |
+
"""Test that using prompt_separator in mount() raises a deprecation warning."""
|
| 43 |
+
main_app = FastMCP("MainApp")
|
| 44 |
+
sub_app = FastMCP("SubApp")
|
| 45 |
+
|
| 46 |
+
with pytest.warns(
|
| 47 |
+
DeprecationWarning,
|
| 48 |
+
match="The prompt_separator parameter is deprecated and will be removed in a future version",
|
| 49 |
+
):
|
| 50 |
+
main_app.mount("sub", sub_app, prompt_separator="-")
|
| 51 |
+
|
| 52 |
+
# Verify the separator is ignored and the default is used
|
| 53 |
+
@sub_app.prompt()
|
| 54 |
+
def test_prompt():
|
| 55 |
+
return "test"
|
| 56 |
+
|
| 57 |
+
mounted_server = main_app._mounted_servers["sub"]
|
| 58 |
+
assert mounted_server.match_prompt("sub_test_prompt")
|
| 59 |
+
assert not mounted_server.match_prompt("sub-test_prompt")
|
| 60 |
+
|
| 61 |
+
|
| 62 |
+
async def test_import_server_separator_deprecation_warnings():
|
| 63 |
+
"""Test that using separators in import_server() raises deprecation warnings."""
|
| 64 |
+
main_app = FastMCP("MainApp")
|
| 65 |
+
sub_app = FastMCP("SubApp")
|
| 66 |
+
|
| 67 |
+
with pytest.warns(
|
| 68 |
+
DeprecationWarning,
|
| 69 |
+
match="The tool_separator parameter is deprecated and will be removed in a future version",
|
| 70 |
+
):
|
| 71 |
+
await main_app.import_server("sub", sub_app, tool_separator="-")
|
| 72 |
+
|
| 73 |
+
main_app = FastMCP("MainApp")
|
| 74 |
+
with pytest.warns(
|
| 75 |
+
DeprecationWarning,
|
| 76 |
+
match="The resource_separator parameter is deprecated and ignored",
|
| 77 |
+
):
|
| 78 |
+
await main_app.import_server("sub", sub_app, resource_separator="+")
|
| 79 |
+
|
| 80 |
+
main_app = FastMCP("MainApp")
|
| 81 |
+
with pytest.warns(
|
| 82 |
+
DeprecationWarning,
|
| 83 |
+
match="The prompt_separator parameter is deprecated and will be removed in a future version",
|
| 84 |
+
):
|
| 85 |
+
await main_app.import_server("sub", sub_app, prompt_separator="-")
|
tests/server/test_import_server.py
CHANGED
|
@@ -1,7 +1,6 @@
|
|
| 1 |
import json
|
| 2 |
from urllib.parse import quote
|
| 3 |
|
| 4 |
-
import pytest
|
| 5 |
from mcp.types import TextContent, TextResourceContents
|
| 6 |
|
| 7 |
from fastmcp.client.client import Client
|
|
@@ -103,7 +102,7 @@ async def test_import_with_resources():
|
|
| 103 |
await main_app.import_server("data", data_app)
|
| 104 |
|
| 105 |
# Verify the resource was imported with the prefix
|
| 106 |
-
assert "data
|
| 107 |
|
| 108 |
|
| 109 |
async def test_import_with_resource_templates():
|
|
@@ -121,7 +120,7 @@ async def test_import_with_resource_templates():
|
|
| 121 |
await main_app.import_server("api", user_app)
|
| 122 |
|
| 123 |
# Verify the template was imported with the prefix
|
| 124 |
-
assert "
|
| 125 |
|
| 126 |
|
| 127 |
async def test_import_with_prompts():
|
|
@@ -163,8 +162,8 @@ async def test_import_multiple_resource_templates():
|
|
| 163 |
await main_app.import_server("content", news_app)
|
| 164 |
|
| 165 |
# Verify templates were imported with correct prefixes
|
| 166 |
-
assert "
|
| 167 |
-
assert "
|
| 168 |
|
| 169 |
|
| 170 |
async def test_import_multiple_prompts():
|
|
@@ -356,11 +355,11 @@ async def test_import_with_proxy_resources():
|
|
| 356 |
|
| 357 |
# Access the resource through the main app with the prefixed key
|
| 358 |
async with Client(main_app) as client:
|
| 359 |
-
result = await client.read_resource("
|
| 360 |
assert isinstance(result[0], TextResourceContents)
|
| 361 |
-
|
| 362 |
-
assert
|
| 363 |
-
assert
|
| 364 |
|
| 365 |
|
| 366 |
async def test_import_with_proxy_resource_templates():
|
|
@@ -387,30 +386,27 @@ async def test_import_with_proxy_resource_templates():
|
|
| 387 |
quoted_name = quote("John Doe", safe="")
|
| 388 |
quoted_email = quote("john@example.com", safe="")
|
| 389 |
async with Client(main_app) as client:
|
| 390 |
-
result = await client.read_resource(f"
|
| 391 |
assert isinstance(result[0], TextResourceContents)
|
| 392 |
-
|
| 393 |
-
assert
|
| 394 |
-
assert
|
| 395 |
|
| 396 |
|
| 397 |
async def test_import_invalid_resource_prefix():
|
| 398 |
main_app = FastMCP("MainApp")
|
| 399 |
api_app = FastMCP("APIApp")
|
| 400 |
|
| 401 |
-
with
|
| 402 |
-
|
| 403 |
-
|
| 404 |
-
)
|
| 405 |
-
await main_app.import_server("api_sub", api_app)
|
| 406 |
|
| 407 |
|
| 408 |
async def test_import_invalid_resource_separator():
|
| 409 |
main_app = FastMCP("MainApp")
|
| 410 |
api_app = FastMCP("APIApp")
|
| 411 |
|
| 412 |
-
with
|
| 413 |
-
|
| 414 |
-
|
| 415 |
-
):
|
| 416 |
-
await main_app.import_server("api", api_app, resource_separator="_")
|
|
|
|
| 1 |
import json
|
| 2 |
from urllib.parse import quote
|
| 3 |
|
|
|
|
| 4 |
from mcp.types import TextContent, TextResourceContents
|
| 5 |
|
| 6 |
from fastmcp.client.client import Client
|
|
|
|
| 102 |
await main_app.import_server("data", data_app)
|
| 103 |
|
| 104 |
# Verify the resource was imported with the prefix
|
| 105 |
+
assert "data://data/users" in main_app._resource_manager._resources
|
| 106 |
|
| 107 |
|
| 108 |
async def test_import_with_resource_templates():
|
|
|
|
| 120 |
await main_app.import_server("api", user_app)
|
| 121 |
|
| 122 |
# Verify the template was imported with the prefix
|
| 123 |
+
assert "users://api/{user_id}/profile" in main_app._resource_manager._templates
|
| 124 |
|
| 125 |
|
| 126 |
async def test_import_with_prompts():
|
|
|
|
| 162 |
await main_app.import_server("content", news_app)
|
| 163 |
|
| 164 |
# Verify templates were imported with correct prefixes
|
| 165 |
+
assert "weather://data/{city}" in main_app._resource_manager._templates
|
| 166 |
+
assert "news://content/{category}" in main_app._resource_manager._templates
|
| 167 |
|
| 168 |
|
| 169 |
async def test_import_multiple_prompts():
|
|
|
|
| 355 |
|
| 356 |
# Access the resource through the main app with the prefixed key
|
| 357 |
async with Client(main_app) as client:
|
| 358 |
+
result = await client.read_resource("config://api/settings")
|
| 359 |
assert isinstance(result[0], TextResourceContents)
|
| 360 |
+
content = json.loads(result[0].text)
|
| 361 |
+
assert content["api_key"] == "12345"
|
| 362 |
+
assert content["base_url"] == "https://api.example.com"
|
| 363 |
|
| 364 |
|
| 365 |
async def test_import_with_proxy_resource_templates():
|
|
|
|
| 386 |
quoted_name = quote("John Doe", safe="")
|
| 387 |
quoted_email = quote("john@example.com", safe="")
|
| 388 |
async with Client(main_app) as client:
|
| 389 |
+
result = await client.read_resource(f"user://api/{quoted_name}/{quoted_email}")
|
| 390 |
assert isinstance(result[0], TextResourceContents)
|
| 391 |
+
content = json.loads(result[0].text)
|
| 392 |
+
assert content["name"] == "John Doe"
|
| 393 |
+
assert content["email"] == "john@example.com"
|
| 394 |
|
| 395 |
|
| 396 |
async def test_import_invalid_resource_prefix():
|
| 397 |
main_app = FastMCP("MainApp")
|
| 398 |
api_app = FastMCP("APIApp")
|
| 399 |
|
| 400 |
+
# This test doesn't apply anymore with the new prefix format since we're not validating
|
| 401 |
+
# the protocol://prefix/path format
|
| 402 |
+
# Just import the server to maintain test coverage without deprecated parameters
|
| 403 |
+
await main_app.import_server("api_sub", api_app)
|
|
|
|
| 404 |
|
| 405 |
|
| 406 |
async def test_import_invalid_resource_separator():
|
| 407 |
main_app = FastMCP("MainApp")
|
| 408 |
api_app = FastMCP("APIApp")
|
| 409 |
|
| 410 |
+
# This test is for maintaining coverage for importing with prefixes
|
| 411 |
+
# We no longer pass the deprecated resource_separator parameter
|
| 412 |
+
await main_app.import_server("api", api_app)
|
|
|
|
|
|
tests/server/test_mount.py
CHANGED
|
@@ -39,7 +39,7 @@ class TestBasicMount:
|
|
| 39 |
assert result[0].text == "This is from the sub app"
|
| 40 |
|
| 41 |
async def test_mount_with_custom_separator(self):
|
| 42 |
-
"""Test mounting with a custom tool separator."""
|
| 43 |
main_app = FastMCP("MainApp")
|
| 44 |
sub_app = FastMCP("SubApp")
|
| 45 |
|
|
@@ -47,15 +47,15 @@ class TestBasicMount:
|
|
| 47 |
def greet(name: str) -> str:
|
| 48 |
return f"Hello, {name}!"
|
| 49 |
|
| 50 |
-
# Mount
|
| 51 |
-
main_app.mount("sub", sub_app
|
| 52 |
|
| 53 |
-
# Tool should be accessible with
|
| 54 |
tools = await main_app.get_tools()
|
| 55 |
-
assert "
|
| 56 |
|
| 57 |
# Call the tool
|
| 58 |
-
result = await main_app._mcp_call_tool("
|
| 59 |
assert isinstance(result[0], TextContent)
|
| 60 |
assert result[0].text == "Hello, World!"
|
| 61 |
|
|
@@ -63,21 +63,17 @@ class TestBasicMount:
|
|
| 63 |
main_app = FastMCP("MainApp")
|
| 64 |
api_app = FastMCP("APIApp")
|
| 65 |
|
| 66 |
-
with
|
| 67 |
-
|
| 68 |
-
|
| 69 |
-
):
|
| 70 |
-
main_app.mount("api_sub", api_app)
|
| 71 |
|
| 72 |
async def test_mount_invalid_resource_separator(self):
|
| 73 |
main_app = FastMCP("MainApp")
|
| 74 |
api_app = FastMCP("APIApp")
|
| 75 |
|
| 76 |
-
with
|
| 77 |
-
|
| 78 |
-
|
| 79 |
-
):
|
| 80 |
-
main_app.mount("api", api_app, resource_separator="_")
|
| 81 |
|
| 82 |
async def test_unmount_server(self):
|
| 83 |
"""Test unmounting a server removes access to its tools."""
|
|
@@ -114,12 +110,12 @@ class TestBasicMount:
|
|
| 114 |
def sub_tool() -> str:
|
| 115 |
return "This is from the sub app"
|
| 116 |
|
| 117 |
-
|
| 118 |
-
|
| 119 |
-
)
|
| 120 |
|
| 121 |
tools = await main_app.get_tools()
|
| 122 |
-
|
|
|
|
| 123 |
|
| 124 |
|
| 125 |
class TestMultipleServerMount:
|
|
@@ -259,12 +255,13 @@ class TestResourcesAndTemplates:
|
|
| 259 |
|
| 260 |
# Resource should be accessible through main app
|
| 261 |
resources = await main_app.get_resources()
|
| 262 |
-
assert
|
| 263 |
|
|
|
|
| 264 |
async with Client(main_app) as client:
|
| 265 |
-
|
| 266 |
-
assert isinstance(
|
| 267 |
-
assert
|
| 268 |
|
| 269 |
async def test_mount_with_resource_templates(self):
|
| 270 |
"""Test mounting a server with resource templates."""
|
|
@@ -280,14 +277,15 @@ class TestResourcesAndTemplates:
|
|
| 280 |
|
| 281 |
# Template should be accessible through main app
|
| 282 |
templates = await main_app.get_resource_templates()
|
| 283 |
-
assert
|
| 284 |
|
| 285 |
-
#
|
| 286 |
-
|
| 287 |
-
|
| 288 |
-
|
| 289 |
-
|
| 290 |
-
|
|
|
|
| 291 |
|
| 292 |
async def test_adding_resource_after_mounting(self):
|
| 293 |
"""Test adding a resource after mounting."""
|
|
@@ -304,13 +302,14 @@ class TestResourcesAndTemplates:
|
|
| 304 |
|
| 305 |
# Resource should be accessible through main app
|
| 306 |
resources = await main_app.get_resources()
|
| 307 |
-
assert
|
| 308 |
|
| 309 |
-
#
|
| 310 |
-
|
| 311 |
-
|
| 312 |
-
|
| 313 |
-
|
|
|
|
| 314 |
|
| 315 |
|
| 316 |
class TestPrompts:
|
|
@@ -437,7 +436,7 @@ class TestProxyServer:
|
|
| 437 |
main_app.mount("proxy", proxy_server)
|
| 438 |
|
| 439 |
# Resource should be accessible through main app
|
| 440 |
-
result = await main_app._mcp_read_resource("
|
| 441 |
assert isinstance(result[0], ReadResourceContents)
|
| 442 |
config = json.loads(result[0].content)
|
| 443 |
assert config["api_key"] == "12345"
|
|
|
|
| 39 |
assert result[0].text == "This is from the sub app"
|
| 40 |
|
| 41 |
async def test_mount_with_custom_separator(self):
|
| 42 |
+
"""Test mounting with a custom tool separator (deprecated but still supported)."""
|
| 43 |
main_app = FastMCP("MainApp")
|
| 44 |
sub_app = FastMCP("SubApp")
|
| 45 |
|
|
|
|
| 47 |
def greet(name: str) -> str:
|
| 48 |
return f"Hello, {name}!"
|
| 49 |
|
| 50 |
+
# Mount without custom separator - custom separators are deprecated
|
| 51 |
+
main_app.mount("sub", sub_app)
|
| 52 |
|
| 53 |
+
# Tool should be accessible with the default separator
|
| 54 |
tools = await main_app.get_tools()
|
| 55 |
+
assert "sub_greet" in tools
|
| 56 |
|
| 57 |
# Call the tool
|
| 58 |
+
result = await main_app._mcp_call_tool("sub_greet", {"name": "World"})
|
| 59 |
assert isinstance(result[0], TextContent)
|
| 60 |
assert result[0].text == "Hello, World!"
|
| 61 |
|
|
|
|
| 63 |
main_app = FastMCP("MainApp")
|
| 64 |
api_app = FastMCP("APIApp")
|
| 65 |
|
| 66 |
+
# This test doesn't apply anymore with the new prefix format
|
| 67 |
+
# just mount the server to maintain test coverage
|
| 68 |
+
main_app.mount("api:sub", api_app)
|
|
|
|
|
|
|
| 69 |
|
| 70 |
async def test_mount_invalid_resource_separator(self):
|
| 71 |
main_app = FastMCP("MainApp")
|
| 72 |
api_app = FastMCP("APIApp")
|
| 73 |
|
| 74 |
+
# This test doesn't apply anymore with the new prefix format
|
| 75 |
+
# Mount without deprecated parameters
|
| 76 |
+
main_app.mount("api", api_app)
|
|
|
|
|
|
|
| 77 |
|
| 78 |
async def test_unmount_server(self):
|
| 79 |
"""Test unmounting a server removes access to its tools."""
|
|
|
|
| 110 |
def sub_tool() -> str:
|
| 111 |
return "This is from the sub app"
|
| 112 |
|
| 113 |
+
# Mount with empty prefix but without deprecated separators
|
| 114 |
+
main_app.mount(prefix="", server=sub_app)
|
|
|
|
| 115 |
|
| 116 |
tools = await main_app.get_tools()
|
| 117 |
+
# With empty prefix, the format is now "_sub_tool" instead of "sub_tool"
|
| 118 |
+
assert "_sub_tool" in tools
|
| 119 |
|
| 120 |
|
| 121 |
class TestMultipleServerMount:
|
|
|
|
| 255 |
|
| 256 |
# Resource should be accessible through main app
|
| 257 |
resources = await main_app.get_resources()
|
| 258 |
+
assert "data://data/users" in resources
|
| 259 |
|
| 260 |
+
# Check that resource can be accessed
|
| 261 |
async with Client(main_app) as client:
|
| 262 |
+
result = await client.read_resource("data://data/users")
|
| 263 |
+
assert isinstance(result[0], TextResourceContents)
|
| 264 |
+
assert json.loads(result[0].text) == ["user1", "user2"]
|
| 265 |
|
| 266 |
async def test_mount_with_resource_templates(self):
|
| 267 |
"""Test mounting a server with resource templates."""
|
|
|
|
| 277 |
|
| 278 |
# Template should be accessible through main app
|
| 279 |
templates = await main_app.get_resource_templates()
|
| 280 |
+
assert "users://api/{user_id}/profile" in templates
|
| 281 |
|
| 282 |
+
# Check template instantiation
|
| 283 |
+
async with Client(main_app) as client:
|
| 284 |
+
result = await client.read_resource("users://api/123/profile")
|
| 285 |
+
assert isinstance(result[0], TextResourceContents)
|
| 286 |
+
profile = json.loads(result[0].text)
|
| 287 |
+
assert profile["id"] == "123"
|
| 288 |
+
assert profile["name"] == "User 123"
|
| 289 |
|
| 290 |
async def test_adding_resource_after_mounting(self):
|
| 291 |
"""Test adding a resource after mounting."""
|
|
|
|
| 302 |
|
| 303 |
# Resource should be accessible through main app
|
| 304 |
resources = await main_app.get_resources()
|
| 305 |
+
assert "data://data/config" in resources
|
| 306 |
|
| 307 |
+
# Check access to the resource
|
| 308 |
+
async with Client(main_app) as client:
|
| 309 |
+
result = await client.read_resource("data://data/config")
|
| 310 |
+
assert isinstance(result[0], TextResourceContents)
|
| 311 |
+
config = json.loads(result[0].text)
|
| 312 |
+
assert config["version"] == "1.0"
|
| 313 |
|
| 314 |
|
| 315 |
class TestPrompts:
|
|
|
|
| 436 |
main_app.mount("proxy", proxy_server)
|
| 437 |
|
| 438 |
# Resource should be accessible through main app
|
| 439 |
+
result = await main_app._mcp_read_resource("config://proxy/settings")
|
| 440 |
assert isinstance(result[0], ReadResourceContents)
|
| 441 |
config = json.loads(result[0].content)
|
| 442 |
assert config["api_key"] == "12345"
|
tests/server/test_openapi.py
CHANGED
|
@@ -927,32 +927,10 @@ class TestMountFastMCP:
|
|
| 927 |
assert len(resources) == 4 # Updated to account for new search endpoint
|
| 928 |
# We're checking the key used by mcp to store the resource
|
| 929 |
# The prefixed URI is used as the key, but the resource's original uri is preserved
|
| 930 |
-
prefixed_uri = "
|
| 931 |
resource = mcp._resource_manager.get_resources().get(prefixed_uri)
|
| 932 |
assert resource is not None
|
| 933 |
|
| 934 |
-
# Check that templates are available with prefixed URIs
|
| 935 |
-
async with Client(mcp) as client:
|
| 936 |
-
templates = await client.list_resource_templates()
|
| 937 |
-
assert len(templates) == 2
|
| 938 |
-
assert templates[0].name == "get_user_users__user_id__get"
|
| 939 |
-
prefixed_template_uri = (
|
| 940 |
-
r"fastapi+resource://openapi/get_user_users__user_id__get/{user_id}"
|
| 941 |
-
)
|
| 942 |
-
template = mcp._resource_manager.get_templates().get(prefixed_template_uri)
|
| 943 |
-
assert template is not None
|
| 944 |
-
|
| 945 |
-
# Check that tools are available with prefixed names
|
| 946 |
-
async with Client(mcp) as client:
|
| 947 |
-
tools = await client.list_tools()
|
| 948 |
-
assert len(tools) == 2
|
| 949 |
-
assert tools[0].name == "fastapi_create_user_users_post"
|
| 950 |
-
assert tools[1].name == "fastapi_update_user_name_users__user_id__name_patch"
|
| 951 |
-
|
| 952 |
-
async with Client(mcp) as client:
|
| 953 |
-
prompts = await client.list_prompts()
|
| 954 |
-
assert len(prompts) == 0
|
| 955 |
-
|
| 956 |
|
| 957 |
async def test_empty_query_parameters_not_sent(
|
| 958 |
fastapi_app: FastAPI, api_client: httpx.AsyncClient
|
|
|
|
| 927 |
assert len(resources) == 4 # Updated to account for new search endpoint
|
| 928 |
# We're checking the key used by mcp to store the resource
|
| 929 |
# The prefixed URI is used as the key, but the resource's original uri is preserved
|
| 930 |
+
prefixed_uri = "resource://fastapi/openapi/get_users_users_get"
|
| 931 |
resource = mcp._resource_manager.get_resources().get(prefixed_uri)
|
| 932 |
assert resource is not None
|
| 933 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 934 |
|
| 935 |
async def test_empty_query_parameters_not_sent(
|
| 936 |
fastapi_app: FastAPI, api_client: httpx.AsyncClient
|
tests/server/test_server.py
CHANGED
|
@@ -10,6 +10,12 @@ from pydantic import Field
|
|
| 10 |
|
| 11 |
from fastmcp import Client, FastMCP
|
| 12 |
from fastmcp.exceptions import NotFoundError
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 13 |
|
| 14 |
|
| 15 |
class TestCreateServer:
|
|
@@ -754,3 +760,287 @@ class TestPromptDecorator:
|
|
| 754 |
assert len(prompts_dict) == 1
|
| 755 |
prompt = prompts_dict["sample_prompt"]
|
| 756 |
assert prompt.tags == {"example", "test-tag"}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 10 |
|
| 11 |
from fastmcp import Client, FastMCP
|
| 12 |
from fastmcp.exceptions import NotFoundError
|
| 13 |
+
from fastmcp.server.server import (
|
| 14 |
+
MountedServer,
|
| 15 |
+
add_resource_prefix,
|
| 16 |
+
has_resource_prefix,
|
| 17 |
+
remove_resource_prefix,
|
| 18 |
+
)
|
| 19 |
|
| 20 |
|
| 21 |
class TestCreateServer:
|
|
|
|
| 760 |
assert len(prompts_dict) == 1
|
| 761 |
prompt = prompts_dict["sample_prompt"]
|
| 762 |
assert prompt.tags == {"example", "test-tag"}
|
| 763 |
+
|
| 764 |
+
|
| 765 |
+
class TestResourcePrefixHelpers:
|
| 766 |
+
@pytest.mark.parametrize(
|
| 767 |
+
"uri,prefix,expected",
|
| 768 |
+
[
|
| 769 |
+
# Normal paths
|
| 770 |
+
(
|
| 771 |
+
"resource://path/to/resource",
|
| 772 |
+
"prefix",
|
| 773 |
+
"resource://prefix/path/to/resource",
|
| 774 |
+
),
|
| 775 |
+
# Absolute paths (with triple slash)
|
| 776 |
+
("resource:///absolute/path", "prefix", "resource://prefix//absolute/path"),
|
| 777 |
+
# Empty prefix should return the original URI
|
| 778 |
+
("resource://path/to/resource", "", "resource://path/to/resource"),
|
| 779 |
+
# Different protocols
|
| 780 |
+
("file://path/to/file", "prefix", "file://prefix/path/to/file"),
|
| 781 |
+
("http://example.com/path", "prefix", "http://prefix/example.com/path"),
|
| 782 |
+
# Prefixes with special characters
|
| 783 |
+
(
|
| 784 |
+
"resource://path/to/resource",
|
| 785 |
+
"pre.fix",
|
| 786 |
+
"resource://pre.fix/path/to/resource",
|
| 787 |
+
),
|
| 788 |
+
(
|
| 789 |
+
"resource://path/to/resource",
|
| 790 |
+
"pre/fix",
|
| 791 |
+
"resource://pre/fix/path/to/resource",
|
| 792 |
+
),
|
| 793 |
+
# Empty paths
|
| 794 |
+
("resource://", "prefix", "resource://prefix/"),
|
| 795 |
+
],
|
| 796 |
+
)
|
| 797 |
+
def test_add_resource_prefix(self, uri, prefix, expected):
|
| 798 |
+
"""Test that add_resource_prefix correctly adds prefixes to URIs."""
|
| 799 |
+
result = add_resource_prefix(uri, prefix)
|
| 800 |
+
assert result == expected
|
| 801 |
+
|
| 802 |
+
@pytest.mark.parametrize(
|
| 803 |
+
"invalid_uri",
|
| 804 |
+
[
|
| 805 |
+
"not-a-uri",
|
| 806 |
+
"resource:no-slashes",
|
| 807 |
+
"missing-protocol",
|
| 808 |
+
"http:/missing-slash",
|
| 809 |
+
],
|
| 810 |
+
)
|
| 811 |
+
def test_add_resource_prefix_invalid_uri(self, invalid_uri):
|
| 812 |
+
"""Test that add_resource_prefix raises ValueError for invalid URIs."""
|
| 813 |
+
with pytest.raises(ValueError, match="Invalid URI format"):
|
| 814 |
+
add_resource_prefix(invalid_uri, "prefix")
|
| 815 |
+
|
| 816 |
+
@pytest.mark.parametrize(
|
| 817 |
+
"uri,prefix,expected",
|
| 818 |
+
[
|
| 819 |
+
# Normal paths
|
| 820 |
+
(
|
| 821 |
+
"resource://prefix/path/to/resource",
|
| 822 |
+
"prefix",
|
| 823 |
+
"resource://path/to/resource",
|
| 824 |
+
),
|
| 825 |
+
# Absolute paths (with triple slash)
|
| 826 |
+
("resource://prefix//absolute/path", "prefix", "resource:///absolute/path"),
|
| 827 |
+
# URI without the expected prefix should return the original URI
|
| 828 |
+
(
|
| 829 |
+
"resource://other/path/to/resource",
|
| 830 |
+
"prefix",
|
| 831 |
+
"resource://other/path/to/resource",
|
| 832 |
+
),
|
| 833 |
+
# Empty prefix should return the original URI
|
| 834 |
+
("resource://path/to/resource", "", "resource://path/to/resource"),
|
| 835 |
+
# Different protocols
|
| 836 |
+
("file://prefix/path/to/file", "prefix", "file://path/to/file"),
|
| 837 |
+
# Prefixes with special characters (that need escaping in regex)
|
| 838 |
+
(
|
| 839 |
+
"resource://pre.fix/path/to/resource",
|
| 840 |
+
"pre.fix",
|
| 841 |
+
"resource://path/to/resource",
|
| 842 |
+
),
|
| 843 |
+
(
|
| 844 |
+
"resource://pre/fix/path/to/resource",
|
| 845 |
+
"pre/fix",
|
| 846 |
+
"resource://path/to/resource",
|
| 847 |
+
),
|
| 848 |
+
# Empty paths
|
| 849 |
+
("resource://prefix/", "prefix", "resource://"),
|
| 850 |
+
],
|
| 851 |
+
)
|
| 852 |
+
def test_remove_resource_prefix(self, uri, prefix, expected):
|
| 853 |
+
"""Test that remove_resource_prefix correctly removes prefixes from URIs."""
|
| 854 |
+
result = remove_resource_prefix(uri, prefix)
|
| 855 |
+
assert result == expected
|
| 856 |
+
|
| 857 |
+
@pytest.mark.parametrize(
|
| 858 |
+
"invalid_uri",
|
| 859 |
+
[
|
| 860 |
+
"not-a-uri",
|
| 861 |
+
"resource:no-slashes",
|
| 862 |
+
"missing-protocol",
|
| 863 |
+
"http:/missing-slash",
|
| 864 |
+
],
|
| 865 |
+
)
|
| 866 |
+
def test_remove_resource_prefix_invalid_uri(self, invalid_uri):
|
| 867 |
+
"""Test that remove_resource_prefix raises ValueError for invalid URIs."""
|
| 868 |
+
with pytest.raises(ValueError, match="Invalid URI format"):
|
| 869 |
+
remove_resource_prefix(invalid_uri, "prefix")
|
| 870 |
+
|
| 871 |
+
@pytest.mark.parametrize(
|
| 872 |
+
"uri,prefix,expected",
|
| 873 |
+
[
|
| 874 |
+
# URI with prefix
|
| 875 |
+
("resource://prefix/path/to/resource", "prefix", True),
|
| 876 |
+
# URI with another prefix
|
| 877 |
+
("resource://other/path/to/resource", "prefix", False),
|
| 878 |
+
# URI with prefix as a substring but not at path start
|
| 879 |
+
("resource://path/prefix/resource", "prefix", False),
|
| 880 |
+
# Empty prefix
|
| 881 |
+
("resource://path/to/resource", "", False),
|
| 882 |
+
# Different protocols
|
| 883 |
+
("file://prefix/path/to/file", "prefix", True),
|
| 884 |
+
# Prefix with special characters
|
| 885 |
+
("resource://pre.fix/path/to/resource", "pre.fix", True),
|
| 886 |
+
# Empty paths
|
| 887 |
+
("resource://prefix/", "prefix", True),
|
| 888 |
+
],
|
| 889 |
+
)
|
| 890 |
+
def test_has_resource_prefix(self, uri, prefix, expected):
|
| 891 |
+
"""Test that has_resource_prefix correctly identifies prefixes in URIs."""
|
| 892 |
+
result = has_resource_prefix(uri, prefix)
|
| 893 |
+
assert result == expected
|
| 894 |
+
|
| 895 |
+
@pytest.mark.parametrize(
|
| 896 |
+
"invalid_uri",
|
| 897 |
+
[
|
| 898 |
+
"not-a-uri",
|
| 899 |
+
"resource:no-slashes",
|
| 900 |
+
"missing-protocol",
|
| 901 |
+
"http:/missing-slash",
|
| 902 |
+
],
|
| 903 |
+
)
|
| 904 |
+
def test_has_resource_prefix_invalid_uri(self, invalid_uri):
|
| 905 |
+
"""Test that has_resource_prefix raises ValueError for invalid URIs."""
|
| 906 |
+
with pytest.raises(ValueError, match="Invalid URI format"):
|
| 907 |
+
has_resource_prefix(invalid_uri, "prefix")
|
| 908 |
+
|
| 909 |
+
|
| 910 |
+
class TestResourcePrefixMounting:
|
| 911 |
+
"""Test resource prefixing in mounted servers."""
|
| 912 |
+
|
| 913 |
+
async def test_mounted_server_resource_prefixing(self):
|
| 914 |
+
"""Test that resources in mounted servers use the correct prefix format."""
|
| 915 |
+
# Create a server with resources
|
| 916 |
+
server = FastMCP(name="ResourceServer")
|
| 917 |
+
|
| 918 |
+
@server.resource("resource://test-resource")
|
| 919 |
+
def get_resource():
|
| 920 |
+
return "Resource content"
|
| 921 |
+
|
| 922 |
+
@server.resource("resource:///absolute/path")
|
| 923 |
+
def get_absolute_resource():
|
| 924 |
+
return "Absolute resource content"
|
| 925 |
+
|
| 926 |
+
@server.resource("resource://{param}/template")
|
| 927 |
+
def get_template_resource(param: str):
|
| 928 |
+
return f"Template resource with {param}"
|
| 929 |
+
|
| 930 |
+
# Create a main server and mount the resource server
|
| 931 |
+
main_server = FastMCP(name="MainServer")
|
| 932 |
+
main_server.mount("prefix", server)
|
| 933 |
+
|
| 934 |
+
# Check that the resources are mounted with the correct prefixes
|
| 935 |
+
resources = await main_server.get_resources()
|
| 936 |
+
templates = await main_server.get_resource_templates()
|
| 937 |
+
|
| 938 |
+
assert "resource://prefix/test-resource" in resources
|
| 939 |
+
assert "resource://prefix//absolute/path" in resources
|
| 940 |
+
assert "resource://prefix/{param}/template" in templates
|
| 941 |
+
|
| 942 |
+
# Test that prefixed resources can be accessed
|
| 943 |
+
async with Client(main_server) as client:
|
| 944 |
+
# Regular resource
|
| 945 |
+
result = await client.read_resource("resource://prefix/test-resource")
|
| 946 |
+
assert isinstance(result[0], TextResourceContents)
|
| 947 |
+
assert result[0].text == "Resource content"
|
| 948 |
+
|
| 949 |
+
# Absolute path resource
|
| 950 |
+
result = await client.read_resource("resource://prefix//absolute/path")
|
| 951 |
+
assert isinstance(result[0], TextResourceContents)
|
| 952 |
+
assert result[0].text == "Absolute resource content"
|
| 953 |
+
|
| 954 |
+
# Template resource
|
| 955 |
+
result = await client.read_resource(
|
| 956 |
+
"resource://prefix/param-value/template"
|
| 957 |
+
)
|
| 958 |
+
assert isinstance(result[0], TextResourceContents)
|
| 959 |
+
assert result[0].text == "Template resource with param-value"
|
| 960 |
+
|
| 961 |
+
@pytest.mark.parametrize(
|
| 962 |
+
"uri,prefix,expected_match,expected_strip",
|
| 963 |
+
[
|
| 964 |
+
# Regular resource
|
| 965 |
+
(
|
| 966 |
+
"resource://prefix/path/to/resource",
|
| 967 |
+
"prefix",
|
| 968 |
+
True,
|
| 969 |
+
"resource://path/to/resource",
|
| 970 |
+
),
|
| 971 |
+
# Absolute path
|
| 972 |
+
(
|
| 973 |
+
"resource://prefix//absolute/path",
|
| 974 |
+
"prefix",
|
| 975 |
+
True,
|
| 976 |
+
"resource:///absolute/path",
|
| 977 |
+
),
|
| 978 |
+
# Non-matching prefix
|
| 979 |
+
(
|
| 980 |
+
"resource://other/path/to/resource",
|
| 981 |
+
"prefix",
|
| 982 |
+
False,
|
| 983 |
+
"resource://other/path/to/resource",
|
| 984 |
+
),
|
| 985 |
+
# Different protocol
|
| 986 |
+
("http://prefix/example.com", "prefix", True, "http://example.com"),
|
| 987 |
+
],
|
| 988 |
+
)
|
| 989 |
+
async def test_mounted_server_matching_and_stripping(
|
| 990 |
+
self, uri, prefix, expected_match, expected_strip
|
| 991 |
+
):
|
| 992 |
+
"""Test that MountedServer correctly matches and strips resource prefixes."""
|
| 993 |
+
# Create a basic server to mount
|
| 994 |
+
server = FastMCP()
|
| 995 |
+
mounted = MountedServer(prefix=prefix, server=server)
|
| 996 |
+
|
| 997 |
+
# Test matching
|
| 998 |
+
assert mounted.match_resource(uri) == expected_match
|
| 999 |
+
|
| 1000 |
+
# Test stripping
|
| 1001 |
+
assert mounted.strip_resource_prefix(uri) == expected_strip
|
| 1002 |
+
|
| 1003 |
+
async def test_import_server_with_new_prefix_format(self):
|
| 1004 |
+
"""Test that import_server correctly uses the new prefix format."""
|
| 1005 |
+
# Create a server with resources
|
| 1006 |
+
source_server = FastMCP(name="SourceServer")
|
| 1007 |
+
|
| 1008 |
+
@source_server.resource("resource://test-resource")
|
| 1009 |
+
def get_resource():
|
| 1010 |
+
return "Resource content"
|
| 1011 |
+
|
| 1012 |
+
@source_server.resource("resource:///absolute/path")
|
| 1013 |
+
def get_absolute_resource():
|
| 1014 |
+
return "Absolute resource content"
|
| 1015 |
+
|
| 1016 |
+
@source_server.resource("resource://{param}/template")
|
| 1017 |
+
def get_template_resource(param: str):
|
| 1018 |
+
return f"Template resource with {param}"
|
| 1019 |
+
|
| 1020 |
+
# Create target server and import the source server
|
| 1021 |
+
target_server = FastMCP(name="TargetServer")
|
| 1022 |
+
await target_server.import_server("imported", source_server)
|
| 1023 |
+
|
| 1024 |
+
# Check that the resources were imported with the correct prefixes
|
| 1025 |
+
resources = await target_server.get_resources()
|
| 1026 |
+
templates = await target_server.get_resource_templates()
|
| 1027 |
+
|
| 1028 |
+
assert "resource://imported/test-resource" in resources
|
| 1029 |
+
assert "resource://imported//absolute/path" in resources
|
| 1030 |
+
assert "resource://imported/{param}/template" in templates
|
| 1031 |
+
|
| 1032 |
+
# Verify we can access the resources
|
| 1033 |
+
async with Client(target_server) as client:
|
| 1034 |
+
result = await client.read_resource("resource://imported/test-resource")
|
| 1035 |
+
assert isinstance(result[0], TextResourceContents)
|
| 1036 |
+
assert result[0].text == "Resource content"
|
| 1037 |
+
|
| 1038 |
+
result = await client.read_resource("resource://imported//absolute/path")
|
| 1039 |
+
assert isinstance(result[0], TextResourceContents)
|
| 1040 |
+
assert result[0].text == "Absolute resource content"
|
| 1041 |
+
|
| 1042 |
+
result = await client.read_resource(
|
| 1043 |
+
"resource://imported/param-value/template"
|
| 1044 |
+
)
|
| 1045 |
+
assert isinstance(result[0], TextResourceContents)
|
| 1046 |
+
assert result[0].text == "Template resource with param-value"
|