Fastmcp S65

🚀 FastMCP 項目文檔

FastMCP 是一個功能強大的工具，可用於開發和部署各類應用程序。它提供了豐富的命令和靈活的配置選項，能幫助開發者快速搭建和運行項目，無論是開發測試還是常規使用都非常便捷。

🚀 快速開始

📦 安裝指南

克隆倉庫

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

創建並安裝依賴環境

uv venv && uv sync

激活虛擬環境後（.venv），即可開始使用。

💻 使用示例

開發模式（推薦用於開發和測試）

fastmcp dev your_server_file.py
# 包含臨時依賴項時
fastmcp dev your_server_file.py --with pandas --with numpy
# 使用本地包的可編輯模式
fastmcp dev your_server_file.py --with-editable .

安裝到Claude Desktop（用於常規使用）

fastmcp install your_server_file.py
# 自定義名稱時
fastmcp install your_server_file.py --name "My Analysis Tool"
# 配置額外包和環境變量
fastmcp install server.py --with requests -v API_KEY=123 -f .env

直接運行（高級用法）

在 your_server_file.py 中添加：

if __name__ == "__main__":
    mcp.run()  # 假設 'mcp' 是你的 FastMCP 實例

然後運行：

python your_server_file.py
# 或者使用 uv 運行
uv run python your_server_file.py

指定服務器對象名稱

如果 FastMCP 實例的名稱不是 mcp、server 或 app，請在命令中指定：

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

示例代碼

查看 examples/ 目錄中的代碼樣例，瞭解各種功能的實現：

• simple_echo.py：基本工具、資源和提示示例。
• complex_inputs.py：使用 Pydantic 模型進行工具輸入處理。
• mount_example.py：掛載多個 FastMCP 服務器。
• sampling.py：在 MCP 服務器中使用 LLM 完成任務。
• screenshot.py：工具返回 Image 對象示例。
• text_me.py：工具與外部 API 的交互示例。
• memory.py：包含數據庫交互的複雜示例。

🤝 貢獻指南

開發者指南

先決條件

• Python 3.10+ 版本
• uv 工具

設置步驟

1. 克隆倉庫：

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

2. 創建並安裝依賴環境：

uv venv && uv sync

激活虛擬環境後（.venv），即可開始開發。

測試步驟

運行測試套件：

uv run pytest -vv

格式化與代碼檢查

使用 ruff 進行格式化和代碼檢查：

1. 安裝鉤子：

pre-commit install

2. 執行檢查：

pre-commit run --all-files

提交代碼

1. 創建功能分支：
   • Fork 倉庫。
   • 創建新的功能分支。
2. 提交更改：
   • 在自己的分支上進行修改。
   • 提交併推送變更。
3. 生成 Pull Request：
   • 在 GitHub 上提出Pull Request，說明修改內容和目的。

貢獻規範

• 請為您的貢獻添加相應的文檔。
• 確保代碼符合項目編碼規範。
• 提供詳細的提交信息，便於審查和理解。

📚 詳細文檔

其他資源

• 官方網站：FastMCP 官網
• 社區支持：在 GitHub Issues 中提問或討論。
• 開發者郵件列表：訂閱以獲取最新開發動態（如有）。

感謝您的參與和貢獻！希望 FastMCP 能為您的項目帶來便利。