MCP Hackathon Docs

🚀 MCP Python SDK ドキュメント

このリポジトリには、Model Context Protocol (MCP) Python SDK のドキュメントが含まれています。ドキュメントは Sphinx と Read the Docs テーマを使用して構築されています。

🚀 クイックスタート

このドキュメントでは、MCP Python SDK の基本的な使い方や構築方法、GitHub Pages へのホスティング方法、コントリビュート方法などを説明します。

✨ 主な機能

• モデルコンテキストプロトコル（MCP）のコア概念を理解する手助けをします。
• MCP サーバーを構築して、リソース、ツール、プロンプトを公開することができます。
• MCP クライアントを作成して、MCP サーバーに接続することができます。
• 高度なトピックやベストプラクティスを探索することができます。

💻 使用例

基本的な使用法

from mcp.server.fastmcp import FastMCP

mcp = FastMCP("Demo 🚀")

@mcp.tool()
def add(a: int, b: int) -> int:
    """Add two numbers"""
    return a + b

高度な使用法

SDK は、サーバーを実行するためのいくつかの方法を提供します。

• 開発モードと MCP モニター
• Claude Desktop への統合
• カスタムデプロイのための直接実行

📦 インストール

依存関係のインストール

まず、Python がインストールされていることを確認してください。次に、必要なパッケージをインストールします。

# conda を使用する場合（推奨）
conda activate cuda_test
pip install -r requirements.txt

# または、仮想環境で pip を使用する場合
python -m venv venv
source venv/bin/activate  # Windows の場合は：venv\Scripts\activate
pip install -r requirements.txt

ドキュメントの構築

ドキュメントを構築するには、次のコマンドを実行します。

make html

構築されたドキュメントは _build/html/ ディレクトリに保存されます。

リアルタイムプレビュー

リアルタイムでプレビューし、自動的に再読み込みするには、次のコマンドを実行します。

sphinx-autobuild . _build/html

その後、ブラウザで http://localhost:8000 を開きます。

📚 ドキュメント

GitHub Pages へのホスティング

このドキュメントを GitHub Pages でホストするには、次の手順を実行します。

1. 新しいリポジトリを作成する

   • GitHub にログインします。
   • "New repository" をクリックします。
   • リポジトリ名を入力します（例：yourusername/mcp-docs）。
   • リポジトリを初期化する内容を選択します。
   • "Create repository" をクリックします。

2. ドキュメントをアップロードする

   • 新しいリポジトリで、"Settings" をクリックします。
   • 左側のメニューで "Pages" を選択します。
   • ドロップダウンリストからメインブランチまたは gh-pages ブランチを選択します。
   • 変更を保存します。

3. ドキュメントサイトにアクセスする

   • 完了すると、GitHub Pages が自動的に URL を生成します。例：https://yourusername.github.io/mcp-docs/
   • このリンクを開いて、ホストされた MCP ドキュメントを確認します。

貢献ガイド

ドキュメントを改善するための貢献は歓迎されます！以下は貢献の手順です。

1. リポジトリをフォークする GitHub でこのリポジトリをあなたのアカウントにフォークします。

2. 機能ブランチを作成する

   • フォークしたリポジトリをローカルにクローンします：git clone https://github.com/yourusername/mcp-docs.git
   • 新しいブランチを作成します：git checkout -b feature/new-documentation

3. 変更をコミットする ドキュメントを変更した後、新しいブランチにコミットします。

git add .
git commit -m "ドキュメントの構造と内容を改善する"

4. GitHub にプッシュする 変更をリモートリポジトリにプッシュします。

git push origin feature/new-documentation

5. プルリクエストを送信する 元のリポジトリの "Pull Requests" タブで、"New Pull Request" をクリックします。フォークしたリポジトリと機能ブランチをソースとして選択し、リクエストを送信します。

🔗 リソース

• 公式 MCP ウェブサイト
• MCP Python SDK GitHub
• MCP 仕様
• 公式サポートのサーバー
• GitHub ディスカッション
• FastMCP GitHub（旧版）

📄 ライセンス

このドキュメントは MIT License の下でライセンスされています。詳細は LICENSE ファイルを参照してください。