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 文件。