MCP Python SDK Documentation

MCP Python SDK 文档

此代码仓库包含 Model Context Protocol（MCP）Python SDK 的文档。文档使用 Sphinx 和 Read the Docs 主题构建。

概述

Model Context Protocol（MCP）是一项开放标准，用于定义应用程序如何与大模型（LLM）交互。本文档旨在帮助开发者：

• 了解 MCP 的核心概念
• 构建 MCP 服务，以公开资源、工具和提示词
• 创建 MCP 客户端，以连接 MCP 服务
• 探索高级主题和最佳实践

FastMCP

我们的文档全面介绍了 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 Inspector 的开发模式
• 与 Claude Desktop 集成
• 直接执行，以用于自定义部署

构建文档

1. 安装依赖项

   首先，确保已安装 Python。然后，安装所需的软件包：

   # Using conda (recommended)
   conda activate cuda_test
   pip install -r requirements.txt
   
   # Or using pip in a virtual environment
   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   pip install -r requirements.txt
   

2. 构建文档

   构建文档：

   make html
   

   构建后的文档将位于 _build/html/ 目录中。

3. 实时预览

   如需实时预览并自动重新加载：

   sphinx-autobuild . _build/html
   

   然后在浏览器中打开 http://localhost:8000。

在 GitHub Pages 上托管

你可以按照以下步骤在 GitHub Pages 上托管本文档：

1. 创建 GitHub 仓库

   # Initialize a local repository if you haven't already
   git init
   git add .
   git commit -m "Initial commit with MCP documentation"
   
   # Create a repository on GitHub through the web interface
   # Then add the remote and push
   git remote add origin https://github.com/yourusername/mcp_docs.git
   git push -u origin main
   

2. 设置 GitHub Pages

   设置文档的 GitHub Pages 有两种方式：

   选项 1：使用 GitHub Actions（推荐）

   仓库已包含位于 .github/workflows/docs.yml 的 GitHub Actions 工作流。每当你推送到 main 分支时，它都会自动构建文档并将其部署到 GitHub Pages。

   1. 前往你的 GitHub 仓库
   2. 进入“Settings” > “Pages”
   3. 在“Source”下，选择“GitHub Actions”
   4. 首次推送后，确认“GitHub Actions”工作流正在运行

   选项 2：使用 gh-pages 分支手动设置

   如果你更愿意手动管理部署：

   # Create an orphan gh-pages branch
   git checkout --orphan gh-pages
   git rm -rf .
   touch .nojekyll
   git add .nojekyll
   git commit -m "Initial gh-pages commit"
   git push origin gh-pages
   git checkout main
   
   # Build and copy the documentation to gh-pages
   make html
   git checkout gh-pages
   cp -r _build/html/* .
   git add .
   git commit -m "Update documentation"
   git push origin gh-pages
   git checkout main
   

   然后前往 GitHub 仓库的 Settings > Pages，并选择 gh-pages 分支作为源。

3. 访问文档

   你的文档将在以下地址提供： https://yourusername.github.io/mcp_docs/

4. 更新文档

   每当你想要更新文档时：

   # If using GitHub Actions
   # Just push your changes to the main branch
   git add .
   git commit -m "Update documentation"
   git push origin main
   
   # If using manual gh-pages setup
   make html
   git checkout gh-pages
   cp -r _build/html/* .
   git add .
   git commit -m "Update documentation"
   git push origin gh-pages
   git checkout main
   

文档结构

• index.rst：主入口
• introduction.rst：MCP 简介
• getting-started.rst：入门指南
• server-guide.rst：构建 MCP 服务指南
• client-guide.rst：构建 MCP 客户端指南
• examples.rst：MCP 应用示例
• advanced-topics.rst：MCP 高级概念
• api-reference.rst：API 参考

贡献

欢迎提交改进文档的贡献！你可以通过以下方式参与：

1. Fork 仓库
2. 为你的更改创建一个新分支
3. 进行更改
4. 构建文档，以验证你的更改
5. 提交 pull request

资源

• MCP 官方网站
• MCP Python SDK GitHub
• MCP 规范
• 官方支持的服务
• GitHub 讨论区
• FastMCP GitHub（旧版）

许可证

本文档采用 MIT License 许可，详情请参阅 LICENSE 文件。