Add release version normalization #16
Closed
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
elfedy
reviewed
Aug 21, 2025
| .unwrap_or_else(|| "default".to_string()) | ||
| } | ||
|
|
||
| /// Fetches and analyzes PRDocs for a specific Polkadot SDK release. |
There was a problem hiding this comment.
Maybe describing this in the tool and arguments is good enough as the explanation is a bit duplicated along the way
| let project_name = get_project_name(); | ||
|
|
||
| // Create directory under ~/.substrate-mcp/{project}/releases/{release}/pr-docs | ||
| // We use the normalized release name for the directory structure |
There was a problem hiding this comment.
This comment might be redundant given variable name + comments above
| // This strips prefixes like 'polkadot-' that users might include from git tags | ||
| let normalized_release = normalize_release_input(release); | ||
|
|
||
| log::info!("Fetching release '{normalized_release}' (normalized from '{release}')"); |
There was a problem hiding this comment.
We should not log things to stdout as this uses the stdio transport. Client spawns a subprocess and communicates via stdin/stdout streams. Anything that goes there that is not mcp communication related might lead to unexpected behavior. If we want to implement logging we need a handle to the server and call notify_logging_message or log to stderr. See here
Although probably the tool call in this case is explicit enough to not require logging.
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.
This PR adds functionality to normalize release version strings.
Context:
polkadot-sdkhas a different scheme for their release names and tags compared to the prdoc versions and this was causing a lot of confusion (for humans (me) and AI).polkadot-stable123schemestable123schemeFor example, the
polkadot-stable2503release is found here: https://github.com/paritytech/polkadot-sdk/releases/tag/polkadot-stable2503...but the prdocs for this release are found here: https://github.com/paritytech/polkadot-sdk/tree/master/prdoc/stable2503
So this PR introduces a normalization scheme to strip
polkadot-to avoid this confusion when looking for prdocs.