如何在本地设置和启动完整的 MCP Gateway 开发环境
本文档介绍如何在本地设置和启动完整的 MCP Gateway 开发环境,包括启动所有必要的服务组件。
在开始之前,请确保你的系统已安装以下软件:
版本控制工具
Go 编程语言环境
JavaScript 运行时环境(包含 npm)
MCP Gateway 项目由以下几个核心组件组成:
apiserver
提供配置管理、用户接口等 API 服务
mcp-gateway
核心网关服务,处理 MCP 协议转换
mock-server
模拟用户服务,用于开发测试
web
管理界面前端
Fork 项目
访问 MCP Gateway 代码仓库,点击 Fork
按钮,将项目 fork 到你的 GitHub 账户下
克隆到本地
安装 Go 依赖
安装 Node.js 依赖
后端配置
前端配置
可以不修改任何东西,使用默认配置启动就可以开始开发。你也可以修改配置文件来满足你的环境或开发需求,比如切换 Disk、DB 等存储方式。
你需要 4 个终端窗口来运行所有服务。这种在宿主机上运行多个服务的方式,在开发过程中可以轻松的重启调试。
mcp-gateway 默认会在 http://localhost:5235
上启动,用于处理 MCP 协议请求。
apiserver 默认会在 http://localhost:5234
上启动。
http://localhost:5236
上启动http://localhost:5237
上启动web 终端运行命令后,会显示访问的地址。
启动完成后,你可以在浏览器中访问终端显示的地址来访问管理界面。
SUPER_ADMIN_USERNAME
决定SUPER_ADMIN_PASSWORD
决定登录后可以在管理界面中修改用户名和密码
某些服务可能需要特定的环境变量才能正常工作。可以在 .env
文件中设置这些变量:
如果遇到端口冲突,可以在环境变量中修改端口配置:
如果遇到依赖安装问题:
Go 依赖问题
Node.js 依赖问题
添加上游仓库
同步上游代码
创建功能分支
开发完成后推送
创建 Pull Request
在 GitHub 上创建 Pull Request,将你的分支合并到主仓库的 main 分支
使用 feat/
前缀,如 feat/add-auth-module
使用 fix/
前缀,如 fix/memory-leak
测试
在提交 PR 之前,确保你的代码已经通过所有测试
代码同步
保持你的 fork 仓库与上游仓库同步,避免代码冲突
代码规范
遵循项目的代码规范和提交信息格式
成功启动本地开发环境后,你可以: