使用说明
项目简介
本项目是一个 MCP 服务器的示例模板,旨在帮助开发者快速构建自定义工具,集成到 Cursor IDE 等 MCP 客户端中。它包含两个简单的工具:
- 网页抓取工具 (mcp_fetch): 根据提供的 URL 抓取网页内容。
- 心情查询工具 (mood): 返回服务器的心情状态,始终是积极友好的。
主要功能点
- 提供工具: 实现了 'mcp_fetch' 和 'mood' 两个工具,演示了如何扩展 MCP 服务器的功能。
- 支持多传输协议: 支持 Stdio 和 SSE 两种 MCP 传输协议,可以灵活部署和连接。
- 易于部署: 提供 Docker 一键部署和 Heroku 快速部署选项,方便用户快速启动服务器。
- 模板项目: 作为一个模板,方便开发者在此基础上扩展和定制自己的 MCP 服务器。
安装步骤
1. 环境准备
确保你的机器上已安装 Python 3.8+ 和 pip 或 uv 包管理器。推荐使用 uv 包管理器,安装命令如下:
# macOS brew install uv # 其他系统可以使用 pip pip install uv
2. 克隆仓库
git clone https://github.com/kirill-markin/example-mcp-server.git cd example-mcp-server
3. 安装依赖
使用 uv 安装项目依赖和开发依赖:
uv pip install -e ".[dev]"
4. 运行服务器
你可以选择 Stdio 或 SSE 两种方式运行服务器。
- Stdio 方式 (本地开发推荐)
直接运行 'cursor-run-mcp-server.sh' 脚本。
uv run mcp-simple-tool
- SSE 方式 (远程部署或集成到 Cursor IDE)
指定 '--transport sse' 参数和端口号运行。
uv run mcp-simple-tool --transport sse --port 8000
或者使用 Docker Compose 部署:
docker compose up --build -d
服务器配置 (Cursor IDE)
在 Cursor IDE 中配置 MCP 服务器,需要提供服务器的启动命令或 URL。
- Stdio 配置 (本地运行)
- Server Name: 'my-mcp-server' (自定义名称)
- Type: 'stdio'
- Command: '/path/to/example-mcp-server/cursor-run-mcp-server.sh' (请替换为 'cursor-run-mcp-server.sh' 脚本的实际绝对路径,可以通过在 Cursor 中右键点击该文件 -> "Copy Path" 获取)
- Args: '[]' (空数组)
- SSE 配置 (Docker 或 Heroku 部署)
- Server Name: 'my-mcp-server' (自定义名称)
- Type: 'sse'
- URL: 'http://localhost:8000/sse' (如果使用 Docker 部署在本地,则为 'http://localhost:8000/sse';如果部署在 Heroku,则为你的 Heroku 应用 URL 加上 '/sse' 路径,例如 'https://your-app-name.herokuapp.com/sse')
基本使用方法
- 在 Cursor IDE 的设置 (Settings -> Features -> MCP Servers) 中,点击 "Add new MCP server",根据你的服务器运行方式 (Stdio 或 SSE) 填写上述配置信息。
- 配置完成后,在 Cursor IDE 中与 AI Agent 对话时,即可使用 MCP 服务器提供的工具。例如,你可以询问:
- "请使用 mcp_fetch 工具抓取 https://www.example.com 的内容"
- "服务器现在心情怎么样?"
AI Agent 将会调用 MCP 服务器的工具并返回结果。
信息
分类
网页与API