fix: forward custom_route endpoints from mounted servers#3462
fix: forward custom_route endpoints from mounted servers#3462jlowin merged 6 commits intoPrefectHQ:mainfrom
Conversation
When a child server with custom HTTP routes (registered via @server.custom_route()) is mounted onto a parent, the routes were silently dropped because _get_additional_http_routes() only returned self._additional_http_routes without recursing into mounted providers. This caused 404s for endpoints like /readyz health checks that worked in v2 but broke in v3 (regression). The fix updates _get_additional_http_routes() to traverse providers, unwrap _WrappedProvider layers (from namespace transforms), find FastMCPProvider instances, and recursively collect their server's custom routes. Fixes PrefectHQ#3457
Test Failure AnalysisSummary: The Root Cause: The new test at line 190 (and existing one at line 86) directly accesses Suggested Solution: Two options, either works: Option A — Narrow the type in the tests with from starlette.routing import Route
# line ~85-86
assert isinstance(routes[0], Route)
assert routes[0].path == "/test"
# line ~189-190
assert isinstance(routes[0], Route)
assert routes[0].path == "/health"Option B — Change the type annotation in the implementation from
Option B is arguably cleaner because all items added to Detailed AnalysisFailing check: Return type in question ( def _get_additional_http_routes(self: FastMCP) -> list[BaseRoute]:Actual routes stored ( Route(
path=path,
endpoint=fn,
methods=methods,
...
)All items appended to Related Files
|
All items in _additional_http_routes are Route objects (created via Route(...) in custom_route()). Using list[Route] instead of list[BaseRoute] fixes the ty type checker failure where .path is accessed on BaseRoute which doesn't have that attribute. Removes unused BaseRoute imports from both server.py and transport.py.
Test Failure Analysis(Updated to reflect the latest run — previous analyses are no longer relevant.) Summary: The Root Cause: Three provider imports were added in the wrong position — before -from fastmcp.server.providers.base import Provider
-from fastmcp.server.providers.fastmcp_provider import FastMCPProvider
-from fastmcp.server.providers.wrapped_provider import _WrappedProvider
from fastmcp.server.event_store import EventStore
from fastmcp.server.http import (
StarletteWithLifespan,
create_sse_app,
create_streamable_http_app,
)
+from fastmcp.server.providers.base import Provider
+from fastmcp.server.providers.fastmcp_provider import FastMCPProvider
+from fastmcp.server.providers.wrapped_provider import _WrappedProviderSuggested Solution: Run uv run prek run --all-files
git add src/fastmcp/server/mixins/transport.py
git commit -m 'fix import order'Detailed AnalysisFailing hook: Log excerpt: The hook auto-fixed the error, but prek sees the file modification and fails the run. The diff prek reported shows the provider imports need to come after Related Files
|
The previous commit narrowed _additional_http_routes from list[BaseRoute] to list[Route], which broke: - component_manager appending Mount objects (Mount is BaseRoute, not Route) - tests assigning list[BaseRoute] variables (generics are invariant) Revert to list[BaseRoute] and use isinstance(r, Route) guards in tests for type-safe .path access.
- Remove unused `Route` import from server.py - Fix import grouping in test_advanced.py (ruff check)
jlowin
left a comment
There was a problem hiding this comment.
Thanks! Some minor changes. Also it may be worth noting in the docstring that collisions will be resolved in favor of the parent server (I think). This is correct behavior, but worth noting.
| List of Starlette Route objects | ||
| """ | ||
| return list(self._additional_http_routes) | ||
| from fastmcp.server.providers.fastmcp_provider import FastMCPProvider |
There was a problem hiding this comment.
Please move imports to module root
There was a problem hiding this comment.
Done — moved FastMCPProvider, _WrappedProvider, and Provider imports to module root in 5b44c8c.
|
|
||
| routes: list[BaseRoute] = list(self._additional_http_routes) | ||
|
|
||
| def _unwrap_provider(provider: Any) -> Any: |
There was a problem hiding this comment.
provider is typed as Provider here no? rather than Any. and the result is also Provider?
There was a problem hiding this comment.
Good catch — updated to Provider for both the parameter and return type. Also added a docstring note about parent-wins collision resolution per your suggestion.
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Jeremiah Lowin <jlowin@users.noreply.github.com> Co-authored-by: Marvin Context Protocol <41898282+Marvin Context Protocol@users.noreply.github.com> Co-authored-by: voidborne-d <voidborne-d@users.noreply.github.com> Co-authored-by: marvin-context-protocol[bot] <225465937+marvin-context-protocol[bot]@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: d 🔹 <258577966+voidborne-d@users.noreply.github.com> Co-authored-by: Jeremiah Lowin <153965+jlowin@users.noreply.github.com> Co-authored-by: nightcityblade <nightcityblade@gmail.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Bill Easton <strawgate@users.noreply.github.com> Co-authored-by: Sumanshu Nankana <sumanshunankana@gmail.com> Co-authored-by: Eric Robinson <ericrobinson@indeed.com> Co-authored-by: Martim Santos <martimfasantos@gmail.com> Co-authored-by: d 🔹 <liusway405@gmail.com> Co-authored-by: Matthieu B <66959271+mtthidoteu@users.noreply.github.com> Co-authored-by: Sascha Buehrle <47737812+saschabuehrle@users.noreply.github.com> Co-authored-by: Hakancan <142545736+hkc5@users.noreply.github.com> Co-authored-by: nightcityblade <jackchen@haloailabs.com> Co-authored-by: Matt Hallowell <17804673+mhallo@users.noreply.github.com> Co-authored-by: nate nowack <thrast36@gmail.com> Co-authored-by: Bill Easton <williamseaston@gmail.com> Co-authored-by: Marcus Shu <46469249+shulkx@users.noreply.github.com> Co-authored-by: Rushabh Doshi <radoshi@gmail.com> Co-authored-by: AIKAWA Shigechika <shige@aikawa.jp> Co-authored-by: Jeremy Simon <simonjer805@gmail.com> Co-authored-by: Miguel Miranda Dias <7780875+pandego@users.noreply.github.com> Co-authored-by: Anthony James Padavano <padavano.anthony@gmail.com> Co-authored-by: Mostafa Kamal <hiremostafa@gmail.com> Fix auto-close MRE script posting comment without closing (#3386) Fix WorkOS token scope verification bypass 🤖 Generated with Codex (#3407) Fix initialize McpError fallthrough 🤖 Generated with Codex (#3413) Fix transform arg collisions with passthrough params (#3431) Fix get_* returning None when latest version is disabled (#3439) Fix get_* returning None when latest version is disabled (#3421) Fix server lifespan overlap teardown (#3415) Fix $ref output schema object detection regression (#3420) resolved annotations (#3429) Fix async partial callables rejected by iscoroutinefunction (#3438) Fix async partial callables rejected by iscoroutinefunction (#3423) fix: add version to components (#3458) fix: use intent-based flag for OIDC scope patch in load_access_token (#3465) Fixes #3461 fix: normalize Google scope shorthands and surface valid_scopes (#3477) fix: resolve ty 0.0.23 type-checking errors and bump pin (#3481) fix: shield lifespan teardown from cancellation (#3480) fix: forward custom_route endpoints from mounted servers (#3462) fix updates _get_additional_http_routes() to traverse providers, Fixes #3457 fix: remove hardcoded version from CLI help text (#3456) fix: monty 0.0.8 compatibility, drop external_functions from constructor (#3468) fix: task test teardown hanging 5s per test (#3499) Closes #3498 fix: validate workspace path is a directory before cursor install (#3440) Fixes #3426 fix: handle re.error from malformed URI templates in build_regex (#3501) fix: reject empty/OIDC-only required_scopes in AzureProvider (#3503) fix: restrict $ref resolution to local refs only (SSRF/LFI) (#3502) fix warnings and timeouts (#3504) close upgrade check issue when build passes (#3505) Closes #3484 fix: URL-encode path params to prevent SSRF/path traversal (GHSA-vv7q-7jx5-f767) (#3507) fix: prevent path traversal in skill download (#3493) fix: prefer IdP-granted scopes over client-requested scopes in OAuthProxy (#3492) fix: remove unrelated transform and http.py changes from PR scope fix: remove forced follow_redirects from httpx_client_factory calls (#3496) fix: stop passing follow_redirects to httpx_client_factory fix: restore follow_redirects=True for custom httpx client factories Closes #3509 fix: CSRF double-submit cookie check in consent flow (#3519) fix: validate server names in install commands (#3522) fix: use raw strings for regex in pytest.raises match (#3523) fix: reject refresh tokens used as Bearer access tokens (#3524) fix: route ResourcesAsTools/PromptsAsTools through server middleware (#3495) fix: resolve Pyright "Module is not callable" on @tool, @resource, @prompt decorators (#3540) fix: filter warnings by message in KEY_PREFIX test (#3549) fix: suppress output schema for ToolResult subclass annotations (#3548) fix: increase sleep duration in proxy cache tests (#3567) fix: store absolute token expiry to prevent stale expires_in on reload (#3572) fix: preserve tool properties named 'title' during schema compression (#3582) Fix loopback redirect URI port matching per RFC 8252 §7.3 (#3589) Fix app tool routing: visibility check and middleware propagation (#3591) Fix query parameter serialization to respect OpenAPI explode/style settings (#3595) Fix dev apps form: union types, textarea support, JSON parsing (#3597) fix(google): replace deprecated /oauth2/v1/tokeninfo with /oauth2/v3/userinfo (#3603) fix: resolve EntraOBOToken dependency injection through MultiAuth (#3609) fix(docs): correct misleading stateless_http header (#3622) fix: filesystem provider import machinery (#3626) Closes #3625 (issues 2, 3, 6) fix: recover StdioTransport after subprocess exits (#3630) fix(server): preserve mounted tool task metadata (#3632) fix: scope deprecation warning filter to FastMCPDeprecationWarning (#3649) fix imports, add PrefabAppConfig (#3650) fix: resolve CurrentFastMCP/ctx.fastmcp to child server in mounted background tasks (#3651) Fix blocking docs issues: chart imports, Select API, Rx consistency (#3652) closed by default (#3657) Fix prompt caching middleware missing wrap/unwrap round-trip (#3666) fix: serialize object query params per OpenAPI style/explode rules (#3662) Fixes #2857 fix: HTTP request headers not accessible in background task workers (#3631) fix: restore HTTP headers in worker execution path for background tasks (#3681) fix: strip discriminator after dereferencing schemas (#3682) fix: remove stale ty:ignore directives for ty 0.0.26 (#3684) Fix docs gaps in app provider pages (#3690) fix: dev apps log panel UX improvements (#3698) fix dev server empty string args (#3700)
Summary
Fixes #3457 — custom HTTP routes registered via
@server.custom_route()on a child server are silently dropped when the child is mounted onto a parent, returning 404 instead of the expected response.Root Cause
_get_additional_http_routes()intransport.pyonly returnedself._additional_http_routes— routes from the current server. It never recursed into mounted providers to collect their custom routes.When
mount()creates aFastMCPProvider(child_server)and adds it to the parent's provider list, the child's HTTP routes are effectively invisible tohttp_app()which calls_get_additional_http_routes()to build the Starlette route table.Fix
Updated
_get_additional_http_routes()to:self.providers_WrappedProviderlayers (added by namespace transforms)FastMCPProviderinstancesThis handles arbitrary nesting depth (server A mounts B which mounts C — A sees C's routes).
Tests
Added 4 tests in
tests/server/mount/test_advanced.py:test_mounted_server_custom_routes_forwarded— basic mount forwardingtest_mounted_server_custom_routes_with_namespace— namespaced mounttest_deeply_nested_custom_routes_forwarded— 3-level deep nestingtest_mounted_custom_routes_http_app_integration— end-to-end withTestClientreproducing the exact issue scenarioReproducer (from issue)
Before fix:
curl http://localhost:8000/readyz→404 Not FoundAfter fix:
curl http://localhost:8000/readyz→{"status": "ok"}