关键词

AI Agent工具代理服务管理Web平台微服务

使用说明

项目简介

MCPez 是一个用于管理和代理后端服务的平台，它将各种服务（无论是本地脚本、远程API还是其他MCP服务）统一封装成标准的SSE或STDIO接口，并通过Web UI提供集中管理。这使得AI Agent等应用可以轻松地接入和使用这些服务作为工具，而无需关心底层服务的具体实现细节。MCPez旨在解决当前MCP生态系统中服务孤立、集成复杂、质量参差不齐等问题，提供一个更开放、可靠和易于管理的解决方案。

主要功能点

  • 统一服务管理: 通过Web界面集中管理多种类型的后端服务。
  • 标准化接口: 将服务代理为标准的SSE或STDIO接口，方便客户端集成。
  • 多种服务类型支持: 支持代理远程HTTP SSE服务和本地命令行进程服务。
  • 灵活配置: 支持导入/导出应用配置，以及将常用服务配置保存为模板复用。
  • 服务状态监控: 提供服务启动/停止、状态查看和日志监控功能。
  • AI Playground: 内置简单的AI Playground，方便测试AI模型与代理服务的交互。
  • Docker化部署: 提供Docker镜像，方便快速部署和运行。

安装步骤

  1. 环境准备: 确保已安装 Docker 和 Docker Compose (推荐)。
  2. 构建 Docker 镜像: 打开终端，进入仓库根目录 'mcpez/'，执行命令： 
    docker build -t mcpez .
  3. 运行 Docker 容器: 执行以下命令启动 MCPez 容器： 
    docker run -d -p 8088:80 --name mcpez-instance -v mcpez_data:/data mcpez
    • '-d': 后台运行容器。
    • '-p 8088:80': 将主机的 8088 端口映射到容器的 80 端口（Web UI 默认端口）。可以根据需要修改主机端口 '8088'。
    • '--name mcpez-instance': 为容器命名为 'mcpez-instance'。
    • '-v mcpez_data:/data': 创建 Docker volume 'mcpez_data' 用于持久化存储数据。
  4. 访问 Web UI: 在浏览器中打开 'http://localhost:8088' (或您在步骤3中设置的主机端口)。

服务器配置

MCP服务器的配置在MCPez平台中通过Web UI完成，无需手动编辑配置文件。用户需要在MCPez Web UI中定义 "应用 (App)"，并在应用中添加 "MCP服务 (MCP Server)" 配置。

以下是一个在MCPez Web UI中配置一个 STDIO (本地命令行进程) 类型 的 MCP 服务的示例配置（JSON格式，在Web UI中填写，MCP客户端无需直接配置）：

{
  "serverName": "my_stdio_tool",  // 服务名称，用户自定义
  "serverType": "stdio",         // 服务类型，选择 "stdio"
  "serverDescription": "一个本地命令工具示例", // 服务描述，可选
  "command": "/path/to/your/script.sh", // 本地命令的完整路径，例如：/bin/bash 或 /usr/bin/python3 your_script.py
  "args": [                       // 命令参数列表，可选
    "--param1", "value1",
    "--param2", "value2"
  ],
  "env": {                        // 环境变量，可选
    "API_KEY": "your_api_key",
    "DEBUG_MODE": "true"
  }
}

以下是一个在MCPez Web UI中配置一个 SSE (远程HTTP SSE服务) 类型 的 MCP 服务的示例配置（JSON格式，在Web UI中填写，MCP客户端无需直接配置）：

{
  "serverName": "my_sse_api",     // 服务名称，用户自定义
  "serverType": "sse",           // 服务类型，选择 "sse"
  "serverDescription": "一个远程SSE API示例", // 服务描述，可选
  "baseUrl": "https://api.example.com/sse", // 远程 SSE API 的 Base URL
  "headers": {                     // HTTP 请求头，可选
    "Authorization": "Bearer your_token",
    "X-Custom-Header": "custom_value"
  }
}

基本使用方法

  1. 登录 MCPez Web UI: 访问 'http://localhost:8088' 进入 MCPez 管理界面。
  2. 创建应用: 在服务管理页面，点击 "新建服务" (实际上是新建应用)，填写应用名称和描述。
  3. 配置 MCP 服务: 在应用编辑页面，点击 "MCP" 按钮，添加新的 MCP 服务配置。根据您的后端服务类型选择 "SSE" 或 "STDIO"，并填写相应的配置信息（如命令、参数、环境变量或 Base URL、Headers）。
  4. 保存配置: 点击 "保存配置" 按钮保存应用和服务配置。
  5. 启动服务: 在服务管理页面，找到您创建的应用，点击 "启动" 按钮启动 STDIO 类型的服务。
  6. 获取 MCP 服务器地址: 在服务管理页面，对于运行中的服务，点击 "查看服务状态" 可以查看服务的详细信息，其中包括该服务的 SSE 代理地址 (例如 'http://localhost:8088/mcp/<app_id>/sse')。
  7. 在 MCP 客户端中使用: 将获取到的 SSE 代理地址 配置到您的 MCP 客户端 (如 'webui/libs/mcpcli.js' 或其他 MCP 客户端库)，客户端即可通过该地址与您在 MCPez 中配置和管理的后端服务进行交互，实现工具调用等功能。

注意: MCPez 本身是一个 MCP 服务管理平台，它并不直接提供 Prompt 模板 (Prompts) 功能。Prompt 模板通常需要在具体的 MCP 客户端或应用中进行定义和使用。MCPez 的核心价值在于简化后端服务的代理和管理，为 MCP 客户端提供统一、易用的工具接口。

信息

分类

开发者工具

访问项目