使用说明
项目简介
本项目是一个简单的 MCP (Model Context Protocol) 服务器示例,旨在帮助开发者了解如何为 Cursor 编辑器构建 MCP 服务器。该服务器通过定义工具的方式,向连接的 LLM 客户端(如 Cursor)提供预设的用户信息,例如用户名、年龄、位置和兴趣爱好。
主要功能点
- 工具注册: 通过简单的 Python 装饰器 '@mcp.tool()',快速注册可以被 LLM 客户端调用的工具函数。
- 用户信息提供: 预置了获取用户名、年龄、位置和兴趣爱好等用户信息的工具。
- 标准 MCP 服务器: 使用 'mcp' 库构建,遵循 MCP 协议,能够与任何兼容 MCP 协议的客户端进行通信。
- 简单易用: 代码结构清晰,易于理解和上手,适合初学者学习 MCP 服务器开发。
安装步骤
- 安装 Python 虚拟环境管理工具 uv: 如果尚未安装 uv,请先安装 uv。
- 创建并激活虚拟环境: 在项目根目录下,运行命令 'uv venv' 创建虚拟环境,然后运行 'source venv/bin/activate' 激活虚拟环境。
- 安装依赖: 在虚拟环境下,运行命令 'uv add "mcp[cli]"' 安装 'mcp' 库。
服务器配置
对于 MCP 客户端(例如 Cursor 编辑器),您需要配置以下服务器信息以连接到此 MCP 服务器。请将以下 JSON 配置添加到您的 MCP 客户端配置中。
{ "serverName": "about-me", "command": "python", "args": ["project/main.py"] }
配置参数说明:
- 'serverName': 服务器名称,这里设置为 "about-me",与代码中 'FastMCP("about-me")' 初始化时定义的名称一致。
- 'command': 启动服务器的命令,这里使用 'python' 命令来运行 Python 脚本。
- 'args': 传递给启动命令的参数,这里指定要运行的 Python 脚本路径为 'project/main.py'。
基本使用方法
- 启动服务器: 按照上述安装步骤配置好环境后,在项目根目录下,确保虚拟环境已激活,然后 MCP 服务器将在后台运行,并通过 'stdio' 传输协议与客户端通信。
- 在 MCP 客户端中使用: 在 Cursor 编辑器或其他 MCP 客户端中配置好上述服务器信息后,客户端将能够连接到此 MCP 服务器。客户端可以通过 MCP 协议调用服务器提供的工具,例如 'get_user_name'、'get_user_age' 等,从而获取预设的用户信息,并将这些信息作为上下文提供给 LLM 模型使用。
信息
分类
开发者工具