MCP Server Tool 开发学习文档

MCP Server Tool 开发学习文档

目录

  1. MCP Server Tool 简介
  2. 核心开发流程与知识点详解
    • 2.1 工具函数的实现
    • 2.2 MCP Server 的注册与启动
    • 2.3 工具注册与调用机制
    • 2.4 工具列表的声明与返回
    • 2.5 传输方式(stdio 与 sse)
  3. Python 源码详细解析
  4. SSE 方式本地部署方法
  5. 客户端访问与调用示例

1. MCP Server Tool 简介

MCP(Model Context Protocol)是一种用于模型与外部工具交互的协议。MCP Server Tool 是基于 MCP 协议开发的服务端工具,能够通过标准输入输出(stdio)或服务端事件(SSE)等方式暴露自定义工具,供客户端远程调用。

本例实现了一个简单的“网站抓取”工具,支持通过 MCP 协议获取指定网页内容。


2. 核心开发流程与知识点详解

2.1 工具函数的实现

工具函数是 MCP Server Tool 的核心业务逻辑。例如本例中的 fetch_website,用于异步抓取网页内容:

async def fetch_website(url: str) -> list[types.TextContent | types.ImageContent | types.EmbeddedResource]:headers = {"User-Agent": "MCP Test Server (github.com/modelcontextprotocol/python-sdk)"}async with create_mcp_http_client(headers=headers) as client:response = await client.get(url)response.raise_for_status()return [types.TextContent(type="text", text=response.text)]
  • 异步实现:利用 async/await,适合高并发场景。
  • 类型注解:返回值为内容对象列表,支持文本、图片、嵌入资源。
  • 自定义 User-Agent:便于调试和识别请求来源。

2.2 MCP Server 的注册与启动

MCP Server 通过 Server 类实例化,并注册工具与工具列表:

app = Server("mcp-website-fetcher")
  • Server 名称:用于标识服务实例。
  • 注册工具与工具列表:通过装饰器 @app.call_tool()@app.list_tools() 实现。

2.3 工具注册与调用机制

工具注册函数用于处理客户端的工具调用请求:

@app.call_tool()
async def fetch_tool(name: str, arguments: dict) -> list[types.TextContent | types.ImageContent | types.EmbeddedResource]:if name != "fetch":raise ValueError(f"Unknown tool: {name}")if "url" not in arguments:raise ValueError("Missing required argument 'url'")return await fetch_website(arguments["url"])
  • 参数校验:确保工具名和参数正确。
  • 调用业务逻辑:将参数传递给实际的工具函数。

2.4 工具列表的声明与返回

通过 @app.list_tools() 注册工具列表,供客户端查询:

@app.list_tools()
async def list_tools() -> list[types.Tool]:return [types.Tool(name="fetch",description="Fetches a website and returns its content",inputSchema={"type": "object","required": ["url"],"properties": {"url": {"type": "string","description": "URL to fetch",}},},)]
  • Tool 对象:描述工具名称、功能、输入参数结构。
  • inputSchema:采用 JSON Schema 格式,便于前端自动生成表单或校验参数。

2.5 传输方式(stdio 与 sse)

MCP Server 支持两种传输方式:

  • stdio:通过标准输入输出进行通信,适合本地或嵌入式场景。
  • sse:通过 HTTP SSE(Server-Sent Events)协议,适合 Web 场景。

切换方式通过命令行参数 --transport 控制:

@click.option("--transport", type=click.Choice(["stdio", "sse"]), default="stdio", help="Transport type")
  • stdio 模式下,使用 mcp.server.stdio.stdio_server 启动服务。
  • sse 模式下,使用 starlette 框架和 uvicorn 启动 HTTP 服务,并挂载 SSE 路由。

3. Python 源码详细解析

3.1 入口函数

@click.command()
@click.option("--port", default=8000, help="Port to listen on for SSE")
@click.option("--transport", type=click.Choice(["stdio", "sse"]), default="stdio", help="Transport type")
def main(port: int, transport: str) -> int:...
  • 使用 click 实现命令行参数解析。
  • 根据 transport 参数选择不同的服务启动方式。

3.2 stdio 模式

from mcp.server.stdio import stdio_serverasync def arun():async with stdio_server() as streams:await app.run(streams[0], streams[1], app.create_initialization_options())anyio.run(arun)
  • 通过 anyio 启动异步主循环。
  • 适合本地开发和调试。

3.3 sse 模式

from mcp.server.sse import SseServerTransport
from starlette.applications import Starlette
from starlette.responses import Response
from starlette.routing import Mount, Routesse = SseServerTransport("/messages/")async def handle_sse(request):async with sse.connect_sse(request.scope, request.receive, request._send) as streams:await app.run(streams[0], streams[1], app.create_initialization_options())return Response()starlette_app = Starlette(debug=True,routes=[Route("/sse", endpoint=handle_sse, methods=["GET"]),Mount("/messages/", app=sse.handle_post_message),],
)import uvicorn
uvicorn.run(starlette_app, host="0.0.0.0", port=port)
  • 使用 starlette 框架搭建 HTTP 服务。
  • /sse 路由用于建立 SSE 连接。
  • /messages/ 路由用于消息传递。

4. SSE 方式本地部署方法

4.1 安装依赖

确保已安装 uvicornstarlettemcp 相关依赖:

pip install uvicorn starlette mcp

4.2 启动服务

python-sdk/examples/servers/simple-tool/ 目录下运行:

uv run mcp-simple-tool --transport sse --port 8000
  • --transport sse:指定使用 SSE 传输方式。
  • --port 8000:指定监听端口(可自定义)。

4.3 服务启动后,SSE 端点为:

  • /sse:用于建立 SSE 连接
  • /messages/:用于消息通信

5. 客户端访问与调用示例

5.1 客户端代码示例(STDIO,可类比改为 SSE)

import asyncio
from mcp.client.session import ClientSession
from mcp.client.sse import SseServerParameters, sse_clientasync def main():async with sse_client(SseServerParameters(url="http://localhost:8000/sse")) as (read, write):async with ClientSession(read, write) as session:await session.initialize()# 列出可用工具tools = await session.list_tools()print(tools)# 调用 fetch 工具result = await session.call_tool("fetch", {"url": "https://example.com"})print(result)asyncio.run(main())
  • SseServerParameters(url="http://localhost:8000/sse"):指定 SSE 服务端点。
  • session.list_tools():获取工具列表。
  • session.call_tool("fetch", {"url": "https://example.com"}):调用 fetch 工具抓取网页内容。

总结

  • MCP Server Tool 通过注册工具函数和工具列表,支持多种传输方式(stdio/sse)。
  • 工具函数需异步实现,参数和返回值需严格类型注解。
  • SSE 部署适合 Web 场景,需结合 starlette/uvicorn。
  • 客户端可通过 MCP 协议远程调用工具,支持自动发现和参数校验。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/web/80952.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

5月22总结

P1024 [NOIP 2001 提高组] 一元三次方程求解 题目描述 有形如:$ a x^3 b x^2 c x d 0 $ 这样的一个一元三次方程。给出该方程中各项的系数($ a,b,c,d $ 均为实数),并约定该方程存在三个不同实根(根的范围在 $ -1…

JavaScriptAPIs学习day3--事件高级

1. 注册事件(绑定事件) 1.1 注册事件概述 给元素添加事件,称为注册事件或者绑定事件。注册事件有两种方式:传统方式和方法监听注册方式。 1.2 addEventListener 事件监听方式 eventTarget.addEventListener(目标对象)方法将指定…

在 Ubuntu 24.04 LTS 上 Docker 部署 DB-GPT

一、DB-GPT 简介 DB-GPT 是一个开源的AI原生数据应用开发框架(AI Native Data App Development framework with AWEL(Agentic Workflow Expression Language) and Agents)。目的是构建大模型领域的基础设施,通过开发多模型管理(SMMF)、Text2SQL效果优化、RAG框架以及…

python-leetcode 69.最小栈

题目: 设计一个支持push,pop,top,操作,并能在常数时间内检索到最小元素的栈。 辅助栈法: 1:使用两个栈,一个主栈用于存储所有元素,另一个辅助栈用于存储当前元素的最小值 2: 每次push时,将元…

JVM部分内容

1.JVM内存区域划分 为什么要划分内存区域,JAVA虚拟机是仿照真实的操作系统进行设计的,JVM也就仿照了它的情况,进行了区域划分的设计。 JAVA进程也就是JAVA虚拟机会从操作系统申请内存空间给进程使用,JVM内存空间划分&#xff0c…

os:进程与线程上

os:进程与线程上 理解进程进程的地址空间进程的抽象:进程控制块进程的用户态和内核态五状态进程模型五状态进程模型转化带挂起的进程状态模型进程调度与切换进程调度进程切换理解进程 举个栗子 程序刚开始执行时,PC的值是m,指向代码段的第一条指令。 问题:如果想要重现…

RISC-V 开发板 MUSE Pi Pro CSI测试,一把点亮ov5647摄像头

视频讲解: RISC-V 开发板 MUSE Pi Pro CSI测试,一把点亮ov5647摄像头 手上正好有一颗ov5674,看了下接口排线都是一致的,硬件条件满足的情况下,剩下的就是驱动软件的问题,直接接上CSI排线 https://bianbu-li…

应用案例 | 集成Docker,解锁 HMI/网关的定制化应用

前言 在当今竞争激烈的工业市场中,企业对于工业自动化系统的个性化需求日益增长。无论是提升生产效率、优化设备管理,还是实现智能化的生产监控,企业都希望拥有能够精准匹配自身业务流程的定制化解决方案。然而,传统HMI/网关设备…

【VLNs篇】03:VLMnav-端到端导航与视觉语言模型:将空间推理转化为问答

栏目内容论文标题End-to-End Navigation with Vision-Language Models: Transforming Spatial Reasoning into Question-Answering (端到端导航与视觉语言模型:将空间推理转化为问答)核心问题如何利用大型视觉语言模型(VLM)实现端到端的机器人…

剧本杀小程序:指尖上的沉浸式推理宇宙

在推理热潮席卷社交圈的当下,你是否渴望随时随地开启一场烧脑又刺激的冒险?我们的剧本杀小程序,就是你掌心的“推理魔法盒”,一键解锁无限精彩! 海量剧本库,满足多元口味:小程序汇聚了从古风权…

[Vue]路径跳转和路由高级设置

路由基础使用看另一篇文章:路由基础使用和路径传参 基本属性 path: /, //主路径,也就是路由路径 alias: [/myfarie], //路径别名,即访问该路径时,也会访问到该资源 name:farie //设置名字,占位符传参时需要使用 component:()>…

LeetCode 76题「最小覆盖子串」

LeetCode 76题「最小覆盖子串」是一道经典的滑动窗口算法题目,难度为困难。题目要求在给定的字符串 s 中找到包含字符串 t 所有字符的最小子串,若不存在则返回空字符串。 题目分析 输入:字符串 s 和 t(均由英文字母组成&#xf…

JMeter-Websocket接口自动化

JMeter-Websocket接口自动化 结构图 1.准备2.实现思路2.1 通过HTTP请求获取token2.2 设置循环控制、断言变量2.3 建立WebSocket连接2.4 设置While循环控制读取CSV文件数据2.4.1 csv文件设置,一般这样设置参数即可变量名称:message,expected_steps 2.5 设…

大模型在闭合性胫骨平台骨折诊疗全流程中的应用研究报告

目录 一、引言 1.1 研究背景与目的 1.2 国内外研究现状 1.3 研究方法与创新点 二、大模型预测原理及数据基础 2.1 大模型概述 2.2 数据收集与处理 2.3 模型训练与优化 三、术前预测与方案制定 3.1 骨折类型及损伤程度预测 3.2 手术时机评估 3.3 手术方案制定 3.4 …

Dify大语言模型应用开发环境搭建:打造个性化本地LLM应用开发工作台

文章目录 前言1. Docker部署Dify2. 本地访问Dify3. Ubuntu安装Cpolar4. 配置公网地址5. 远程访问6. 固定Cpolar公网地址7. 固定地址访问 前言 各位小伙伴们,大家好!今天我们要来一场技术大冒险,手把手教你如何在Linux Ubuntu系统上使用Docke…

【MySQL成神之路】MySQL插入、删除、更新操作汇总

MySQL 插入、删除和更新操作详解 一、插入数据(INSERT) 1. 基本插入语法 2. 插入多行数据 3. 从其他表插入数据 4. 插入NULL值和默认值 二、更新数据(UPDATE) 1. 基本更新语法 2. 使用子查询更新 3. 批量更新注意事项 三、删除数据(DELETE) 1. 基本删除语法 2. 清空…

亚马逊第四个机器人中心将如何降低30%配送成本?

近年来,亚马逊越来越依赖自动化技术来提升仓储效率和配送速度。2024年,亚马逊宣布其全球第四个机器人中心在美国正式投入运营,这一中心将成为改变供应链策略的新变量。据亚马逊官方消息,这一机器人中心有望帮助公司进一步削减运营…

MongoDB大数据量的优化——mongoTemplate.stream()方法使用

传统查询 在传统的 MongoDB 查询中&#xff0c;我们通常使用find方法&#xff1a; List<Document> results mongoTemplate.find(query, Document.class, "collection");这种方式会直接将查询结果全部加载到内存中&#xff0c;当数据量较大&#xff08;如百万…

JDK8中的 Stream流式编程用法优化(工具类在文章最后)

Java从JDK8起提供了Stream流这个功能&#xff0c;于是项目里出现了大量基于Stream流的写法。随着项目的进行&#xff0c;慢慢的代码中铺天盖地的都是下面的写法&#xff1a; List<User> userList null;if (condition) {userList new ArrayList<>();userList.add(…

Spring Cloud生态与技术选型指南:如何构建高可用的微服务系统?

引言&#xff1a;为什么选择Spring Cloud&#xff1f; 作为全球开发者首选的微服务框架&#xff0c;Spring Cloud凭借其开箱即用的组件、与Spring Boot的无缝集成&#xff0c;以及活跃的社区生态&#xff0c;成为企业级微服务架构的基石。但在实际项目中&#xff0c;如何从众多…