Fastmcp S65

🚀 FastMCP プロジェクトドキュメント

FastMCPは、特定のPythonアプリケーションの開発、インストール、実行を支援するツールです。簡単なコマンドで環境構築や機能実装が可能で、開発者の作業効率を向上させます。

🚀 クイックスタート

📦 インストール

1. リポジトリのクローン：

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

2. 依存環境の作成とインストール：

   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. 機能ブランチの作成：

   • リポジトリをフォークします。
   • 新しい機能ブランチを作成します。

2. 変更のコミット：

   • 自分のブランチで変更を加えます。
   • 変更をコミットしてプッシュします。

3. Pull Request の作成：

   • GitHub 上で Pull Request を作成し、変更内容と目的を説明します。

📜 貢献規範

• あなたの貢献に対応するドキュメントを追加してください。
• コードがプロジェクトのコーディング規約に準拠していることを確認してください。
• レビューと理解を容易にするため、詳細なコミットメッセージを提供してください。

📚 その他のリソース

• 公式サイト：FastMCP 公式サイト
• コミュニティサポート：GitHub Issues で質問や議論を行ってください。
• 開発者メーリングリスト：最新の開発動向を受け取るために購読してください（ある場合）。

ご参加と貢献いただき、ありがとうございます！FastMCP があなたのプロジェクトに役立つことを願っています。