Fastmcp S65

🚀 FastMCP Project Documentation

FastMCP is a powerful tool that simplifies the development and deployment process. It provides a range of commands and features to meet different user needs, from installation to development, testing, and deployment.

🚀 Quick Start

Installation Steps

1. Clone the repository:

   git clone https://github.com/jlowin/fastmcp.git && cd fastmcp
   

2. Create and install the dependency environment:

   uv venv && uv sync
   

   After activating the virtual environment (.venv), you can start using it.

Development Mode (Recommended for development and testing)

fastmcp dev your_server_file.py
# When including temporary dependencies
fastmcp dev your_server_file.py --with pandas --with numpy
# Use editable mode for local packages
fastmcp dev your_server_file.py --with-editable .

Install to Claude Desktop (For regular use)

fastmcp install your_server_file.py
# When customizing the name
fastmcp install your_server_file.py --name "My Analysis Tool"
# Configure additional packages and environment variables
fastmcp install server.py --with requests -v API_KEY=123 -f .env

Direct Run (Advanced Usage)

Add the following to your_server_file.py:

if __name__ == "__main__":
    mcp.run()  # Assume 'mcp' is your FastMCP instance

Then run:

python your_server_file.py
# Or run using uv
uv run python your_server_file.py

Specify the server object name

If the name of the FastMCP instance is not mcp, server, or app, please specify it in the command:

fastmcp dev my_module.py:my_mcp_instance
fastmcp install api.py:api_app

💻 Usage Examples

Check the code examples in the examples/ directory to understand the implementation of various functions:

• simple_echo.py: Examples of basic tools, resources, and prompts.
• complex_inputs.py: Use Pydantic models for tool input processing.
• mount_example.py: Mount multiple FastMCP servers.
• sampling.py: Use LLM to complete tasks in the MCP server.
• screenshot.py: Example of a tool returning an Image object.
• text_me.py: Example of a tool interacting with an external API.
• memory.py: Complex example including database interaction.

🤝 Contribution Guidelines

Developer's Guide

Prerequisites

• Python 3.10+
• uv tool

Setup Steps

1. Clone the repository:

   git clone https://github.com/jlowin/fastmcp.git && cd fastmcp
   

2. Create and install the dependency environment:

   uv venv && uv sync
   

   After activating the virtual environment (.venv), you can start development.

Testing Steps

Run the test suite:

uv run pytest -vv

Formatting and Code Checking

Use ruff for formatting and code checking:

1. Install hooks:

   pre-commit install
   

2. Perform checks:

   pre-commit run --all-files
   

Submit Code

1. Create a feature branch:

   • Fork the repository.
   • Create a new feature branch.

2. Submit changes:

   • Make modifications on your own branch.
   • Commit and push the changes.

3. Generate a Pull Request:

   • Create a Pull Request on GitHub, explaining the content and purpose of the modifications.

Contribution Specifications

• Please add corresponding documentation for your contributions.
• Ensure that the code complies with the project's coding standards.
• Provide detailed commit messages for easy review and understanding.

📚 Other Resources

• Official Website: FastMCP Official Website
• Community Support: Ask questions or discuss in GitHub Issues.
• Developer Mailing List: Subscribe to get the latest development updates (if available).

Thank you for your participation and contributions! We hope FastMCP can bring convenience to your projects.