MCP Hackathon Docs

🚀 MCP Python SDK 文檔

本倉庫涵蓋了 Model Context Protocol (MCP) Python SDK 的相關文檔，這些文檔藉助 Sphinx 和 Read the Docs 主題構建而成。

🚀 快速開始

模型上下文協議（MCP）作為一個開放標準，明確了應用程序與大型語言模型（LLMs）的交互方式。本文檔旨在助力開發者達成以下目標：

• 洞悉 MCP 的核心概念。
• 搭建 MCP 服務器，以暴露資源、工具和提示。
• 創建 MCP 客戶端，用於連接 MCP 服務器。
• 探索高級主題與最佳實踐。

✨ 主要特性

我們的文檔對 FastMCP 進行了全面介紹，它是用於構建 MCP 服務器的高級 Pythonic 接口。FastMCP 最初是一個獨立項目，如今已集成到官方的 MCP Python SDK 中。它為開發者提供了一種友好的方式來創建 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。
• 用於自定義部署的直接執行。

📦 安裝指南

1. 安裝依賴

首先，確保已安裝 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

2. 構建文檔

要構建文檔：

make html

構建後的文檔將位於 _build/html/ 目錄中。

3. 即時預覽

為了即時預覽並自動重載：

sphinx-autobuild . _build/html

然後在瀏覽器中打開 http://localhost:8000。

💻 使用示例

基礎用法

from mcp.server.fastmcp import FastMCP

mcp = FastMCP("Demo 🚀")

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

📚 詳細文檔

在 GitHub Pages 上託管

你可以通過以下步驟將此文檔託管到 GitHub Pages：

1. 創建新倉庫
   • 登錄 GitHub。
   • 點擊 "新建倉庫"。
   • 填寫倉庫名稱（例如：yourusername/mcp-docs）。
   • 選擇初始化倉庫內容。
   • 點擊 "創建倉庫"。
2. 上傳文檔
   • 在新倉庫中，導航到 "Settings"（設置）。
   • 在左側菜單中選擇 "Pages"（頁面）。
   • 從下拉列表中選擇主分支或 gh - pages 分支。
   • 保存更改。
3. 訪問你的文檔網站
   • 完成後，GitHub Pages 將自動生成一個 URL，類似於：https://yourusername.github.io/mcp-docs/。
   • 訪問該鏈接查看你託管的 MCP 文檔。

貢獻指南

貢獻文檔以改進內容是受歡迎的！以下是貢獻步驟：

1. Fork 倉庫 在 GitHub 上 fork 此倉庫到你的賬戶中。
2. 創建功能分支
   • 在本地克隆 forked 的倉庫：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 Request 在原始倉庫的 "Pull Requests" 標籤下，點擊 "New Pull Request"。選擇你的 fork 倉庫和功能分支作為來源，然後提交請求。

資源

• 官方 MCP 網站
• MCP Python SDK GitHub
• MCP 規範
• 官方支持的服務器
• GitHub 討論區
• FastMCP GitHub（Legacy）

📄 許可證

此文檔以 MIT License 授權，具體請查看 LICENSE 文件。