使用说明

项目简介

'mcp-community' 是一个基于 Python 的开源库,旨在帮助开发者快速搭建和使用 MCP (Model Context Protocol) 服务器。它提供了一系列预构建的 MCP 服务器示例,如计算器和 DuckDuckGo 搜索,以及配套的客户端工具,方便 LLM (大型语言模型) 应用集成外部资源和功能。

主要功能点

  • 预构建 MCP 服务器示例: 包含 'CalculatorMCP' (提供基础数学计算工具) 和 'DuckDuckGoMCP' (提供 DuckDuckGo 网页搜索工具) 等开箱即用的服务器。
  • 便捷的服务器运行工具: 提供 'run_mcp' 和 'run_mcp_async' 函数,可以轻松启动基于 SSE (Server-Sent Events) over HTTP 的 MCP 服务器。
  • Python MCP 客户端: 提供 'mcp_client' 工具,方便 Python 应用连接和调用 MCP 服务器提供的工具。
  • 示例代码: 包含详细的示例代码,演示如何启动服务器、配置客户端以及使用预构建的 MCP 服务器。

安装步骤

  1. 环境准备: 确保已安装 Python 环境。建议使用 Python 3.7 或更高版本。
  2. 克隆仓库: 使用 Git 克隆 'mcp-community' 仓库到本地:
    git clone https://github.com/Mirascope/mcp-community.git
  3. 进入 Python 目录: 切换到仓库的 'python' 目录:
    cd mcp-community/python
  4. 安装 Python 包: 使用 pip 安装 'mcp_community' 包及其依赖:
    pip install .
    或者使用可编辑模式安装,方便开发调试:
    pip install -e .

服务器配置

MCP 客户端需要配置 MCP 服务器的启动信息才能建立连接。以下是预构建服务器的配置示例,客户端可以根据需要进行配置。配置信息为 JSON 格式,请复制以下 JSON 代码到您的 MCP 客户端配置中。

CalculatorMCP 服务器配置:

{
  "serverName": "CalculatorMCP Server",
  "command": "python -m mcp_community.servers.calculator",
  "args": [],
  "description": "运行一个计算器 MCP 服务器,提供加、减、乘、除等基础数学运算工具。"
}

DuckDuckGoMCP 服务器配置:

{
  "serverName": "DuckDuckGoMCP Server",
  "command": "python -m mcp_community.servers.duckduckgo",
  "args": [],
  "description": "运行一个 DuckDuckGo 搜索 MCP 服务器,提供文本、新闻和图片搜索工具。"
}

配置说明:

  • 'serverName': 服务器名称,用于在客户端标识服务器。
  • 'command': 启动服务器的命令。这里使用 'python -m' 方式运行 Python 模块。
  • 'args': 启动命令的参数,本例中预构建的服务器不需要额外参数,所以为空数组。
  • 'description': 服务器的描述信息,方便用户理解服务器的功能。

注意: 请确保您的 Python 环境配置正确,并且 'python' 命令在系统 PATH 环境变量中可访问。

基本使用方法

  1. 启动 MCP 服务器: 根据您需要的功能,选择启动 'CalculatorMCP' 或 'DuckDuckGoMCP' 服务器。可以通过运行示例代码或直接执行服务器模块来启动。例如,运行 'python -m mcp_community.servers.calculator' 即可启动 'CalculatorMCP' 服务器。
  2. 配置 MCP 客户端: 在您的 MCP 客户端应用中,配置服务器连接信息,包括服务器地址 (默认为 'http://localhost:8000/sse') 和上述提供的服务器配置 JSON。
  3. 客户端连接与交互: 使用 'mcp_community' 提供的 'mcp_client' 或其他 MCP 客户端库,连接到运行中的 MCP 服务器。通过客户端,您可以列出服务器提供的工具,并调用这些工具来增强 LLM 应用的功能。
  4. 参考示例代码: 仓库中的 'python/mcp_community/examples/' 目录下提供了详细的客户端和服务端示例代码,可以帮助您快速上手。

信息

分类

AI与计算