使用说明

项目简介

python-sdk 仓库是 Model Context Protocol (MCP) 的 Python 软件开发工具包 (SDK),旨在帮助开发者快速构建 MCP 客户端和服务器。MCP 协议为大型语言模型 (LLM) 应用定义了一套标准化的上下文服务框架,使得应用能够安全、可扩展地向 LLM 提供丰富的上下文信息和功能。该 SDK 提供了构建 MCP 服务器所需的核心组件和便捷接口,简化了资源、工具和 Prompt 模板的开发与管理。

主要功能点

  • 资源 (Resources) 管理: 轻松托管和管理各种数据资源,并以标准化的方式供 LLM 客户端访问。
  • 工具 (Tools) 注册与执行: 支持注册和执行外部功能模块,允许 LLM 客户端通过服务器安全地调用这些工具。
  • Prompt 模板 (Prompts) 定义与渲染: 提供 Prompt 模板的定义和管理能力,支持根据客户端请求动态生成 Prompt,实现定制化的 LLM 交互模式。
  • 标准传输协议: 支持 Stdio 和 SSE 等多种传输协议,方便与不同类型的 MCP 客户端集成。
  • 服务器生命周期管理: 提供生命周期管理 API,支持服务器启动和关闭时的资源初始化和清理。
  • 快速开发框架 (FastMCP): 提供高层次的 FastMCP 框架,简化 MCP 服务器的开发流程,开发者可以更专注于业务逻辑的实现。

安装步骤

推荐使用 'uv' 包管理器安装 SDK 和命令行工具:

uv add "mcp[cli]"

或者使用 'pip' 安装:

pip install mcp

服务器配置

MCP 服务器是为 MCP 客户端提供服务的后端应用。客户端需要配置服务器的启动命令和参数才能建立连接。以下是一个基于 'Quickstart' 示例生成的服务器配置 JSON,客户端可以根据此配置连接到使用 'server.py' 启动的 MCP 服务器。

{
  "serverName": "Demo Server",
  "command": "mcp",
  "args": [
    "run",
    "server.py"
  ],
  "env": {},
  "transport": "stdio"
}

配置参数说明:

  • 'serverName': MCP 服务器的名称,客户端用于标识和区分不同的服务器连接。
  • 'command': 启动 MCP 服务器的命令,通常是 Python 解释器路径 ('python') 或 'mcp run' 命令。
  • 'args': 传递给启动命令的参数列表。对于 Python 服务器,通常包含服务器脚本的路径 ('server.py')。
  • 'env': 环境变量配置,可以用于传递 API 密钥、数据库连接信息等敏感配置。本示例中为空。
  • 'transport': 指定客户端与服务器之间的通信协议,默认为 'stdio' (标准输入输出)。

基本使用方法

  1. 创建 MCP 服务器: 参考 'Quickstart' 示例,编写 Python 脚本 'server.py',使用 'FastMCP' 框架定义资源和工具。
  2. 运行开发服务器: 使用 'mcp dev server.py' 命令快速启动开发服务器,方便本地测试和调试。
  3. 安装到 Claude Desktop: 使用 'mcp install server.py' 命令将服务器安装到 Claude Desktop 应用中,实现与 Claude 的集成。
  4. 直接运行服务器: 对于更高级的部署场景,可以使用 'mcp run server.py' 或 'python server.py' 命令直接运行服务器。

更多详细用法和高级特性,请参考仓库中的 README 文档和示例代码。

信息

分类

开发者工具