MCP Python SDK Documentation

MCP Python SDK Documentation

好的,请提供您想让我翻译的 Read the Docs 文档内容,关于 MIT 去中心化 AI,MCP 黑客马拉松。 我会尽力将其翻译成准确且自然的中文。

aidecentralized

开发者工具
访问服务器

README

MCP Python SDK 文档

本仓库包含模型上下文协议 (MCP) Python SDK 的文档。它使用 Sphinx 和 Read the Docs 主题构建。

概述

模型上下文协议 (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。 然后,安装所需的软件包:

    # 使用 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。

托管在 GitHub Pages 上

您可以按照以下步骤将此文档托管在 GitHub Pages 上:

  1. 创建 GitHub 仓库

    # 如果您尚未初始化本地仓库,请初始化
    git init
    git add .
    git commit -m "Initial commit with MCP documentation"
    
    # 通过 Web 界面在 GitHub 上创建一个仓库
    # 然后添加远程仓库并推送
    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 Actions 工作流程,位于 .github/workflows/docs.yml,它会在您每次推送到 main 分支时自动构建文档并将其部署到 GitHub Pages。

    1. 转到您的 GitHub 仓库
    2. 导航到 "Settings" > "Pages"
    3. 在 "Source" 下,选择 "GitHub Actions"
    4. 确保在您第一次推送后 "GitHub Actions" 工作流程正在运行

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

    如果您更喜欢手动管理部署:

    # 创建一个孤立的 gh-pages 分支
    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
    
    # 构建文档并将其复制到 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. 更新文档

    每当您想更新文档时:

    # 如果使用 GitHub Actions
    # 只需将您的更改推送到 main 分支
    git add .
    git commit -m "Update documentation"
    git push origin main
    
    # 如果使用手动 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
    

文档结构

  • 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

资源

许可证

本文档根据 MIT 许可证获得许可 - 有关详细信息,请参阅 LICENSE 文件。

推荐服务器

Playwright MCP Server

Playwright MCP Server

一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。

官方
精选
TypeScript
Magic Component Platform (MCP)

Magic Component Platform (MCP)

一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。

官方
精选
本地
TypeScript
MCP Package Docs Server

MCP Package Docs Server

促进大型语言模型高效访问和获取 Go、Python 和 NPM 包的结构化文档,通过多语言支持和性能优化来增强软件开发。

精选
本地
TypeScript
Claude Code MCP

Claude Code MCP

一个实现了 Claude Code 作为模型上下文协议(Model Context Protocol, MCP)服务器的方案,它可以通过标准化的 MCP 接口来使用 Claude 的软件工程能力(代码生成、编辑、审查和文件操作)。

精选
本地
JavaScript
@kazuph/mcp-taskmanager

@kazuph/mcp-taskmanager

用于任务管理的模型上下文协议服务器。它允许 Claude Desktop(或任何 MCP 客户端)在基于队列的系统中管理和执行任务。

精选
本地
JavaScript
mermaid-mcp-server

mermaid-mcp-server

一个模型上下文协议 (MCP) 服务器,用于将 Mermaid 图表转换为 PNG 图像。

精选
JavaScript
Jira-Context-MCP

Jira-Context-MCP

MCP 服务器向 AI 编码助手(如 Cursor)提供 Jira 工单信息。

精选
TypeScript
Linear MCP Server

Linear MCP Server

一个模型上下文协议(Model Context Protocol)服务器,它与 Linear 的问题跟踪系统集成,允许大型语言模型(LLM)通过自然语言交互来创建、更新、搜索和评论 Linear 问题。

精选
JavaScript
Sequential Thinking MCP Server

Sequential Thinking MCP Server

这个服务器通过将复杂问题分解为顺序步骤来促进结构化的问题解决,支持修订,并通过完整的 MCP 集成来实现多条解决方案路径。

精选
Python
Curri MCP Server

Curri MCP Server

通过管理文本笔记、提供笔记创建工具以及使用结构化提示生成摘要,从而实现与 Curri API 的交互。

官方
本地
JavaScript