- 
                Notifications
    You must be signed in to change notification settings 
- Fork 555
Fix stdio encoding issue: Enforce explicit UTF-8 for correct Unicode handling #73
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
          
     Merged
      
      
            stephentoub
  merged 3 commits into
  modelcontextprotocol:main
from
willibrandon:fix/utf8-stdio-encoding
  
      
      
   
  Mar 24, 2025 
      
    
                
     Merged
            
            Fix stdio encoding issue: Enforce explicit UTF-8 for correct Unicode handling #73
                    stephentoub
  merged 3 commits into
  modelcontextprotocol:main
from
willibrandon:fix/utf8-stdio-encoding
  
      
      
   
  Mar 24, 2025 
              
            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
    
  
  
    
    
      
  
  Closed
  
              
                    stephentoub
  
              
              reviewed
              
                  
                    Mar 24, 2025 
                  
              
              
            
            
              
                    stephentoub
  
              
              reviewed
              
                  
                    Mar 24, 2025 
                  
              
              
            
            
              
                    stephentoub
  
              
              reviewed
              
                  
                    Mar 24, 2025 
                  
              
              
            
            
        
          
                src/ModelContextProtocol/Protocol/Transport/StdioClientTransport.cs
              
                Outdated
          
            Show resolved
            Hide resolved
        
      
              
                    stephentoub
  
              
              reviewed
              
                  
                    Mar 24, 2025 
                  
              
              
            
            
        
          
                src/ModelContextProtocol/Protocol/Transport/StdioClientTransport.cs
              
                Outdated
          
            Show resolved
            Hide resolved
        
      
              
                    stephentoub
  
              
              reviewed
              
                  
                    Mar 24, 2025 
                  
              
              
            
            
        
          
                src/ModelContextProtocol/Protocol/Transport/StdioServerTransport.cs
              
                Outdated
          
            Show resolved
            Hide resolved
        
      
              
                    stephentoub
  
              
              reviewed
              
                  
                    Mar 24, 2025 
                  
              
              
            
            
        
          
                src/ModelContextProtocol/Protocol/Transport/StdioServerTransport.cs
              
                Outdated
          
            Show resolved
            Hide resolved
        
      
              
                    stephentoub
  
              
              reviewed
              
                  
                    Mar 24, 2025 
                  
              
              
            
            
This change replaces the default system encoding with an explicit UTF8Encoding (without BOM)
for both client and server transports. This ensures proper handling of Unicode characters,
including Chinese characters and emoji.
- Use UTF8Encoding explicitly for StreamReader and StreamWriter.
- Add tests for Chinese characters ("上下文伺服器") and emoji (🔍🚀👍) to confirm the fix.
Fixes modelcontextprotocol#35.
    
      
  
  Closed
  
1162a06    to
    f47d99f      
    Compare
  
    
              
                    stephentoub
  
              
              approved these changes
              
                  
                    Mar 24, 2025 
                  
              
              
            
            
| Thanks, @willibrandon. | 
      
        
      
      
  
    9 tasks
  
  
    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.
  
    
  
    
Overview
This pull request addresses the encoding issue reported in #35, where JSON-RPC messages printed in the terminal showed corrupted characters (e.g., Chinese characters displayed as question marks).
The problem stemmed from the stdio transport layer relying on the system default encoding (Windows-1252 on Windows)
instead of explicitly using UTF-8.
Changes
UTF8Encoding(without BOM) for reading and writing:Impact
This fix resolves the Unicode character corruption by ensuring that the transport layer uses consistent UTF-8 encoding, improving the reliability of message display in all locales. The changes maintain the existing API surface while enhancing support for international characters.
Next Steps
Please review the changes and let me know if any further modifications or additional tests are needed.