Make resource prefix format configurable #534
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR makes the resource prefix format configurable by introducing a new setting and updating resource-related functions and tests to support both legacy (protocol) and new (path) formats.
- Added a new global setting ("resource_prefix_format") in the settings module with a default of "path".
- Updated resource handling in the server module to pass the configurable format to prefix utility functions.
- Enhanced tests and documentation to reflect the new configurable resource prefix behavior.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/server/test_resource_prefix_formats.py | Added tests ensuring the resource_prefix_format parameter is correctly applied in usage. |
| tests/deprecated/test_resource_prefixes.py | Added tests verifying legacy resource prefix behavior remains functional under protocol format. |
| src/fastmcp/settings.py | Introduced new setting for resource_prefix_format with appropriate description and default value. |
| src/fastmcp/server/server.py | Modified resource-related functions to accept and forward the resource_prefix_format parameter. |
| docs/servers/composition.mdx | Updated documentation to describe both resource prefix formats and configuration options. |
Comments suppressed due to low confidence (1)
src/fastmcp/settings.py:55
- The word 'perfixing' is misspelled; it should be 'prefixing'.
When perfixing a resource URI, either use path formatting (resource://prefix/path) or protocol formatting (prefix+resource://path). Protocol formatting was the default in FastMCP < 2.4; path formatting is current default.
jordicore
pushed a commit
to jordicore/fastmcp
that referenced
this pull request
Jul 2, 2025
Make resource prefix format configurable
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#526 introduced a new resource prefix format. To avoid compatibility issues, this PR allows users to use the legacy format by setting global config
or on a per-server basis
The available options are
"path"(new default) or"protocol"(legacy behavior).