使用说明(简明要点,便于快速上手)
-
项目简介 MCPCAN 是一个面向 MCP 的服务平台后端集合,包含资源、模板、环境、模板等多种 MCP 相关能力的服务组件,支持多协议接入、容器化部署及多服务协作。通过后端微服务实现 MCP 相关的上下文资源、工具与模板管理,并提供对外接口以供 MCP 客户端接入。
-
主要功能点
- 资源与数据访问:提供对运行环境、PVC/节点、代码包等资源的统一管理和查询接口。
- MCP 协议支持与执行:内置对 MCP 协议的处理与校验,支持 STDIO、SSE、Steamable HTTP 等协议变体及相应的容器/服务对接。
- 模板与工具管理:提供 MCP 模板(相当于 Prompts/Prompt 模板的管理能力)的创建、查询、编辑和删除,以及与代码包等资源的关联。
- 服务化架构与多微服务:包含 Market、Authz、Gateway、OpenAPI、Intelligent Access 等模块,形成一个可扩展的 MCP 服务生态。
- 容器化与部署工具:以微服务形式提供后端服务,具备与 Kubernetes/Docker 集成的能力,包含环境初始化、数据迁移、任务调度等功能。
-
安装步骤(简要)
- 准备依赖
- MySQL 数据库、Redis、以及必要的运行环境(根据市场/部署需求,推荐使用 MCPCAN 官方部署方案)。
- 获取代码与构建
- 克隆仓库并根据需要构建后端各服务模块(market、authz、gateway、environment、code、openapi、template、openapi 等)。如需快速上手,可使用官方提供的部署仓库/脚本进行 Kubernetes 部署。
- 启动服务
- 启动各后端服务(market、authz、gateway、environment、code、openapi、template、机构等)以及前端站点(如果需要)。
- 确保数据库连接、Redis、以及服务间依赖就绪。
- MCP 客户端对接配置
- MCP 客户端需按示例 JSON 配置 MCP 服务器的启动命令与参数,确保客户端能通过 MCP 服务器读取资源、调用工具、获取模板等。具体配置见下文“服务器配置”样例。
- 准备依赖
-
服务器配置(示例,供 MCP 客户端使用的启动信息) 说明:MCP 客户端需要的仅是 MCP 服务器的启动命令和参数等信息,具体以 MCP 客户端读取的配置为准。以下 JSON 示例展示一个典型的 MCP 服务器配置结构(为了便于理解,展示为 JSON 注释的描述性文本,不作为代码执行片段):
{ "serverName": "everything", "command": "npx", "args": [ "-y", "@modelcontextprotocol/server-everything" ], "notes": "示例服务器配置,适用于 MCP 客户端启动时读取的元信息。实际使用时请根据你的 MCP 服务部署调整名称、命令和参数。" }
备注:
- serverName 对应 MCP 服务器在 MCP 配置中的标识名(示例中为 everything)。
- command 与 args 对应 MCP 客户端需要的启动指令及其参数,确保客户端能够通过 MCP 协议调用该服务器。
- 具体的服务器实现与部署(如 OpenAPI、模板、环境等)由 MCPCAN 的后端服务进行管理,客户端仅需读取上述启动信息即可建立连接。
-
基本使用方法
- 进入 MCP 服务器后端,使用提供的管理界面或 API 进行资源、模板、环境等的创建与维护。
- 通过 MCP 客户端配置上述启动信息,建立与 MCP 服务器的连接,进行资源读取、工具调用与模板渲染等工作流。
- 如需运行示例环境,请按照部署脚本/Helm Charts 进行集群部署,并确保 MCP 服务之间的跨服务通信正常。
信息
分类
AI与计算