English | 中文版
DemoSite : demo.mcpcan.com（login: admin/admin123） | MainSite : www.mcpcan.com
文档

MCPCan是一个专注于高效管理MCP（模型上下文协议）服务的开源平台，通过现代化的Web界面为DevOps和开发团队提供全面的MCP服务生命周期管理能力。 MCPCan支持多协议兼容与转换，能够在不同MCP服务架构之间实现无缝集成，同时提供可视化监控、安全认证和一站式部署功能。

💡 简介

MCPCan是一个开源平台，专注于高效管理MCP（模型上下文协议）服务，通过现代化的Web界面为DevOps和开发团队提供全面的MCP服务生命周期管理能力。 MCPCan支持多协议兼容与转换，能够在不同MCP服务架构之间实现无缝集成，同时提供可视化监控、安全认证和一站式部署功能。

✨ 核心特性

• 🎯 统一管理：集中管理所有MCP服务实例及配置
• 🔄 协议转换：支持多种MCP协议之间的无缝转换
• 📊 实时监控：提供详细的服务状态与性能监控数据
• 🔐 安全认证：内置身份认证与权限管理系统
• 🚀 一站式部署：快速发布、配置和分发MCP服务
• 📈 可扩展性：基于Kubernetes的云原生架构

✨ 演示与官方网站

为了获得最佳演示体验，请直接访问DemoSite : demo.mcpcan.com（login: admin/admin123）。
观看我们的Bilibili演示视频： BV1htBXBbECr
如需查看我们的官方网站地址，只需点击MainSite : www.mcpcan.com。

👨‍🚀 快速入门

有关详细的部署说明，请参阅我们的部署指南。

1. 获取部署仓库

# 推荐使用GitHub
git clone https://github.com/Kymo-MCP/mcpcan.git
cd mcpcan/deploy/docker-compose/

2. 启动服务

Docker Compose快速启动（推荐）

适用于本地开发、测试以及轻量级生产部署。

# 1. 初始化配置
cp example.env .env
# （可选）修改.env文件中的REGISTRY_PREFIX等设置，以切换全球镜像或国内镜像

# 2. 生成最终配置
chmod +x replace.sh
./replace.sh

# 3. 启动服务
docker compose up -d

# 4. 访问Web界面
登录：admin/admin123

安装成功后，访问http://localhost（或http://<您的公网IP>）即可开始使用。

Helm安装

适用于Kubernetes环境部署，请参考Helm部署指南。

🚀 组件

MCPCan采用微服务架构，由以下核心组件组成：

组件名称	目录路径	功能描述
MCPCan-Web	frontend/	基于Vue 3的管理UI
MCP-Market	backend/cmd/market/	核心业务：市场与实例管理
MCP-Authz	backend/cmd/authz/	RBAC、用户与部门管理

🐧 技术栈

🐧 前端

• 框架：Vue 3.5.x（Composition API）
• 构建工具：Vite 7.0
• UI组件：Element Plus
• 状态管理：Pinia 3.0
• 样式：UnoCSS、SCSS
• 编辑器：Monaco Editor、Markdown-it

🐧 后端

• 语言：Go 1.25.x
• Web框架：Gin、gRPC（grpc-gateway）
• 数据存储：MySQL（GORM）、Redis（缓存/令牌）
• 核心库：LangChainGo、MCP-Go、Docker SDK、Client-go
• 运维与部署：Traefik（边缘网关）、Docker Compose、Helm（Kubernetes）

🐧 相关项目

• MCPCan Helm Charts - MCPCan官方Helm图表索引
• 部署指南 - 详细的部署和配置指南

💝 贡献指南

欢迎提交 PR 来参与贡献！请参阅 Contributing 获取详细指南。

在贡献之前，请确保：

1. 阅读我们的 行为准则
2. 检查现有的问题和拉取请求（避免重复工作）
3. 遵循我们的代码规范和提交信息约定

✅ 安全

如果您发现安全漏洞，请参阅我们的 安全政策，了解负责任的披露指南。

📄 许可证

版权所有 © 2024–2025 MCPCan 团队，保留所有权利。

本软件根据 可持续使用许可证 进行授权。其中部分组件（特别是 .ee 文件夹中的企业版功能）受 企业版许可证 约束（LICENSE_EE.md）。

除非适用法律要求或书面协议另有规定，否则根据本许可证分发的软件以“现状”提供，不提供任何形式的保证或条件，无论是明示的还是默示的。有关许可的具体语言、权限及限制，请参阅许可证文件。

👥 社区与支持

• 📖 文档
• 💬 Discord 社区
• 🐛 问题追踪器
• 📧 邮件列表
• 🌐 微信
  

💕 致谢

• 感谢 MCP 协议 社区
• 感谢所有贡献者和支持者
• 特别感谢那些使 MCPCan 成为可能的开源项目

🌟 星标历史

MCPCAN 快速上手指南

MCPCAN 是一个开源的 MCP (Model Context Protocol) 服务集成平台，支持通过容器化灵活部署、多协议转换、可视化监控及安全认证，帮助团队一站式管理 MCP 服务生命周期。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统: Linux (推荐 Ubuntu 20.04+/CentOS 7+) 或 macOS
• 核心依赖:
  • Docker (建议版本 20.10+)
  • Docker Compose (建议版本 v2.0+)
• 网络要求: 能够访问 GitHub 及 Docker Hub（若在国内环境，建议配置 Docker 镜像加速器）

安装步骤

推荐使用 Docker Compose 方式进行快速部署，适用于本地开发、测试及轻量级生产环境。

1. 获取部署仓库

# 克隆项目仓库
git clone https://github.com/Kymo-MCP/mcpcan.git
cd mcpcan/deploy/docker-compose/

2. 初始化配置

复制环境变量示例文件，并根据需要修改配置（如切换国内镜像源）。

# 复制配置文件
cp example.env .env

# (可选) 编辑 .env 文件，修改 REGISTRY_PREFIX 等变量以使用国内镜像加速
# vi .env 

3. 生成最终配置并启动

执行脚本生成配置并启动服务。

# 赋予执行权限并运行配置脚本
chmod +x replace.sh
./replace.sh

# 后台启动所有服务
docker compose up -d

基本使用

服务启动成功后，即可通过浏览器访问管理界面。

1. 访问地址:

   • 本地访问：http://localhost
   • 服务器访问：http://<您的公网 IP>

2. 登录信息:

   • 用户名：admin
   • 密码：admin123

3. 开始管理: 登录后，您可以在 Web 界面中进行 MCP 服务的注册、协议转换配置、实例监控以及权限管理等操作。

提示: 如需在 Kubernetes 环境中部署，请参考官方 Helm 部署指南。