使用说明
项目简介
Micro.mcp 是一个基于 Python 的微型 Model Context Protocol (MCP) 服务器框架。它简化了 MCP 服务器的构建过程,允许开发者轻松地将资源、工具和 Prompt 模板集成到统一的后端服务中,为大型语言模型 (LLM) 应用提供结构化的上下文信息。该框架旨在降低 MCP 服务器的开发门槛,让开发者能够专注于业务逻辑的实现,而无需过多关注底层协议细节。
主要功能点
- 资源管理: 支持以标准化的方式托管和访问各种类型的数据资源,例如示例中的 'greeting://{name}' 资源,可以根据客户端请求动态生成数据。
- 工具注册与执行: 允许注册 Python 函数作为 MCP 工具,并通过标准接口暴露给 LLM 客户端调用,例如示例中的 'add' 工具,可以执行加法运算。
- 快速启动: 基于 'FastMCP' 类,可以快速创建一个功能完备的 MCP 服务器实例。
- 易于扩展: 通过简单的装饰器 ('@mcp.tool()', '@mcp.resource()') 即可扩展服务器的功能。
- 示例代码: 提供清晰的示例代码,展示如何定义资源和工具,方便用户快速上手。
安装步骤
- 环境准备: 确保已安装 Python 3.7 或更高版本。
- 下载仓库: 从 GitHub 克隆或下载 'micro.mcp' 仓库到本地。由于该仓库目前似乎是作为 SDK 的一部分,可能需要从 SDK 中找到 'micro.mcp' 的 server 部分,或者直接使用仓库中的 'server.py' 文件。
- 安装依赖 (可能需要,根据实际SDK情况而定): 如果需要安装依赖,请根据 'README.md' 或项目文档进行操作。但根据提供的代码片段,可能无需额外安装依赖。
服务器配置
MCP 客户端需要配置以下信息以连接到 Micro.mcp 服务器。以下是基于 'server.py' 示例生成的配置信息:
{ "serverName": "Demo MCP Server", // MCP 服务器的名称,可以自定义 "command": "python", // 启动服务器的命令,这里假设您的 Python 可执行文件在 PATH 环境变量中 "args": ["server.py"] // 启动命令的参数,指向 server.py 脚本文件 }
参数注释:
- 'serverName': 为您的 MCP 服务器指定一个易于识别的名称。
- 'command': 指定用于启动服务器进程的可执行命令。通常是 'python' 或 'python3'。
- 'args': 一个字符串数组,包含传递给 'command' 的参数。这里 '["server.py"]' 表示执行当前目录下的 'server.py' 文件。如果 'server.py' 文件不在 MCP 客户端的当前工作目录,您需要提供文件的完整或相对路径。
如果使用 'src/micromcp/demo/about_hawky/server.py' 示例,则配置可能为:
{ "serverName": "Hawky Demo MCP Server", "command": "python", "args": ["src/micromcp/demo/about_hawky/server.py"] }
请根据实际使用的 'server.py' 文件的路径调整 'args' 参数。
基本使用方法
- 启动 MCP 服务器: 在安装步骤完成且配置正确后,在终端中导航到包含 'server.py' 文件的目录,并执行 'python server.py' (或 'python src/micromcp/demo/about_hawky/server.py') 命令来启动 MCP 服务器。服务器将开始监听来自 MCP 客户端的请求。
- 配置 MCP 客户端: 在您的 MCP 客户端应用中,配置连接到 Micro.mcp 服务器所需的信息,主要是上面提供的 JSON 配置。确保客户端能够正确连接到服务器运行的地址和端口(如果 'FastMCP' 支持配置端口,则需要相应配置,但默认配置通常已足够)。
- 使用 MCP 客户端与服务器交互: 通过 MCP 客户端,您可以向 Micro.mcp 服务器发送请求,例如:
- 读取资源: 客户端可以请求访问已注册的资源,如 'greeting://John',服务器将返回 "Hello, John!"。
- 调用工具: 客户端可以调用已注册的工具,如 'add' 工具,并传递参数,服务器将执行工具并返回结果。
- 获取 Prompt: (如果实现了 Prompt 模板功能,根据实际仓库代码判断) 客户端可以请求获取预定义的 Prompt 模板,用于与 LLM 进行交互。
请参考 Model Context Protocol 的官方文档和 MCP 客户端的文档,了解如何构建和发送 MCP 请求,以及如何处理服务器的响应。
信息
分类
开发者工具