- 
                Notifications
    You must be signed in to change notification settings 
- Fork 2.7k
Implementation of SEP 973 - Additional metadata + icons support #1357
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
      
      
    
  
     Merged
                    Changes from all commits
      Commits
    
    
            Show all changes
          
          
            12 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      6ad4bb3
              
                Implementation of SEP-973
              
              
                pja-ant b999b4e
              
                Resize icon to 64x64 and update demo sizes
              
              
                pja-ant 16ba07a
              
                Add public properties for website_url and icons, add tests
              
              
                pja-ant 883d2b4
              
                Fix double https:// typo in icons demo website URL
              
              
                pja-ant d028efb
              
                Add icon documentation to README
              
              
                pja-ant 7bd4334
              
                Export Icon from FastMCP module for simpler imports
              
              
                pja-ant 22a9067
              
                Add missing newline at end of test file
              
              
                pja-ant 10515fb
              
                Fix pre-commit formatting issues
              
              
                pja-ant 32624d9
              
                icon path parsing suggestion
              
              
                pja-ant 8353be8
              
                fix arg ordering
              
              
                pja-ant 0972674
              
                Pre-commit
              
              
                pja-ant 13b1340
              
                Merge branch 'main' into feature/icon-support
              
              
                pja-ant File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
  
    
      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
    
  
  
    
              
  
    
      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
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| """ | ||
| FastMCP Icons Demo Server | ||
|  | ||
| Demonstrates using icons with tools, resources, prompts, and implementation. | ||
| """ | ||
|  | ||
| import base64 | ||
| from pathlib import Path | ||
|  | ||
| from mcp.server.fastmcp import FastMCP, Icon | ||
|  | ||
| # Load the icon file and convert to data URI | ||
| icon_path = Path(__file__).parent / "mcp.png" | ||
| icon_data = base64.standard_b64encode(icon_path.read_bytes()).decode() | ||
| icon_data_uri = f"data:image/png;base64,{icon_data}" | ||
|  | ||
| icon_data = Icon(src=icon_data_uri, mimeType="image/png", sizes="64x64") | ||
|  | ||
| # Create server with icons in implementation | ||
| mcp = FastMCP("Icons Demo Server", website_url="https://github.com/modelcontextprotocol/python-sdk", icons=[icon_data]) | ||
|  | ||
|  | ||
| @mcp.tool(icons=[icon_data]) | ||
| def demo_tool(message: str) -> str: | ||
| """A demo tool with an icon.""" | ||
| return message | ||
|  | ||
|  | ||
| @mcp.resource("demo://readme", icons=[icon_data]) | ||
| def readme_resource() -> str: | ||
| """A demo resource with an icon""" | ||
| return "This resource has an icon" | ||
|  | ||
|  | ||
| @mcp.prompt("prompt_with_icon", icons=[icon_data]) | ||
| def prompt_with_icon(text: str) -> str: | ||
| """A demo prompt with an icon""" | ||
| return text | ||
|  | ||
|  | ||
| @mcp.tool( | ||
| icons=[ | ||
| Icon(src=icon_data_uri, mimeType="image/png", sizes="16x16"), | ||
| Icon(src=icon_data_uri, mimeType="image/png", sizes="32x32"), | ||
| Icon(src=icon_data_uri, mimeType="image/png", sizes="64x64"), | ||
| ] | ||
| ) | ||
| def multi_icon_tool(action: str) -> str: | ||
| """A tool demonstrating multiple icons.""" | ||
| return "multi_icon_tool" | ||
|  | ||
|  | ||
| if __name__ == "__main__": | ||
| # Run the server | ||
| mcp.run() | 
      
      Loading
      
  Sorry, something went wrong. Reload?
      Sorry, we cannot display this file.
      Sorry, this file is invalid so it cannot be displayed.
      
    
  
    
      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
    
  
  
    
              
  
    
      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
    
  
  
    
              
  
    
      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
    
  
  
    
              
  
    
      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
    
  
  
    
              
  
    
      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
    
  
  
    
              
  
    
      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
    
  
  
    
              
  
    
      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
    
  
  
    
              
      
      Oops, something went wrong.
        
    
  
      
      Oops, something went wrong.
        
    
  
  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.
  
    
  
    
Uh oh!
There was an error while loading. Please reload this page.