使用说明
项目简介
本项目是一个基于 Vercel Serverless Functions 部署的 MCP (Model Context Protocol) 服务器模板。它允许开发者快速搭建 MCP 后端服务,用于管理和提供 LLM 应用所需的上下文信息、工具和 Prompt 模板。
主要功能点
- MCP 协议兼容: 实现了 MCP 协议,可以与任何 MCP 客户端进行通信。
- 资源、工具和 Prompt 管理: 支持在服务器端注册和管理资源 (Resources)、工具 (Tools) 和 Prompt 模板 (Prompts)。
- Serverless 部署: 基于 Vercel Serverless Functions 部署,易于扩展和维护。
- SSE 通信: 使用 Server-Sent Events (SSE) 作为主要的客户端通信协议,实现实时的双向通信。
- Redis 支持: 使用 Redis 进行会话管理和消息队列,保证服务器的稳定性和可扩展性。
- 工具示例: 内置了一个简单的 'echo' 工具作为示例,方便用户快速上手。
安装步骤
- 部署模板: 点击仓库 README.md 文件中的 "Deploy the MCP template" 链接,即可快速部署到 Vercel。
- 配置 Redis: 确保你的 Vercel 项目已关联 Redis 数据库,并设置环境变量 'REDIS_URL' 指向你的 Redis 连接地址。你可以在 Vercel 项目的 "Settings" -> "Environment Variables" 中进行配置。
- 启用 Fluid Compute (可选): 为了获得更高效的执行性能,建议在 Vercel 项目中启用 Fluid Compute 功能。
- 调整最大执行时长 (可选): 如果你使用的是 Vercel Pro 或 Enterprise 账户,可以根据需要调整 'vercel.json' 文件中的 'maxDuration' 参数,例如设置为 800 秒。
服务器配置
MCP 客户端需要配置以下信息才能连接到此 MCP 服务器:
{ "serverName": "vercel-mcp-server", "command": "sse", "args": { "url": "YOUR_VERCEL_DEPLOYMENT_URL/api/server/sse" } }
- 'serverName': 自定义的服务器名称,例如 "vercel-mcp-server"。
- 'command': 指定客户端连接服务器的命令,这里固定为 "sse" (Server-Sent Events)。
- 'args': 连接参数,以 JSON 对象形式提供。
- 'url': 必须替换 'YOUR_VERCEL_DEPLOYMENT_URL' 为你的 Vercel 应用部署后的实际 URL,并确保路径为 '/api/server/sse'。这是服务器 SSE 协议的端点地址。
基本使用方法
- 部署服务器: 按照安装步骤完成服务器在 Vercel 上的部署。
- 配置 MCP 客户端: 在你的 MCP 客户端应用中,配置上述服务器配置信息,确保 'url' 参数指向你部署的 Vercel 应用的 SSE 端点。
- 自定义服务器功能: 修改 'api/server.ts' 文件,根据你的需求添加和注册更多的工具 (Tools)、资源 (Resources) 和 Prompt 模板 (Prompts)。参考 MCP TypeScript SDK 文档 了解如何进行自定义开发。
- 测试连接: 使用 'script/test-client.mjs' 脚本作为示例客户端,测试与你的 MCP 服务器的连接和工具调用。
信息
分类
AI与计算